... | ... |
@@ -83,4 +83,5 @@ |
83 | 83 |
|
84 |
/// This is a readable map which assigns a specified value to each key. |
|
85 |
/// In other aspects it is equivalent to the \c NullMap. |
|
84 |
/// This is a \ref concepts::ReadMap "readable" map which assigns a |
|
85 |
/// specified value to each key. |
|
86 |
/// In other aspects it is equivalent to \c NullMap. |
|
86 | 87 |
template<typename K, typename T> |
... | ... |
@@ -135,4 +136,5 @@ |
135 | 136 |
|
136 |
/// This is a readable map which assigns a specified value to each key. |
|
137 |
/// In other aspects it is equivalent to the \c NullMap. |
|
137 |
/// This is a \ref concepts::ReadMap "readable" map which assigns a |
|
138 |
/// specified value to each key. |
|
139 |
/// In other aspects it is equivalent to \c NullMap. |
|
138 | 140 |
template<typename K, typename V, V v> |
... | ... |
@@ -151,3 +153,3 @@ |
151 | 153 |
|
152 |
///Returns a \c ConstMap class |
|
154 |
///Returns a \c ConstMap class with inlined value |
|
153 | 155 |
|
... | ... |
@@ -164,2 +166,3 @@ |
164 | 166 |
///you can specify a default value different from \c Value(). |
167 |
///It meets the \ref concepts::ReferenceMap "ReferenceMap" concept. |
|
165 | 168 |
template <typename K, typename T, typename Compare = std::less<K> > |
... | ... |
@@ -192,4 +195,4 @@ |
192 | 195 |
StdMap(const T& value = T()) : _value(value) {} |
193 |
/// \brief Constructs the map from an appropriate std::map, and explicitly |
|
194 |
/// specifies a default value. |
|
196 |
/// \brief Constructs the map from an appropriate \c std::map, and |
|
197 |
/// explicitly specifies a default value. |
|
195 | 198 |
template <typename T1, typename Comp1> |
... | ... |
@@ -198,3 +201,3 @@ |
198 | 201 |
|
199 |
/// \brief Constructs a map from an other StdMap. |
|
202 |
/// \brief Constructs a map from an other \ref StdMap. |
|
200 | 203 |
template<typename T1, typename Comp1> |
... | ... |
@@ -267,6 +270,7 @@ |
267 | 270 |
/// |
268 |
/// |
|
271 |
/// This map has the <tt>[0..size-1]</tt> keyset and the values |
|
269 | 272 |
/// are stored in a \c std::vector<T> container. It can be used with |
270 | 273 |
/// some data structures, for example \c UnionFind, \c BinHeap, when |
271 |
/// the used items are small integer numbers. |
|
274 |
/// the used items are small integer numbers. |
|
275 |
/// This map meets the \ref concepts::ReferenceMap "ReferenceMap" concept. |
|
272 | 276 |
/// |
... | ... |
@@ -303,3 +307,3 @@ |
303 | 307 |
|
304 |
/// \brief Constructs the map from an appropriate std::vector. |
|
308 |
/// \brief Constructs the map from an appropriate \c std::vector. |
|
305 | 309 |
template <typename T1> |
... | ... |
@@ -308,3 +312,3 @@ |
308 | 312 |
|
309 |
/// \brief Constructs a map from an other IntegerMap. |
|
313 |
/// \brief Constructs a map from an other \ref IntegerMap. |
|
310 | 314 |
template <typename T1> |
... | ... |
@@ -402,5 +406,3 @@ |
402 | 406 |
|
403 |
/// \brief The subscript operator. |
|
404 |
/// |
|
405 |
/// |
|
407 |
///\e |
|
406 | 408 |
Value operator[](const Key& k) const {return m[k];} |
... | ... |
@@ -492,3 +494,3 @@ |
492 | 494 |
///Its \c Key and \c Value are inherited from \c M1. |
493 |
///The \c Key and \c Value of M2 must be convertible to those of \c M1. |
|
495 |
///The \c Key and \c Value of \c M2 must be convertible to those of \c M1. |
|
494 | 496 |
template<typename M1, typename M2> |
... | ... |
@@ -512,3 +514,3 @@ |
512 | 514 |
///This function just returns an \c AddMap class. |
513 |
///\todo |
|
515 |
///\todo Extend the documentation: how to call these type of functions? |
|
514 | 516 |
/// |
... | ... |
@@ -1009,3 +1011,4 @@ |
1009 | 1011 |
///In most cases they have to be given explicitly because a |
1010 |
///functor typically does not provide |
|
1012 |
///functor typically does not provide \c argument_type and |
|
1013 |
///\c result_type typedefs. |
|
1011 | 1014 |
/// |
... | ... |
@@ -1034,4 +1037,5 @@ |
1034 | 1037 |
/// |
1035 |
///It is specialized for adaptable function classes and |
|
1036 |
///C++ functions. |
|
1038 |
///This function is specialized for adaptable binary function |
|
1039 |
///classes and C++ functions. |
|
1040 |
/// |
|
1037 | 1041 |
///\relates FunctorMap |
... | ... |
@@ -1058,3 +1062,3 @@ |
1058 | 1062 |
///This class Converts a map to an STL style (unary) functor. |
1059 |
/// |
|
1063 |
///That is it provides an <tt>operator()</tt> to read its values. |
|
1060 | 1064 |
/// |
... | ... |
@@ -1093,3 +1097,3 @@ |
1093 | 1097 |
|
1094 |
/// |
|
1098 |
///Just readable version of \ref ForkWriteMap |
|
1095 | 1099 |
|
... | ... |
@@ -1097,6 +1101,6 @@ |
1097 | 1101 |
///parameters and each read request will be passed just to the |
1098 |
///first map. This class is the just readable map type of |
|
1102 |
///first map. This class is the just readable map type of \c ForkWriteMap. |
|
1099 | 1103 |
/// |
1100 | 1104 |
///The \c Key and \c Value are inherited from \c M1. |
1101 |
///The \c Key and \c Value of M2 must be convertible from those of \c M1. |
|
1105 |
///The \c Key and \c Value of \c M2 must be convertible from those of \c M1. |
|
1102 | 1106 |
/// |
... | ... |
@@ -1130,3 +1134,3 @@ |
1130 | 1134 |
///The \c Key and \c Value are inherited from \c M1. |
1131 |
///The \c Key and \c Value of M2 must be convertible from those of \c M1. |
|
1135 |
///The \c Key and \c Value of \c M2 must be convertible from those of \c M1. |
|
1132 | 1136 |
/// |
... | ... |
@@ -1176,3 +1180,3 @@ |
1176 | 1180 |
///logical negation of the value returned by the given map. |
1177 |
///Its \c Key is inherited from \c M, its Value is \c bool. |
|
1181 |
///Its \c Key is inherited from \c M, its \c Value is \c bool. |
|
1178 | 1182 |
/// |
... | ... |
@@ -1198,3 +1202,3 @@ |
1198 | 1202 |
///the opposite value is set to the original map. |
1199 |
///Its \c Key is inherited from \c M, its Value is \c bool. |
|
1203 |
///Its \c Key is inherited from \c M, its \c Value is \c bool. |
|
1200 | 1204 |
/// |
... | ... |
@@ -1264,3 +1268,3 @@ |
1264 | 1268 |
/// A \ref concepts::ReadWriteMap "read-write" bool map for logging |
1265 |
/// each \c true assigned element, i.e it |
|
1269 |
/// each \c true assigned element, i.e it copies all the keys set |
|
1266 | 1270 |
/// to \c true to the given iterator. |
... | ... |
@@ -1270,5 +1274,4 @@ |
1270 | 1274 |
/// |
1271 |
/// The following example shows how you can write the edges found by the Prim |
|
1272 |
/// algorithm directly |
|
1273 |
/// |
|
1275 |
/// The following example shows how you can write the edges found by |
|
1276 |
/// the \ref Prim algorithm directly to the standard output. |
|
1274 | 1277 |
///\code |
0 comments (0 inline)