1.1 --- a/lemon/maps.h Tue Oct 07 07:08:45 2008 +0100
1.2 +++ b/lemon/maps.h Wed Oct 08 13:40:20 2008 +0200
1.3 @@ -73,9 +73,9 @@
1.4 void set(const Key&, const Value&) {}
1.5 };
1.6
1.7 - /// Returns a \ref NullMap class
1.8 -
1.9 - /// This function just returns a \ref NullMap class.
1.10 + /// Returns a \c NullMap class
1.11 +
1.12 + /// This function just returns a \c NullMap class.
1.13 /// \relates NullMap
1.14 template <typename K, typename V>
1.15 NullMap<K, V> nullMap() {
1.16 @@ -88,7 +88,7 @@
1.17 /// This \ref concepts::ReadMap "readable map" assigns a specified
1.18 /// value to each key.
1.19 ///
1.20 - /// In other aspects it is equivalent to \ref NullMap.
1.21 + /// In other aspects it is equivalent to \c NullMap.
1.22 /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap"
1.23 /// concept, but it absorbs the data written to it.
1.24 ///
1.25 @@ -133,9 +133,9 @@
1.26 ConstMap(const ConstMap<K, V1> &, const Value &v) : _value(v) {}
1.27 };
1.28
1.29 - /// Returns a \ref ConstMap class
1.30 -
1.31 - /// This function just returns a \ref ConstMap class.
1.32 + /// Returns a \c ConstMap class
1.33 +
1.34 + /// This function just returns a \c ConstMap class.
1.35 /// \relates ConstMap
1.36 template<typename K, typename V>
1.37 inline ConstMap<K, V> constMap(const V &v) {
1.38 @@ -156,7 +156,7 @@
1.39 /// This \ref concepts::ReadMap "readable map" assigns a specified
1.40 /// value to each key.
1.41 ///
1.42 - /// In other aspects it is equivalent to \ref NullMap.
1.43 + /// In other aspects it is equivalent to \c NullMap.
1.44 /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap"
1.45 /// concept, but it absorbs the data written to it.
1.46 ///
1.47 @@ -182,9 +182,9 @@
1.48 void set(const Key&, const Value&) {}
1.49 };
1.50
1.51 - /// Returns a \ref ConstMap class with inlined constant value
1.52 -
1.53 - /// This function just returns a \ref ConstMap class with inlined
1.54 + /// Returns a \c ConstMap class with inlined constant value
1.55 +
1.56 + /// This function just returns a \c ConstMap class with inlined
1.57 /// constant value.
1.58 /// \relates ConstMap
1.59 template<typename K, typename V, V v>
1.60 @@ -212,9 +212,9 @@
1.61 }
1.62 };
1.63
1.64 - /// Returns an \ref IdentityMap class
1.65 -
1.66 - /// This function just returns an \ref IdentityMap class.
1.67 + /// Returns an \c IdentityMap class
1.68 +
1.69 + /// This function just returns an \c IdentityMap class.
1.70 /// \relates IdentityMap
1.71 template<typename T>
1.72 inline IdentityMap<T> identityMap() {
1.73 @@ -228,7 +228,7 @@
1.74 /// This map is essentially a wrapper for \c std::vector. It assigns
1.75 /// values to integer keys from the range <tt>[0..size-1]</tt>.
1.76 /// It can be used with some data structures, for example
1.77 - /// \ref UnionFind, \ref BinHeap, when the used items are small
1.78 + /// \c UnionFind, \c BinHeap, when the used items are small
1.79 /// integers. This map conforms the \ref concepts::ReferenceMap
1.80 /// "ReferenceMap" concept.
1.81 ///
1.82 @@ -268,7 +268,7 @@
1.83 RangeMap(const std::vector<V1>& vector)
1.84 : _vector(vector.begin(), vector.end()) {}
1.85
1.86 - /// Constructs the map from another \ref RangeMap.
1.87 + /// Constructs the map from another \c RangeMap.
1.88 template <typename V1>
1.89 RangeMap(const RangeMap<V1> &c)
1.90 : _vector(c._vector.begin(), c._vector.end()) {}
1.91 @@ -311,19 +311,19 @@
1.92 }
1.93 };
1.94
1.95 - /// Returns a \ref RangeMap class
1.96 -
1.97 - /// This function just returns a \ref RangeMap class.
1.98 + /// Returns a \c RangeMap class
1.99 +
1.100 + /// This function just returns a \c RangeMap class.
1.101 /// \relates RangeMap
1.102 template<typename V>
1.103 inline RangeMap<V> rangeMap(int size = 0, const V &value = V()) {
1.104 return RangeMap<V>(size, value);
1.105 }
1.106
1.107 - /// \brief Returns a \ref RangeMap class created from an appropriate
1.108 + /// \brief Returns a \c RangeMap class created from an appropriate
1.109 /// \c std::vector
1.110
1.111 - /// This function just returns a \ref RangeMap class created from an
1.112 + /// This function just returns a \c RangeMap class created from an
1.113 /// appropriate \c std::vector.
1.114 /// \relates RangeMap
1.115 template<typename V>
1.116 @@ -388,7 +388,7 @@
1.117 const Value &value = Value())
1.118 : _map(map.begin(), map.end()), _value(value) {}
1.119
1.120 - /// \brief Constructs the map from another \ref SparseMap.
1.121 + /// \brief Constructs the map from another \c SparseMap.
1.122 template<typename V1, typename Comp1>
1.123 SparseMap(const SparseMap<Key, V1, Comp1> &c)
1.124 : _map(c._map.begin(), c._map.end()), _value(c._value) {}
1.125 @@ -433,9 +433,9 @@
1.126 }
1.127 };
1.128
1.129 - /// Returns a \ref SparseMap class
1.130 -
1.131 - /// This function just returns a \ref SparseMap class with specified
1.132 + /// Returns a \c SparseMap class
1.133 +
1.134 + /// This function just returns a \c SparseMap class with specified
1.135 /// default value.
1.136 /// \relates SparseMap
1.137 template<typename K, typename V, typename Compare>
1.138 @@ -448,10 +448,10 @@
1.139 return SparseMap<K, V, std::less<K> >(value);
1.140 }
1.141
1.142 - /// \brief Returns a \ref SparseMap class created from an appropriate
1.143 + /// \brief Returns a \c SparseMap class created from an appropriate
1.144 /// \c std::map
1.145
1.146 - /// This function just returns a \ref SparseMap class created from an
1.147 + /// This function just returns a \c SparseMap class created from an
1.148 /// appropriate \c std::map.
1.149 /// \relates SparseMap
1.150 template<typename K, typename V, typename Compare>
1.151 @@ -501,9 +501,9 @@
1.152 operator[](const Key &k) const { return _m1[_m2[k]]; }
1.153 };
1.154
1.155 - /// Returns a \ref ComposeMap class
1.156 -
1.157 - /// This function just returns a \ref ComposeMap class.
1.158 + /// Returns a \c ComposeMap class
1.159 +
1.160 + /// This function just returns a \c ComposeMap class.
1.161 ///
1.162 /// If \c m1 and \c m2 are maps and the \c Value type of \c m2 is
1.163 /// convertible to the \c Key of \c m1, then <tt>composeMap(m1,m2)[x]</tt>
1.164 @@ -556,9 +556,9 @@
1.165 Value operator[](const Key &k) const { return _f(_m1[k],_m2[k]); }
1.166 };
1.167
1.168 - /// Returns a \ref CombineMap class
1.169 -
1.170 - /// This function just returns a \ref CombineMap class.
1.171 + /// Returns a \c CombineMap class
1.172 +
1.173 + /// This function just returns a \c CombineMap class.
1.174 ///
1.175 /// For example, if \c m1 and \c m2 are both maps with \c double
1.176 /// values, then
1.177 @@ -625,9 +625,9 @@
1.178 Value operator[](const Key &k) const { return _f(k); }
1.179 };
1.180
1.181 - /// Returns a \ref FunctorToMap class
1.182 -
1.183 - /// This function just returns a \ref FunctorToMap class.
1.184 + /// Returns a \c FunctorToMap class
1.185 +
1.186 + /// This function just returns a \c FunctorToMap class.
1.187 ///
1.188 /// This function is specialized for adaptable binary function
1.189 /// classes and C++ functions.
1.190 @@ -684,9 +684,9 @@
1.191 Value operator[](const Key &k) const { return _m[k]; }
1.192 };
1.193
1.194 - /// Returns a \ref MapToFunctor class
1.195 -
1.196 - /// This function just returns a \ref MapToFunctor class.
1.197 + /// Returns a \c MapToFunctor class
1.198 +
1.199 + /// This function just returns a \c MapToFunctor class.
1.200 /// \relates MapToFunctor
1.201 template<typename M>
1.202 inline MapToFunctor<M> mapToFunctor(const M &m) {
1.203 @@ -723,9 +723,9 @@
1.204 Value operator[](const Key &k) const { return _m[k]; }
1.205 };
1.206
1.207 - /// Returns a \ref ConvertMap class
1.208 -
1.209 - /// This function just returns a \ref ConvertMap class.
1.210 + /// Returns a \c ConvertMap class
1.211 +
1.212 + /// This function just returns a \c ConvertMap class.
1.213 /// \relates ConvertMap
1.214 template<typename V, typename M>
1.215 inline ConvertMap<M, V> convertMap(const M &map) {
1.216 @@ -763,9 +763,9 @@
1.217 void set(const Key &k, const Value &v) { _m1.set(k,v); _m2.set(k,v); }
1.218 };
1.219
1.220 - /// Returns a \ref ForkMap class
1.221 -
1.222 - /// This function just returns a \ref ForkMap class.
1.223 + /// Returns a \c ForkMap class
1.224 +
1.225 + /// This function just returns a \c ForkMap class.
1.226 /// \relates ForkMap
1.227 template <typename M1, typename M2>
1.228 inline ForkMap<M1,M2> forkMap(M1 &m1, M2 &m2) {
1.229 @@ -807,9 +807,9 @@
1.230 Value operator[](const Key &k) const { return _m1[k]+_m2[k]; }
1.231 };
1.232
1.233 - /// Returns an \ref AddMap class
1.234 -
1.235 - /// This function just returns an \ref AddMap class.
1.236 + /// Returns an \c AddMap class
1.237 +
1.238 + /// This function just returns an \c AddMap class.
1.239 ///
1.240 /// For example, if \c m1 and \c m2 are both maps with \c double
1.241 /// values, then <tt>addMap(m1,m2)[x]</tt> will be equal to
1.242 @@ -855,9 +855,9 @@
1.243 Value operator[](const Key &k) const { return _m1[k]-_m2[k]; }
1.244 };
1.245
1.246 - /// Returns a \ref SubMap class
1.247 -
1.248 - /// This function just returns a \ref SubMap class.
1.249 + /// Returns a \c SubMap class
1.250 +
1.251 + /// This function just returns a \c SubMap class.
1.252 ///
1.253 /// For example, if \c m1 and \c m2 are both maps with \c double
1.254 /// values, then <tt>subMap(m1,m2)[x]</tt> will be equal to
1.255 @@ -904,9 +904,9 @@
1.256 Value operator[](const Key &k) const { return _m1[k]*_m2[k]; }
1.257 };
1.258
1.259 - /// Returns a \ref MulMap class
1.260 -
1.261 - /// This function just returns a \ref MulMap class.
1.262 + /// Returns a \c MulMap class
1.263 +
1.264 + /// This function just returns a \c MulMap class.
1.265 ///
1.266 /// For example, if \c m1 and \c m2 are both maps with \c double
1.267 /// values, then <tt>mulMap(m1,m2)[x]</tt> will be equal to
1.268 @@ -952,9 +952,9 @@
1.269 Value operator[](const Key &k) const { return _m1[k]/_m2[k]; }
1.270 };
1.271
1.272 - /// Returns a \ref DivMap class
1.273 -
1.274 - /// This function just returns a \ref DivMap class.
1.275 + /// Returns a \c DivMap class
1.276 +
1.277 + /// This function just returns a \c DivMap class.
1.278 ///
1.279 /// For example, if \c m1 and \c m2 are both maps with \c double
1.280 /// values, then <tt>divMap(m1,m2)[x]</tt> will be equal to
1.281 @@ -1038,9 +1038,9 @@
1.282 void set(const Key &k, const Value &v) { _m.set(k, v-_v); }
1.283 };
1.284
1.285 - /// Returns a \ref ShiftMap class
1.286 -
1.287 - /// This function just returns a \ref ShiftMap class.
1.288 + /// Returns a \c ShiftMap class
1.289 +
1.290 + /// This function just returns a \c ShiftMap class.
1.291 ///
1.292 /// For example, if \c m is a map with \c double values and \c v is
1.293 /// \c double, then <tt>shiftMap(m,v)[x]</tt> will be equal to
1.294 @@ -1052,9 +1052,9 @@
1.295 return ShiftMap<M, C>(m,v);
1.296 }
1.297
1.298 - /// Returns a \ref ShiftWriteMap class
1.299 -
1.300 - /// This function just returns a \ref ShiftWriteMap class.
1.301 + /// Returns a \c ShiftWriteMap class
1.302 +
1.303 + /// This function just returns a \c ShiftWriteMap class.
1.304 ///
1.305 /// For example, if \c m is a map with \c double values and \c v is
1.306 /// \c double, then <tt>shiftWriteMap(m,v)[x]</tt> will be equal to
1.307 @@ -1140,9 +1140,9 @@
1.308 void set(const Key &k, const Value &v) { _m.set(k, v/_v); }
1.309 };
1.310
1.311 - /// Returns a \ref ScaleMap class
1.312 -
1.313 - /// This function just returns a \ref ScaleMap class.
1.314 + /// Returns a \c ScaleMap class
1.315 +
1.316 + /// This function just returns a \c ScaleMap class.
1.317 ///
1.318 /// For example, if \c m is a map with \c double values and \c v is
1.319 /// \c double, then <tt>scaleMap(m,v)[x]</tt> will be equal to
1.320 @@ -1154,9 +1154,9 @@
1.321 return ScaleMap<M, C>(m,v);
1.322 }
1.323
1.324 - /// Returns a \ref ScaleWriteMap class
1.325 -
1.326 - /// This function just returns a \ref ScaleWriteMap class.
1.327 + /// Returns a \c ScaleWriteMap class
1.328 +
1.329 + /// This function just returns a \c ScaleWriteMap class.
1.330 ///
1.331 /// For example, if \c m is a map with \c double values and \c v is
1.332 /// \c double, then <tt>scaleWriteMap(m,v)[x]</tt> will be equal to
1.333 @@ -1240,9 +1240,9 @@
1.334 void set(const Key &k, const Value &v) { _m.set(k, -v); }
1.335 };
1.336
1.337 - /// Returns a \ref NegMap class
1.338 -
1.339 - /// This function just returns a \ref NegMap class.
1.340 + /// Returns a \c NegMap class
1.341 +
1.342 + /// This function just returns a \c NegMap class.
1.343 ///
1.344 /// For example, if \c m is a map with \c double values, then
1.345 /// <tt>negMap(m)[x]</tt> will be equal to <tt>-m[x]</tt>.
1.346 @@ -1253,9 +1253,9 @@
1.347 return NegMap<M>(m);
1.348 }
1.349
1.350 - /// Returns a \ref NegWriteMap class
1.351 -
1.352 - /// This function just returns a \ref NegWriteMap class.
1.353 + /// Returns a \c NegWriteMap class
1.354 +
1.355 + /// This function just returns a \c NegWriteMap class.
1.356 ///
1.357 /// For example, if \c m is a map with \c double values, then
1.358 /// <tt>negWriteMap(m)[x]</tt> will be equal to <tt>-m[x]</tt>.
1.359 @@ -1296,9 +1296,9 @@
1.360
1.361 };
1.362
1.363 - /// Returns an \ref AbsMap class
1.364 -
1.365 - /// This function just returns an \ref AbsMap class.
1.366 + /// Returns an \c AbsMap class
1.367 +
1.368 + /// This function just returns an \c AbsMap class.
1.369 ///
1.370 /// For example, if \c m is a map with \c double values, then
1.371 /// <tt>absMap(m)[x]</tt> will be equal to <tt>m[x]</tt> if
1.372 @@ -1345,9 +1345,9 @@
1.373 Value operator[](const Key&) const { return true; }
1.374 };
1.375
1.376 - /// Returns a \ref TrueMap class
1.377 -
1.378 - /// This function just returns a \ref TrueMap class.
1.379 + /// Returns a \c TrueMap class
1.380 +
1.381 + /// This function just returns a \c TrueMap class.
1.382 /// \relates TrueMap
1.383 template<typename K>
1.384 inline TrueMap<K> trueMap() {
1.385 @@ -1382,9 +1382,9 @@
1.386 Value operator[](const Key&) const { return false; }
1.387 };
1.388
1.389 - /// Returns a \ref FalseMap class
1.390 -
1.391 - /// This function just returns a \ref FalseMap class.
1.392 + /// Returns a \c FalseMap class
1.393 +
1.394 + /// This function just returns a \c FalseMap class.
1.395 /// \relates FalseMap
1.396 template<typename K>
1.397 inline FalseMap<K> falseMap() {
1.398 @@ -1429,9 +1429,9 @@
1.399 Value operator[](const Key &k) const { return _m1[k]&&_m2[k]; }
1.400 };
1.401
1.402 - /// Returns an \ref AndMap class
1.403 -
1.404 - /// This function just returns an \ref AndMap class.
1.405 + /// Returns an \c AndMap class
1.406 +
1.407 + /// This function just returns an \c AndMap class.
1.408 ///
1.409 /// For example, if \c m1 and \c m2 are both maps with \c bool values,
1.410 /// then <tt>andMap(m1,m2)[x]</tt> will be equal to
1.411 @@ -1477,9 +1477,9 @@
1.412 Value operator[](const Key &k) const { return _m1[k]||_m2[k]; }
1.413 };
1.414
1.415 - /// Returns an \ref OrMap class
1.416 -
1.417 - /// This function just returns an \ref OrMap class.
1.418 + /// Returns an \c OrMap class
1.419 +
1.420 + /// This function just returns an \c OrMap class.
1.421 ///
1.422 /// For example, if \c m1 and \c m2 are both maps with \c bool values,
1.423 /// then <tt>orMap(m1,m2)[x]</tt> will be equal to
1.424 @@ -1544,9 +1544,9 @@
1.425 void set(const Key &k, bool v) { _m.set(k, !v); }
1.426 };
1.427
1.428 - /// Returns a \ref NotMap class
1.429 -
1.430 - /// This function just returns a \ref NotMap class.
1.431 + /// Returns a \c NotMap class
1.432 +
1.433 + /// This function just returns a \c NotMap class.
1.434 ///
1.435 /// For example, if \c m is a map with \c bool values, then
1.436 /// <tt>notMap(m)[x]</tt> will be equal to <tt>!m[x]</tt>.
1.437 @@ -1557,9 +1557,9 @@
1.438 return NotMap<M>(m);
1.439 }
1.440
1.441 - /// Returns a \ref NotWriteMap class
1.442 -
1.443 - /// This function just returns a \ref NotWriteMap class.
1.444 + /// Returns a \c NotWriteMap class
1.445 +
1.446 + /// This function just returns a \c NotWriteMap class.
1.447 ///
1.448 /// For example, if \c m is a map with \c bool values, then
1.449 /// <tt>notWriteMap(m)[x]</tt> will be equal to <tt>!m[x]</tt>.
1.450 @@ -1605,9 +1605,9 @@
1.451 Value operator[](const Key &k) const { return _m1[k]==_m2[k]; }
1.452 };
1.453
1.454 - /// Returns an \ref EqualMap class
1.455 -
1.456 - /// This function just returns an \ref EqualMap class.
1.457 + /// Returns an \c EqualMap class
1.458 +
1.459 + /// This function just returns an \c EqualMap class.
1.460 ///
1.461 /// For example, if \c m1 and \c m2 are maps with keys and values of
1.462 /// the same type, then <tt>equalMap(m1,m2)[x]</tt> will be equal to
1.463 @@ -1653,9 +1653,9 @@
1.464 Value operator[](const Key &k) const { return _m1[k]<_m2[k]; }
1.465 };
1.466
1.467 - /// Returns an \ref LessMap class
1.468 -
1.469 - /// This function just returns an \ref LessMap class.
1.470 + /// Returns an \c LessMap class
1.471 +
1.472 + /// This function just returns an \c LessMap class.
1.473 ///
1.474 /// For example, if \c m1 and \c m2 are maps with keys and values of
1.475 /// the same type, then <tt>lessMap(m1,m2)[x]</tt> will be equal to
1.476 @@ -1745,9 +1745,9 @@
1.477 Iterator _end;
1.478 };
1.479
1.480 - /// Returns a \ref LoggerBoolMap class
1.481 -
1.482 - /// This function just returns a \ref LoggerBoolMap class.
1.483 + /// Returns a \c LoggerBoolMap class
1.484 +
1.485 + /// This function just returns a \c LoggerBoolMap class.
1.486 ///
1.487 /// The most important usage of it is storing certain nodes or arcs
1.488 /// that were marked \c true by an algorithm.
1.489 @@ -1767,7 +1767,7 @@
1.490 ///
1.491 /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so
1.492 /// it cannot be used when a readable map is needed, for example as
1.493 - /// \c ReachedMap for \ref Bfs, \ref Dfs and \ref Dijkstra algorithms.
1.494 + /// \c ReachedMap for \c Bfs, \c Dfs and \c Dijkstra algorithms.
1.495 ///
1.496 /// \relates LoggerBoolMap
1.497 template<typename Iterator>
1.498 @@ -2282,9 +2282,9 @@
1.499 const Digraph& _digraph;
1.500 };
1.501
1.502 - /// \brief Returns a \ref SourceMap class.
1.503 + /// \brief Returns a \c SourceMap class.
1.504 ///
1.505 - /// This function just returns an \ref SourceMap class.
1.506 + /// This function just returns an \c SourceMap class.
1.507 /// \relates SourceMap
1.508 template <typename Digraph>
1.509 inline SourceMap<Digraph> sourceMap(const Digraph& digraph) {
1.510 @@ -2321,9 +2321,9 @@
1.511 const Digraph& _digraph;
1.512 };
1.513
1.514 - /// \brief Returns a \ref TargetMap class.
1.515 + /// \brief Returns a \c TargetMap class.
1.516 ///
1.517 - /// This function just returns a \ref TargetMap class.
1.518 + /// This function just returns a \c TargetMap class.
1.519 /// \relates TargetMap
1.520 template <typename Digraph>
1.521 inline TargetMap<Digraph> targetMap(const Digraph& digraph) {
1.522 @@ -2360,9 +2360,9 @@
1.523 const Graph& _graph;
1.524 };
1.525
1.526 - /// \brief Returns a \ref ForwardMap class.
1.527 + /// \brief Returns a \c ForwardMap class.
1.528 ///
1.529 - /// This function just returns an \ref ForwardMap class.
1.530 + /// This function just returns an \c ForwardMap class.
1.531 /// \relates ForwardMap
1.532 template <typename Graph>
1.533 inline ForwardMap<Graph> forwardMap(const Graph& graph) {
1.534 @@ -2399,9 +2399,9 @@
1.535 const Graph& _graph;
1.536 };
1.537
1.538 - /// \brief Returns a \ref BackwardMap class
1.539 -
1.540 - /// This function just returns a \ref BackwardMap class.
1.541 + /// \brief Returns a \c BackwardMap class
1.542 +
1.543 + /// This function just returns a \c BackwardMap class.
1.544 /// \relates BackwardMap
1.545 template <typename Graph>
1.546 inline BackwardMap<Graph> backwardMap(const Graph& graph) {