diff -r 907446600ca9 -r 9db8964f0cf6 lemon/maps.h --- a/lemon/maps.h Tue Oct 07 07:08:45 2008 +0100 +++ b/lemon/maps.h Wed Oct 08 13:40:20 2008 +0200 @@ -73,9 +73,9 @@ void set(const Key&, const Value&) {} }; - /// Returns a \ref NullMap class - - /// This function just returns a \ref NullMap class. + /// Returns a \c NullMap class + + /// This function just returns a \c NullMap class. /// \relates NullMap template NullMap nullMap() { @@ -88,7 +88,7 @@ /// This \ref concepts::ReadMap "readable map" assigns a specified /// value to each key. /// - /// In other aspects it is equivalent to \ref NullMap. + /// In other aspects it is equivalent to \c NullMap. /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap" /// concept, but it absorbs the data written to it. /// @@ -133,9 +133,9 @@ ConstMap(const ConstMap &, const Value &v) : _value(v) {} }; - /// Returns a \ref ConstMap class - - /// This function just returns a \ref ConstMap class. + /// Returns a \c ConstMap class + + /// This function just returns a \c ConstMap class. /// \relates ConstMap template inline ConstMap constMap(const V &v) { @@ -156,7 +156,7 @@ /// This \ref concepts::ReadMap "readable map" assigns a specified /// value to each key. /// - /// In other aspects it is equivalent to \ref NullMap. + /// In other aspects it is equivalent to \c NullMap. /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap" /// concept, but it absorbs the data written to it. /// @@ -182,9 +182,9 @@ void set(const Key&, const Value&) {} }; - /// Returns a \ref ConstMap class with inlined constant value - - /// This function just returns a \ref ConstMap class with inlined + /// Returns a \c ConstMap class with inlined constant value + + /// This function just returns a \c ConstMap class with inlined /// constant value. /// \relates ConstMap template @@ -212,9 +212,9 @@ } }; - /// Returns an \ref IdentityMap class - - /// This function just returns an \ref IdentityMap class. + /// Returns an \c IdentityMap class + + /// This function just returns an \c IdentityMap class. /// \relates IdentityMap template inline IdentityMap identityMap() { @@ -228,7 +228,7 @@ /// This map is essentially a wrapper for \c std::vector. It assigns /// values to integer keys from the range [0..size-1]. /// It can be used with some data structures, for example - /// \ref UnionFind, \ref BinHeap, when the used items are small + /// \c UnionFind, \c BinHeap, when the used items are small /// integers. This map conforms the \ref concepts::ReferenceMap /// "ReferenceMap" concept. /// @@ -268,7 +268,7 @@ RangeMap(const std::vector& vector) : _vector(vector.begin(), vector.end()) {} - /// Constructs the map from another \ref RangeMap. + /// Constructs the map from another \c RangeMap. template RangeMap(const RangeMap &c) : _vector(c._vector.begin(), c._vector.end()) {} @@ -311,19 +311,19 @@ } }; - /// Returns a \ref RangeMap class - - /// This function just returns a \ref RangeMap class. + /// Returns a \c RangeMap class + + /// This function just returns a \c RangeMap class. /// \relates RangeMap template inline RangeMap rangeMap(int size = 0, const V &value = V()) { return RangeMap(size, value); } - /// \brief Returns a \ref RangeMap class created from an appropriate + /// \brief Returns a \c RangeMap class created from an appropriate /// \c std::vector - /// This function just returns a \ref RangeMap class created from an + /// This function just returns a \c RangeMap class created from an /// appropriate \c std::vector. /// \relates RangeMap template @@ -388,7 +388,7 @@ const Value &value = Value()) : _map(map.begin(), map.end()), _value(value) {} - /// \brief Constructs the map from another \ref SparseMap. + /// \brief Constructs the map from another \c SparseMap. template SparseMap(const SparseMap &c) : _map(c._map.begin(), c._map.end()), _value(c._value) {} @@ -433,9 +433,9 @@ } }; - /// Returns a \ref SparseMap class - - /// This function just returns a \ref SparseMap class with specified + /// Returns a \c SparseMap class + + /// This function just returns a \c SparseMap class with specified /// default value. /// \relates SparseMap template @@ -448,10 +448,10 @@ return SparseMap >(value); } - /// \brief Returns a \ref SparseMap class created from an appropriate + /// \brief Returns a \c SparseMap class created from an appropriate /// \c std::map - /// This function just returns a \ref SparseMap class created from an + /// This function just returns a \c SparseMap class created from an /// appropriate \c std::map. /// \relates SparseMap template @@ -501,9 +501,9 @@ operator[](const Key &k) const { return _m1[_m2[k]]; } }; - /// Returns a \ref ComposeMap class - - /// This function just returns a \ref ComposeMap class. + /// Returns a \c ComposeMap class + + /// This function just returns a \c ComposeMap class. /// /// If \c m1 and \c m2 are maps and the \c Value type of \c m2 is /// convertible to the \c Key of \c m1, then composeMap(m1,m2)[x] @@ -556,9 +556,9 @@ Value operator[](const Key &k) const { return _f(_m1[k],_m2[k]); } }; - /// Returns a \ref CombineMap class - - /// This function just returns a \ref CombineMap class. + /// Returns a \c CombineMap class + + /// This function just returns a \c CombineMap class. /// /// For example, if \c m1 and \c m2 are both maps with \c double /// values, then @@ -625,9 +625,9 @@ Value operator[](const Key &k) const { return _f(k); } }; - /// Returns a \ref FunctorToMap class - - /// This function just returns a \ref FunctorToMap class. + /// Returns a \c FunctorToMap class + + /// This function just returns a \c FunctorToMap class. /// /// This function is specialized for adaptable binary function /// classes and C++ functions. @@ -684,9 +684,9 @@ Value operator[](const Key &k) const { return _m[k]; } }; - /// Returns a \ref MapToFunctor class - - /// This function just returns a \ref MapToFunctor class. + /// Returns a \c MapToFunctor class + + /// This function just returns a \c MapToFunctor class. /// \relates MapToFunctor template inline MapToFunctor mapToFunctor(const M &m) { @@ -723,9 +723,9 @@ Value operator[](const Key &k) const { return _m[k]; } }; - /// Returns a \ref ConvertMap class - - /// This function just returns a \ref ConvertMap class. + /// Returns a \c ConvertMap class + + /// This function just returns a \c ConvertMap class. /// \relates ConvertMap template inline ConvertMap convertMap(const M &map) { @@ -763,9 +763,9 @@ void set(const Key &k, const Value &v) { _m1.set(k,v); _m2.set(k,v); } }; - /// Returns a \ref ForkMap class - - /// This function just returns a \ref ForkMap class. + /// Returns a \c ForkMap class + + /// This function just returns a \c ForkMap class. /// \relates ForkMap template inline ForkMap forkMap(M1 &m1, M2 &m2) { @@ -807,9 +807,9 @@ Value operator[](const Key &k) const { return _m1[k]+_m2[k]; } }; - /// Returns an \ref AddMap class - - /// This function just returns an \ref AddMap class. + /// Returns an \c AddMap class + + /// This function just returns an \c AddMap class. /// /// For example, if \c m1 and \c m2 are both maps with \c double /// values, then addMap(m1,m2)[x] will be equal to @@ -855,9 +855,9 @@ Value operator[](const Key &k) const { return _m1[k]-_m2[k]; } }; - /// Returns a \ref SubMap class - - /// This function just returns a \ref SubMap class. + /// Returns a \c SubMap class + + /// This function just returns a \c SubMap class. /// /// For example, if \c m1 and \c m2 are both maps with \c double /// values, then subMap(m1,m2)[x] will be equal to @@ -904,9 +904,9 @@ Value operator[](const Key &k) const { return _m1[k]*_m2[k]; } }; - /// Returns a \ref MulMap class - - /// This function just returns a \ref MulMap class. + /// Returns a \c MulMap class + + /// This function just returns a \c MulMap class. /// /// For example, if \c m1 and \c m2 are both maps with \c double /// values, then mulMap(m1,m2)[x] will be equal to @@ -952,9 +952,9 @@ Value operator[](const Key &k) const { return _m1[k]/_m2[k]; } }; - /// Returns a \ref DivMap class - - /// This function just returns a \ref DivMap class. + /// Returns a \c DivMap class + + /// This function just returns a \c DivMap class. /// /// For example, if \c m1 and \c m2 are both maps with \c double /// values, then divMap(m1,m2)[x] will be equal to @@ -1038,9 +1038,9 @@ void set(const Key &k, const Value &v) { _m.set(k, v-_v); } }; - /// Returns a \ref ShiftMap class - - /// This function just returns a \ref ShiftMap class. + /// Returns a \c ShiftMap class + + /// This function just returns a \c ShiftMap class. /// /// For example, if \c m is a map with \c double values and \c v is /// \c double, then shiftMap(m,v)[x] will be equal to @@ -1052,9 +1052,9 @@ return ShiftMap(m,v); } - /// Returns a \ref ShiftWriteMap class - - /// This function just returns a \ref ShiftWriteMap class. + /// Returns a \c ShiftWriteMap class + + /// This function just returns a \c ShiftWriteMap class. /// /// For example, if \c m is a map with \c double values and \c v is /// \c double, then shiftWriteMap(m,v)[x] will be equal to @@ -1140,9 +1140,9 @@ void set(const Key &k, const Value &v) { _m.set(k, v/_v); } }; - /// Returns a \ref ScaleMap class - - /// This function just returns a \ref ScaleMap class. + /// Returns a \c ScaleMap class + + /// This function just returns a \c ScaleMap class. /// /// For example, if \c m is a map with \c double values and \c v is /// \c double, then scaleMap(m,v)[x] will be equal to @@ -1154,9 +1154,9 @@ return ScaleMap(m,v); } - /// Returns a \ref ScaleWriteMap class - - /// This function just returns a \ref ScaleWriteMap class. + /// Returns a \c ScaleWriteMap class + + /// This function just returns a \c ScaleWriteMap class. /// /// For example, if \c m is a map with \c double values and \c v is /// \c double, then scaleWriteMap(m,v)[x] will be equal to @@ -1240,9 +1240,9 @@ void set(const Key &k, const Value &v) { _m.set(k, -v); } }; - /// Returns a \ref NegMap class - - /// This function just returns a \ref NegMap class. + /// Returns a \c NegMap class + + /// This function just returns a \c NegMap class. /// /// For example, if \c m is a map with \c double values, then /// negMap(m)[x] will be equal to -m[x]. @@ -1253,9 +1253,9 @@ return NegMap(m); } - /// Returns a \ref NegWriteMap class - - /// This function just returns a \ref NegWriteMap class. + /// Returns a \c NegWriteMap class + + /// This function just returns a \c NegWriteMap class. /// /// For example, if \c m is a map with \c double values, then /// negWriteMap(m)[x] will be equal to -m[x]. @@ -1296,9 +1296,9 @@ }; - /// Returns an \ref AbsMap class - - /// This function just returns an \ref AbsMap class. + /// Returns an \c AbsMap class + + /// This function just returns an \c AbsMap class. /// /// For example, if \c m is a map with \c double values, then /// absMap(m)[x] will be equal to m[x] if @@ -1345,9 +1345,9 @@ Value operator[](const Key&) const { return true; } }; - /// Returns a \ref TrueMap class - - /// This function just returns a \ref TrueMap class. + /// Returns a \c TrueMap class + + /// This function just returns a \c TrueMap class. /// \relates TrueMap template inline TrueMap trueMap() { @@ -1382,9 +1382,9 @@ Value operator[](const Key&) const { return false; } }; - /// Returns a \ref FalseMap class - - /// This function just returns a \ref FalseMap class. + /// Returns a \c FalseMap class + + /// This function just returns a \c FalseMap class. /// \relates FalseMap template inline FalseMap falseMap() { @@ -1429,9 +1429,9 @@ Value operator[](const Key &k) const { return _m1[k]&&_m2[k]; } }; - /// Returns an \ref AndMap class - - /// This function just returns an \ref AndMap class. + /// Returns an \c AndMap class + + /// This function just returns an \c AndMap class. /// /// For example, if \c m1 and \c m2 are both maps with \c bool values, /// then andMap(m1,m2)[x] will be equal to @@ -1477,9 +1477,9 @@ Value operator[](const Key &k) const { return _m1[k]||_m2[k]; } }; - /// Returns an \ref OrMap class - - /// This function just returns an \ref OrMap class. + /// Returns an \c OrMap class + + /// This function just returns an \c OrMap class. /// /// For example, if \c m1 and \c m2 are both maps with \c bool values, /// then orMap(m1,m2)[x] will be equal to @@ -1544,9 +1544,9 @@ void set(const Key &k, bool v) { _m.set(k, !v); } }; - /// Returns a \ref NotMap class - - /// This function just returns a \ref NotMap class. + /// Returns a \c NotMap class + + /// This function just returns a \c NotMap class. /// /// For example, if \c m is a map with \c bool values, then /// notMap(m)[x] will be equal to !m[x]. @@ -1557,9 +1557,9 @@ return NotMap(m); } - /// Returns a \ref NotWriteMap class - - /// This function just returns a \ref NotWriteMap class. + /// Returns a \c NotWriteMap class + + /// This function just returns a \c NotWriteMap class. /// /// For example, if \c m is a map with \c bool values, then /// notWriteMap(m)[x] will be equal to !m[x]. @@ -1605,9 +1605,9 @@ Value operator[](const Key &k) const { return _m1[k]==_m2[k]; } }; - /// Returns an \ref EqualMap class - - /// This function just returns an \ref EqualMap class. + /// Returns an \c EqualMap class + + /// This function just returns an \c EqualMap class. /// /// For example, if \c m1 and \c m2 are maps with keys and values of /// the same type, then equalMap(m1,m2)[x] will be equal to @@ -1653,9 +1653,9 @@ Value operator[](const Key &k) const { return _m1[k]<_m2[k]; } }; - /// Returns an \ref LessMap class - - /// This function just returns an \ref LessMap class. + /// Returns an \c LessMap class + + /// This function just returns an \c LessMap class. /// /// For example, if \c m1 and \c m2 are maps with keys and values of /// the same type, then lessMap(m1,m2)[x] will be equal to @@ -1745,9 +1745,9 @@ Iterator _end; }; - /// Returns a \ref LoggerBoolMap class - - /// This function just returns a \ref LoggerBoolMap class. + /// Returns a \c LoggerBoolMap class + + /// This function just returns a \c LoggerBoolMap class. /// /// The most important usage of it is storing certain nodes or arcs /// that were marked \c true by an algorithm. @@ -1767,7 +1767,7 @@ /// /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so /// it cannot be used when a readable map is needed, for example as - /// \c ReachedMap for \ref Bfs, \ref Dfs and \ref Dijkstra algorithms. + /// \c ReachedMap for \c Bfs, \c Dfs and \c Dijkstra algorithms. /// /// \relates LoggerBoolMap template @@ -2282,9 +2282,9 @@ const Digraph& _digraph; }; - /// \brief Returns a \ref SourceMap class. + /// \brief Returns a \c SourceMap class. /// - /// This function just returns an \ref SourceMap class. + /// This function just returns an \c SourceMap class. /// \relates SourceMap template inline SourceMap sourceMap(const Digraph& digraph) { @@ -2321,9 +2321,9 @@ const Digraph& _digraph; }; - /// \brief Returns a \ref TargetMap class. + /// \brief Returns a \c TargetMap class. /// - /// This function just returns a \ref TargetMap class. + /// This function just returns a \c TargetMap class. /// \relates TargetMap template inline TargetMap targetMap(const Digraph& digraph) { @@ -2360,9 +2360,9 @@ const Graph& _graph; }; - /// \brief Returns a \ref ForwardMap class. + /// \brief Returns a \c ForwardMap class. /// - /// This function just returns an \ref ForwardMap class. + /// This function just returns an \c ForwardMap class. /// \relates ForwardMap template inline ForwardMap forwardMap(const Graph& graph) { @@ -2399,9 +2399,9 @@ const Graph& _graph; }; - /// \brief Returns a \ref BackwardMap class - - /// This function just returns a \ref BackwardMap class. + /// \brief Returns a \c BackwardMap class + + /// This function just returns a \c BackwardMap class. /// \relates BackwardMap template inline BackwardMap backwardMap(const Graph& graph) {