... | ... |
@@ -41,15 +41,15 @@ |
41 | 41 |
|
42 | 42 |
/// Base class of maps. |
43 | 43 |
/// It provides the necessary <tt>typedef</tt>s required by the map concept. |
44 | 44 |
template<typename K, typename T> |
45 | 45 |
class MapBase { |
46 | 46 |
public: |
47 |
/// |
|
47 |
/// The key type of the map. |
|
48 | 48 |
typedef K Key; |
49 |
/// |
|
49 |
/// The value type of the map. (The type of objects associated with the keys). |
|
50 | 50 |
typedef T Value; |
51 | 51 |
}; |
52 | 52 |
|
53 | 53 |
/// Null map. (a.k.a. DoNothingMap) |
54 | 54 |
|
55 | 55 |
/// This map can be used if you have to provide a map only for |
... | ... |
@@ -246,15 +246,15 @@ |
246 | 246 |
template <typename T1, typename C1 = std::less<T1> > |
247 | 247 |
struct rebind { |
248 | 248 |
typedef StdMap<Key, T1, C1> other; |
249 | 249 |
}; |
250 | 250 |
}; |
251 | 251 |
|
252 |
/// \brief Map for storing values for the range |
|
252 |
/// \brief Map for storing values for keys from the range <tt>[0..size-1]</tt> |
|
253 | 253 |
/// |
254 |
/// The current map has the |
|
254 |
/// The current map has the <tt>[0..size-1]</tt> keyset and the values |
|
255 | 255 |
/// are stored in a \c std::vector<T> container. It can be used with |
256 | 256 |
/// some data structures, for example \c UnionFind, \c BinHeap, when |
257 | 257 |
/// the used items are small integer numbers. |
258 | 258 |
/// |
259 | 259 |
/// \todo Revise its name |
260 | 260 |
template <typename T> |
... | ... |
@@ -826,13 +826,13 @@ |
826 | 826 |
///Returns a \c CombineMap class |
827 | 827 |
|
828 | 828 |
///This function just returns a \c CombineMap class. |
829 | 829 |
/// |
830 | 830 |
///For example if \c m1 and \c m2 are both \c double valued maps, then |
831 | 831 |
///\code |
832 |
///combineMap |
|
832 |
///combineMap(m1,m2,std::plus<double>()) |
|
833 | 833 |
///\endcode |
834 | 834 |
///is equivalent to |
835 | 835 |
///\code |
836 | 836 |
///addMap(m1,m2) |
837 | 837 |
///\endcode |
838 | 838 |
/// |
... | ... |
@@ -959,14 +959,15 @@ |
959 | 959 |
///Converts an STL style functor to a map |
960 | 960 |
|
961 | 961 |
///This \c concepts::ReadMap "read only map" returns the value |
962 | 962 |
///of a given functor. |
963 | 963 |
/// |
964 | 964 |
///Template parameters \c K and \c V will become its |
965 |
///\c Key and \c Value. They must be given explicitly |
|
966 |
///because a functor does not provide such typedefs. |
|
965 |
///\c Key and \c Value. |
|
966 |
///In most cases they have to be given explicitly because a |
|
967 |
///functor typically does not provide such typedefs. |
|
967 | 968 |
/// |
968 | 969 |
///Parameter \c F is the type of the used functor. |
969 | 970 |
/// |
970 | 971 |
///\sa MapFunctor |
971 | 972 |
template<typename F, |
972 | 973 |
typename K = typename F::argument_type, |
... | ... |
@@ -1237,12 +1238,14 @@ |
1237 | 1238 |
/// writerMap(ostream_iterator<int>(cout, " "), edgeIdFunctor); |
1238 | 1239 |
/// |
1239 | 1240 |
/// prim(graph, cost, writerMap); |
1240 | 1241 |
///\endcode |
1241 | 1242 |
/// |
1242 | 1243 |
///\sa BackInserterBoolMap |
1244 |
///\sa FrontInserterBoolMap |
|
1245 |
///\sa InserterBoolMap |
|
1243 | 1246 |
/// |
1244 | 1247 |
///\todo Revise the name of this class and the related ones. |
1245 | 1248 |
template <typename _Iterator, |
1246 | 1249 |
typename _Functor = |
1247 | 1250 |
_maps_bits::Identity<typename _maps_bits:: |
1248 | 1251 |
IteratorTraits<_Iterator>::Value> > |
0 comments (0 inline)