Changeset 46:b6dd98b57d71 in lemon-main
- Timestamp:
- 01/07/08 23:57:48 (17 years ago)
- Branch:
- default
- Phase:
- public
- File:
-
- 1 edited
-
lemon/maps.h (modified) (28 diffs)
Legend:
- Unmodified
- Added
- Removed
-
lemon/maps.h
r45 r46 159 159 } 160 160 161 ///Map based on std::map161 ///Map based on \c std::map 162 162 163 163 ///This is essentially a wrapper for \c std::map with addition that … … 243 243 }; 244 244 245 ///Returns a \ refStdMap class246 247 ///This function just returns a \ refStdMap class with specified245 ///Returns a \c StdMap class 246 247 ///This function just returns a \c StdMap class with specified 248 248 ///default value. 249 249 ///\relates StdMap … … 253 253 } 254 254 255 ///Returns a \ refStdMap class created from an appropriate std::map256 257 ///This function just returns a \ refStdMap class created from an255 ///Returns a \c StdMap class created from an appropriate std::map 256 257 ///This function just returns a \c StdMap class created from an 258 258 ///appropriate std::map. 259 259 ///\relates StdMap … … 340 340 }; 341 341 342 ///Returns an \ refIntegerMap class343 344 ///This function just returns an \ refIntegerMap class.342 ///Returns an \c IntegerMap class 343 344 ///This function just returns an \c IntegerMap class. 345 345 ///\relates IntegerMap 346 346 template<typename T> … … 384 384 ///the default conversion. 385 385 /// 386 ///This \ cconcepts::ReadMap "read only map"386 ///This \ref concepts::ReadMap "read only map" 387 387 ///converts the \c Value of a map to type \c T. 388 388 ///Its \c Key is inherited from \c M. … … 441 441 }; 442 442 443 ///Returns a \ refSimpleMap class444 445 ///This function just returns a \ refSimpleMap class.443 ///Returns a \c SimpleMap class 444 445 ///This function just returns a \c SimpleMap class. 446 446 ///\relates SimpleMap 447 447 template<typename M> … … 452 452 ///Simple writable wrapping of a map 453 453 454 ///This \ref concepts:: WriteMap "write map" returns the simple454 ///This \ref concepts::ReadWriteMap "read-write map" returns the simple 455 455 ///wrapping of the given map. Sometimes the reference maps cannot be 456 456 ///combined with simple read-write maps. This map adaptor wraps the … … 477 477 }; 478 478 479 ///Returns a \ refSimpleWriteMap class480 481 ///This function just returns a \ refSimpleWriteMap class.479 ///Returns a \c SimpleWriteMap class 480 481 ///This function just returns a \c SimpleWriteMap class. 482 482 ///\relates SimpleWriteMap 483 483 template<typename M> … … 488 488 ///Sum of two maps 489 489 490 ///This \ cconcepts::ReadMap "read only map" returns the sum of the two490 ///This \ref concepts::ReadMap "read only map" returns the sum of the two 491 491 ///given maps. 492 492 ///Its \c Key and \c Value are inherited from \c M1. … … 521 521 ///Shift a map with a constant. 522 522 523 ///This \ cconcepts::ReadMap "read only map" returns the sum of the523 ///This \ref concepts::ReadMap "read only map" returns the sum of the 524 524 ///given map and a constant value. 525 525 ///Its \c Key and \c Value are inherited from \c M. … … 557 557 ///Shift a map with a constant (ReadWrite version). 558 558 559 ///This \ cconcepts::ReadWriteMap "read-write map" returns the sum of the559 ///This \ref concepts::ReadWriteMap "read-write map" returns the sum of the 560 560 ///given map and a constant value. It makes also possible to write the map. 561 561 ///Its \c Key and \c Value are inherited from \c M. … … 603 603 ///Difference of two maps 604 604 605 ///This \ cconcepts::ReadMap "read only map" returns the difference605 ///This \ref concepts::ReadMap "read only map" returns the difference 606 606 ///of the values of the two given maps. 607 607 ///Its \c Key and \c Value are inherited from \c M1. … … 636 636 ///Product of two maps 637 637 638 ///This \ cconcepts::ReadMap "read only map" returns the product of the638 ///This \ref concepts::ReadMap "read only map" returns the product of the 639 639 ///values of the two given maps. 640 640 ///Its \c Key and \c Value are inherited from \c M1. … … 666 666 ///Scales a map with a constant. 667 667 668 ///This \ cconcepts::ReadMap "read only map" returns the value of the668 ///This \ref concepts::ReadMap "read only map" returns the value of the 669 669 ///given map multiplied from the left side with a constant value. 670 670 ///Its \c Key and \c Value are inherited from \c M. … … 702 702 ///Scales a map with a constant (ReadWrite version). 703 703 704 ///This \ cconcepts::ReadWriteMap "read-write map" returns the value of the704 ///This \ref concepts::ReadWriteMap "read-write map" returns the value of the 705 705 ///given map multiplied from the left side with a constant value. It can 706 706 ///also be used as write map if the \c / operator is defined between … … 750 750 ///Quotient of two maps 751 751 752 ///This \ cconcepts::ReadMap "read only map" returns the quotient of the752 ///This \ref concepts::ReadMap "read only map" returns the quotient of the 753 753 ///values of the two given maps. 754 754 ///Its \c Key and \c Value are inherited from \c M1. … … 780 780 ///Composition of two maps 781 781 782 ///This \ cconcepts::ReadMap "read only map" returns the composition of782 ///This \ref concepts::ReadMap "read only map" returns the composition of 783 783 ///two given maps. 784 784 ///That is to say, if \c m1 is of type \c M1 and \c m2 is of \c M2, … … 831 831 ///Combine of two maps using an STL (binary) functor. 832 832 /// 833 ///This \ cconcepts::ReadMap "read only map" takes two maps and a833 ///This \ref concepts::ReadMap "read only map" takes two maps and a 834 834 ///binary functor and returns the composition of the two 835 835 ///given maps unsing the functor. … … 904 904 ///Negative value of a map 905 905 906 ///This \ cconcepts::ReadMap "read only map" returns the negative906 ///This \ref concepts::ReadMap "read only map" returns the negative 907 907 ///value of the value returned by the given map. 908 908 ///Its \c Key and \c Value are inherited from \c M. … … 926 926 ///Negative value of a map (ReadWrite version) 927 927 928 ///This \ cconcepts::ReadWriteMap "read-write map" returns the negative928 ///This \ref concepts::ReadWriteMap "read-write map" returns the negative 929 929 ///value of the value returned by the given map. 930 930 ///Its \c Key and \c Value are inherited from \c M. … … 968 968 ///Absolute value of a map 969 969 970 ///This \ cconcepts::ReadMap "read only map" returns the absolute value970 ///This \ref concepts::ReadMap "read only map" returns the absolute value 971 971 ///of the value returned by the given map. 972 972 ///Its \c Key and \c Value are inherited from \c M. … … 1002 1002 ///Converts an STL style functor to a map 1003 1003 1004 ///This \ cconcepts::ReadMap "read only map" returns the value1004 ///This \ref concepts::ReadMap "read only map" returns the value 1005 1005 ///of a given functor. 1006 1006 /// … … 1060 1060 /// 1061 1061 ///For the sake of convenience it also works as 1062 ///a ususal \ cconcepts::ReadMap "readable map",1062 ///a ususal \ref concepts::ReadMap "readable map", 1063 1063 ///i.e. <tt>operator[]</tt> and the \c Key and \c Value typedefs also exist. 1064 1064 /// … … 1094 1094 ///Applies all map setting operations to two maps 1095 1095 1096 ///This map has two \ cconcepts::ReadMap "readable map"1096 ///This map has two \ref concepts::ReadMap "readable map" 1097 1097 ///parameters and each read request will be passed just to the 1098 ///first map. This class is the just readable map type of the ForkWriteMap.1098 ///first map. This class is the just readable map type of the \c ForkWriteMap. 1099 1099 /// 1100 1100 ///The \c Key and \c Value are inherited from \c M1. … … 1122 1122 ///Applies all map setting operations to two maps 1123 1123 1124 ///This map has two \ cconcepts::WriteMap "writable map"1124 ///This map has two \ref concepts::WriteMap "writable map" 1125 1125 ///parameters and each write request will be passed to both of them. 1126 ///If \c M1 is also \ cconcepts::ReadMap "readable",1126 ///If \c M1 is also \ref concepts::ReadMap "readable", 1127 1127 ///then the read operations will return the 1128 1128 ///corresponding values of \c M1. … … 1173 1173 ///Logical 'not' of a map 1174 1174 1175 ///This bool \ cconcepts::ReadMap "read only map" returns the1175 ///This bool \ref concepts::ReadMap "read only map" returns the 1176 1176 ///logical negation of the value returned by the given map. 1177 1177 ///Its \c Key is inherited from \c M, its Value is \c bool. … … 1194 1194 ///Logical 'not' of a map (ReadWrie version) 1195 1195 1196 ///This bool \ cconcepts::ReadWriteMap "read-write map" returns the1196 ///This bool \ref concepts::ReadWriteMap "read-write map" returns the 1197 1197 ///logical negation of the value returned by the given map. When it is set, 1198 1198 ///the opposite value is set to the original map. … … 1262 1262 /// \brief Writable bool map for logging each \c true assigned element 1263 1263 /// 1264 /// Writable bool map for logging each \c true assigned element, i.e it 1265 /// copies all the keys set to \c true to the given iterator. 1264 /// A \ref concepts::ReadWriteMap "read-write" bool map for logging 1265 /// each \c true assigned element, i.e it/ copies all the keys set 1266 /// to \c true to the given iterator. 1266 1267 /// 1267 1268 /// \note The container of the iterator should contain space
Note: See TracChangeset
for help on using the changeset viewer.
