1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
3 * This file is a part of LEMON, a generic C++ optimization library.
5 * Copyright (C) 2003-2009
6 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 * (Egervary Research Group on Combinatorial Optimization, EGRES).
9 * Permission to use, modify and distribute this software is granted
10 * provided that this copyright notice appears in all copies. For
11 * precise terms see the accompanying LICENSE file.
13 * This software is provided "AS IS" with no warranty of any kind,
14 * express or implied, and with no claim as to its suitability for any
27 #include <lemon/core.h>
31 ///\brief Miscellaneous property maps
38 /// Base class of maps.
40 /// Base class of maps. It provides the necessary type definitions
41 /// required by the map %concepts.
42 template<typename K, typename V>
45 /// \brief The key type of the map.
47 /// \brief The value type of the map.
48 /// (The type of objects associated with the keys).
53 /// Null map. (a.k.a. DoNothingMap)
55 /// This map can be used if you have to provide a map only for
56 /// its type definitions, or if you have to provide a writable map,
57 /// but data written to it is not required (i.e. it will be sent to
58 /// <tt>/dev/null</tt>).
59 /// It conforms the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
62 template<typename K, typename V>
63 class NullMap : public MapBase<K, V> {
70 /// Gives back a default constructed element.
71 Value operator[](const Key&) const { return Value(); }
72 /// Absorbs the value.
73 void set(const Key&, const Value&) {}
76 /// Returns a \c NullMap class
78 /// This function just returns a \c NullMap class.
80 template <typename K, typename V>
81 NullMap<K, V> nullMap() {
82 return NullMap<K, V>();
88 /// This \ref concepts::ReadMap "readable map" assigns a specified
89 /// value to each key.
91 /// In other aspects it is equivalent to \c NullMap.
92 /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap"
93 /// concept, but it absorbs the data written to it.
95 /// The simplest way of using this map is through the constMap()
100 template<typename K, typename V>
101 class ConstMap : public MapBase<K, V> {
110 /// Default constructor
112 /// Default constructor.
113 /// The value of the map will be default constructed.
116 /// Constructor with specified initial value
118 /// Constructor with specified initial value.
119 /// \param v The initial value of the map.
120 ConstMap(const Value &v) : _value(v) {}
122 /// Gives back the specified value.
123 Value operator[](const Key&) const { return _value; }
125 /// Absorbs the value.
126 void set(const Key&, const Value&) {}
128 /// Sets the value that is assigned to each key.
129 void setAll(const Value &v) {
133 template<typename V1>
134 ConstMap(const ConstMap<K, V1> &, const Value &v) : _value(v) {}
137 /// Returns a \c ConstMap class
139 /// This function just returns a \c ConstMap class.
140 /// \relates ConstMap
141 template<typename K, typename V>
142 inline ConstMap<K, V> constMap(const V &v) {
143 return ConstMap<K, V>(v);
146 template<typename K, typename V>
147 inline ConstMap<K, V> constMap() {
148 return ConstMap<K, V>();
152 template<typename T, T v>
155 /// Constant map with inlined constant value.
157 /// This \ref concepts::ReadMap "readable map" assigns a specified
158 /// value to each key.
160 /// In other aspects it is equivalent to \c NullMap.
161 /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap"
162 /// concept, but it absorbs the data written to it.
164 /// The simplest way of using this map is through the constMap()
169 template<typename K, typename V, V v>
170 class ConstMap<K, Const<V, v> > : public MapBase<K, V> {
180 /// Gives back the specified value.
181 Value operator[](const Key&) const { return v; }
183 /// Absorbs the value.
184 void set(const Key&, const Value&) {}
187 /// Returns a \c ConstMap class with inlined constant value
189 /// This function just returns a \c ConstMap class with inlined
191 /// \relates ConstMap
192 template<typename K, typename V, V v>
193 inline ConstMap<K, Const<V, v> > constMap() {
194 return ConstMap<K, Const<V, v> >();
200 /// This \ref concepts::ReadMap "read-only map" gives back the given
201 /// key as value without any modification.
204 template <typename T>
205 class IdentityMap : public MapBase<T, T> {
212 /// Gives back the given value without any modification.
213 Value operator[](const Key &k) const {
218 /// Returns an \c IdentityMap class
220 /// This function just returns an \c IdentityMap class.
221 /// \relates IdentityMap
223 inline IdentityMap<T> identityMap() {
224 return IdentityMap<T>();
228 /// \brief Map for storing values for integer keys from the range
229 /// <tt>[0..size-1]</tt>.
231 /// This map is essentially a wrapper for \c std::vector. It assigns
232 /// values to integer keys from the range <tt>[0..size-1]</tt>.
233 /// It can be used with some data structures, for example
234 /// \c UnionFind, \c BinHeap, when the used items are small
235 /// integers. This map conforms the \ref concepts::ReferenceMap
236 /// "ReferenceMap" concept.
238 /// The simplest way of using this map is through the rangeMap()
240 template <typename V>
241 class RangeMap : public MapBase<int, V> {
242 template <typename V1>
243 friend class RangeMap;
246 typedef std::vector<V> Vector;
256 typedef typename Vector::reference Reference;
257 /// Const reference type
258 typedef typename Vector::const_reference ConstReference;
260 typedef True ReferenceMapTag;
264 /// Constructor with specified default value.
265 RangeMap(int size = 0, const Value &value = Value())
266 : _vector(size, value) {}
268 /// Constructs the map from an appropriate \c std::vector.
269 template <typename V1>
270 RangeMap(const std::vector<V1>& vector)
271 : _vector(vector.begin(), vector.end()) {}
273 /// Constructs the map from another \c RangeMap.
274 template <typename V1>
275 RangeMap(const RangeMap<V1> &c)
276 : _vector(c._vector.begin(), c._vector.end()) {}
278 /// Returns the size of the map.
280 return _vector.size();
285 /// Resizes the underlying \c std::vector container, so changes the
286 /// keyset of the map.
287 /// \param size The new size of the map. The new keyset will be the
288 /// range <tt>[0..size-1]</tt>.
289 /// \param value The default value to assign to the new keys.
290 void resize(int size, const Value &value = Value()) {
291 _vector.resize(size, value);
296 RangeMap& operator=(const RangeMap&);
301 Reference operator[](const Key &k) {
306 ConstReference operator[](const Key &k) const {
311 void set(const Key &k, const Value &v) {
316 /// Returns a \c RangeMap class
318 /// This function just returns a \c RangeMap class.
319 /// \relates RangeMap
321 inline RangeMap<V> rangeMap(int size = 0, const V &value = V()) {
322 return RangeMap<V>(size, value);
325 /// \brief Returns a \c RangeMap class created from an appropriate
328 /// This function just returns a \c RangeMap class created from an
329 /// appropriate \c std::vector.
330 /// \relates RangeMap
332 inline RangeMap<V> rangeMap(const std::vector<V> &vector) {
333 return RangeMap<V>(vector);
337 /// Map type based on \c std::map
339 /// This map is essentially a wrapper for \c std::map with addition
340 /// that you can specify a default value for the keys that are not
341 /// stored actually. This value can be different from the default
342 /// contructed value (i.e. \c %Value()).
343 /// This type conforms the \ref concepts::ReferenceMap "ReferenceMap"
346 /// This map is useful if a default value should be assigned to most of
347 /// the keys and different values should be assigned only to a few
348 /// keys (i.e. the map is "sparse").
349 /// The name of this type also refers to this important usage.
351 /// Apart form that this map can be used in many other cases since it
352 /// is based on \c std::map, which is a general associative container.
353 /// However keep in mind that it is usually not as efficient as other
356 /// The simplest way of using this map is through the sparseMap()
358 template <typename K, typename V, typename Comp = std::less<K> >
359 class SparseMap : public MapBase<K, V> {
360 template <typename K1, typename V1, typename C1>
361 friend class SparseMap;
369 typedef Value& Reference;
370 /// Const reference type
371 typedef const Value& ConstReference;
373 typedef True ReferenceMapTag;
377 typedef std::map<K, V, Comp> Map;
383 /// \brief Constructor with specified default value.
384 SparseMap(const Value &value = Value()) : _value(value) {}
385 /// \brief Constructs the map from an appropriate \c std::map, and
386 /// explicitly specifies a default value.
387 template <typename V1, typename Comp1>
388 SparseMap(const std::map<Key, V1, Comp1> &map,
389 const Value &value = Value())
390 : _map(map.begin(), map.end()), _value(value) {}
392 /// \brief Constructs the map from another \c SparseMap.
393 template<typename V1, typename Comp1>
394 SparseMap(const SparseMap<Key, V1, Comp1> &c)
395 : _map(c._map.begin(), c._map.end()), _value(c._value) {}
399 SparseMap& operator=(const SparseMap&);
404 Reference operator[](const Key &k) {
405 typename Map::iterator it = _map.lower_bound(k);
406 if (it != _map.end() && !_map.key_comp()(k, it->first))
409 return _map.insert(it, std::make_pair(k, _value))->second;
413 ConstReference operator[](const Key &k) const {
414 typename Map::const_iterator it = _map.find(k);
415 if (it != _map.end())
422 void set(const Key &k, const Value &v) {
423 typename Map::iterator it = _map.lower_bound(k);
424 if (it != _map.end() && !_map.key_comp()(k, it->first))
427 _map.insert(it, std::make_pair(k, v));
431 void setAll(const Value &v) {
437 /// Returns a \c SparseMap class
439 /// This function just returns a \c SparseMap class with specified
441 /// \relates SparseMap
442 template<typename K, typename V, typename Compare>
443 inline SparseMap<K, V, Compare> sparseMap(const V& value = V()) {
444 return SparseMap<K, V, Compare>(value);
447 template<typename K, typename V>
448 inline SparseMap<K, V, std::less<K> > sparseMap(const V& value = V()) {
449 return SparseMap<K, V, std::less<K> >(value);
452 /// \brief Returns a \c SparseMap class created from an appropriate
455 /// This function just returns a \c SparseMap class created from an
456 /// appropriate \c std::map.
457 /// \relates SparseMap
458 template<typename K, typename V, typename Compare>
459 inline SparseMap<K, V, Compare>
460 sparseMap(const std::map<K, V, Compare> &map, const V& value = V())
462 return SparseMap<K, V, Compare>(map, value);
467 /// \addtogroup map_adaptors
470 /// Composition of two maps
472 /// This \ref concepts::ReadMap "read-only map" returns the
473 /// composition of two given maps. That is to say, if \c m1 is of
474 /// type \c M1 and \c m2 is of \c M2, then for
476 /// ComposeMap<M1, M2> cm(m1,m2);
478 /// <tt>cm[x]</tt> will be equal to <tt>m1[m2[x]]</tt>.
480 /// The \c Key type of the map is inherited from \c M2 and the
481 /// \c Value type is from \c M1.
482 /// \c M2::Value must be convertible to \c M1::Key.
484 /// The simplest way of using this map is through the composeMap()
488 template <typename M1, typename M2>
489 class ComposeMap : public MapBase<typename M2::Key, typename M1::Value> {
494 typedef typename M2::Key Key;
496 typedef typename M1::Value Value;
499 ComposeMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {}
502 typename MapTraits<M1>::ConstReturnValue
503 operator[](const Key &k) const { return _m1[_m2[k]]; }
506 /// Returns a \c ComposeMap class
508 /// This function just returns a \c ComposeMap class.
510 /// If \c m1 and \c m2 are maps and the \c Value type of \c m2 is
511 /// convertible to the \c Key of \c m1, then <tt>composeMap(m1,m2)[x]</tt>
512 /// will be equal to <tt>m1[m2[x]]</tt>.
514 /// \relates ComposeMap
515 template <typename M1, typename M2>
516 inline ComposeMap<M1, M2> composeMap(const M1 &m1, const M2 &m2) {
517 return ComposeMap<M1, M2>(m1, m2);
521 /// Combination of two maps using an STL (binary) functor.
523 /// This \ref concepts::ReadMap "read-only map" takes two maps and a
524 /// binary functor and returns the combination of the two given maps
525 /// using the functor.
526 /// That is to say, if \c m1 is of type \c M1 and \c m2 is of \c M2
527 /// and \c f is of \c F, then for
529 /// CombineMap<M1,M2,F,V> cm(m1,m2,f);
531 /// <tt>cm[x]</tt> will be equal to <tt>f(m1[x],m2[x])</tt>.
533 /// The \c Key type of the map is inherited from \c M1 (\c M1::Key
534 /// must be convertible to \c M2::Key) and the \c Value type is \c V.
535 /// \c M2::Value and \c M1::Value must be convertible to the
536 /// corresponding input parameter of \c F and the return type of \c F
537 /// must be convertible to \c V.
539 /// The simplest way of using this map is through the combineMap()
543 template<typename M1, typename M2, typename F,
544 typename V = typename F::result_type>
545 class CombineMap : public MapBase<typename M1::Key, V> {
551 typedef typename M1::Key Key;
556 CombineMap(const M1 &m1, const M2 &m2, const F &f = F())
557 : _m1(m1), _m2(m2), _f(f) {}
559 Value operator[](const Key &k) const { return _f(_m1[k],_m2[k]); }
562 /// Returns a \c CombineMap class
564 /// This function just returns a \c CombineMap class.
566 /// For example, if \c m1 and \c m2 are both maps with \c double
569 /// combineMap(m1,m2,std::plus<double>())
576 /// This function is specialized for adaptable binary function
577 /// classes and C++ functions.
579 /// \relates CombineMap
580 template<typename M1, typename M2, typename F, typename V>
581 inline CombineMap<M1, M2, F, V>
582 combineMap(const M1 &m1, const M2 &m2, const F &f) {
583 return CombineMap<M1, M2, F, V>(m1,m2,f);
586 template<typename M1, typename M2, typename F>
587 inline CombineMap<M1, M2, F, typename F::result_type>
588 combineMap(const M1 &m1, const M2 &m2, const F &f) {
589 return combineMap<M1, M2, F, typename F::result_type>(m1,m2,f);
592 template<typename M1, typename M2, typename K1, typename K2, typename V>
593 inline CombineMap<M1, M2, V (*)(K1, K2), V>
594 combineMap(const M1 &m1, const M2 &m2, V (*f)(K1, K2)) {
595 return combineMap<M1, M2, V (*)(K1, K2), V>(m1,m2,f);
599 /// Converts an STL style (unary) functor to a map
601 /// This \ref concepts::ReadMap "read-only map" returns the value
602 /// of a given functor. Actually, it just wraps the functor and
603 /// provides the \c Key and \c Value typedefs.
605 /// Template parameters \c K and \c V will become its \c Key and
606 /// \c Value. In most cases they have to be given explicitly because
607 /// a functor typically does not provide \c argument_type and
608 /// \c result_type typedefs.
609 /// Parameter \c F is the type of the used functor.
611 /// The simplest way of using this map is through the functorToMap()
616 typename K = typename F::argument_type,
617 typename V = typename F::result_type>
618 class FunctorToMap : public MapBase<K, V> {
627 FunctorToMap(const F &f = F()) : _f(f) {}
629 Value operator[](const Key &k) const { return _f(k); }
632 /// Returns a \c FunctorToMap class
634 /// This function just returns a \c FunctorToMap class.
636 /// This function is specialized for adaptable binary function
637 /// classes and C++ functions.
639 /// \relates FunctorToMap
640 template<typename K, typename V, typename F>
641 inline FunctorToMap<F, K, V> functorToMap(const F &f) {
642 return FunctorToMap<F, K, V>(f);
645 template <typename F>
646 inline FunctorToMap<F, typename F::argument_type, typename F::result_type>
647 functorToMap(const F &f)
649 return FunctorToMap<F, typename F::argument_type,
650 typename F::result_type>(f);
653 template <typename K, typename V>
654 inline FunctorToMap<V (*)(K), K, V> functorToMap(V (*f)(K)) {
655 return FunctorToMap<V (*)(K), K, V>(f);
659 /// Converts a map to an STL style (unary) functor
661 /// This class converts a map to an STL style (unary) functor.
662 /// That is it provides an <tt>operator()</tt> to read its values.
664 /// For the sake of convenience it also works as a usual
665 /// \ref concepts::ReadMap "readable map", i.e. <tt>operator[]</tt>
666 /// and the \c Key and \c Value typedefs also exist.
668 /// The simplest way of using this map is through the mapToFunctor()
672 template <typename M>
673 class MapToFunctor : public MapBase<typename M::Key, typename M::Value> {
677 typedef typename M::Key Key;
679 typedef typename M::Value Value;
681 typedef typename M::Key argument_type;
682 typedef typename M::Value result_type;
685 MapToFunctor(const M &m) : _m(m) {}
687 Value operator()(const Key &k) const { return _m[k]; }
689 Value operator[](const Key &k) const { return _m[k]; }
692 /// Returns a \c MapToFunctor class
694 /// This function just returns a \c MapToFunctor class.
695 /// \relates MapToFunctor
697 inline MapToFunctor<M> mapToFunctor(const M &m) {
698 return MapToFunctor<M>(m);
702 /// \brief Map adaptor to convert the \c Value type of a map to
703 /// another type using the default conversion.
705 /// Map adaptor to convert the \c Value type of a \ref concepts::ReadMap
706 /// "readable map" to another type using the default conversion.
707 /// The \c Key type of it is inherited from \c M and the \c Value
709 /// This type conforms the \ref concepts::ReadMap "ReadMap" concept.
711 /// The simplest way of using this map is through the convertMap()
713 template <typename M, typename V>
714 class ConvertMap : public MapBase<typename M::Key, V> {
718 typedef typename M::Key Key;
725 /// \param m The underlying map.
726 ConvertMap(const M &m) : _m(m) {}
729 Value operator[](const Key &k) const { return _m[k]; }
732 /// Returns a \c ConvertMap class
734 /// This function just returns a \c ConvertMap class.
735 /// \relates ConvertMap
736 template<typename V, typename M>
737 inline ConvertMap<M, V> convertMap(const M &map) {
738 return ConvertMap<M, V>(map);
742 /// Applies all map setting operations to two maps
744 /// This map has two \ref concepts::WriteMap "writable map" parameters
745 /// and each write request will be passed to both of them.
746 /// If \c M1 is also \ref concepts::ReadMap "readable", then the read
747 /// operations will return the corresponding values of \c M1.
749 /// The \c Key and \c Value types are inherited from \c M1.
750 /// The \c Key and \c Value of \c M2 must be convertible from those
753 /// The simplest way of using this map is through the forkMap()
755 template<typename M1, typename M2>
756 class ForkMap : public MapBase<typename M1::Key, typename M1::Value> {
761 typedef typename M1::Key Key;
763 typedef typename M1::Value Value;
766 ForkMap(M1 &m1, M2 &m2) : _m1(m1), _m2(m2) {}
767 /// Returns the value associated with the given key in the first map.
768 Value operator[](const Key &k) const { return _m1[k]; }
769 /// Sets the value associated with the given key in both maps.
770 void set(const Key &k, const Value &v) { _m1.set(k,v); _m2.set(k,v); }
773 /// Returns a \c ForkMap class
775 /// This function just returns a \c ForkMap class.
777 template <typename M1, typename M2>
778 inline ForkMap<M1,M2> forkMap(M1 &m1, M2 &m2) {
779 return ForkMap<M1,M2>(m1,m2);
785 /// This \ref concepts::ReadMap "read-only map" returns the sum
786 /// of the values of the two given maps.
787 /// Its \c Key and \c Value types are inherited from \c M1.
788 /// The \c Key and \c Value of \c M2 must be convertible to those of
791 /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for
793 /// AddMap<M1,M2> am(m1,m2);
795 /// <tt>am[x]</tt> will be equal to <tt>m1[x]+m2[x]</tt>.
797 /// The simplest way of using this map is through the addMap()
800 /// \sa SubMap, MulMap, DivMap
801 /// \sa ShiftMap, ShiftWriteMap
802 template<typename M1, typename M2>
803 class AddMap : public MapBase<typename M1::Key, typename M1::Value> {
808 typedef typename M1::Key Key;
810 typedef typename M1::Value Value;
813 AddMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {}
815 Value operator[](const Key &k) const { return _m1[k]+_m2[k]; }
818 /// Returns an \c AddMap class
820 /// This function just returns an \c AddMap class.
822 /// For example, if \c m1 and \c m2 are both maps with \c double
823 /// values, then <tt>addMap(m1,m2)[x]</tt> will be equal to
824 /// <tt>m1[x]+m2[x]</tt>.
827 template<typename M1, typename M2>
828 inline AddMap<M1, M2> addMap(const M1 &m1, const M2 &m2) {
829 return AddMap<M1, M2>(m1,m2);
833 /// Difference of two maps
835 /// This \ref concepts::ReadMap "read-only map" returns the difference
836 /// of the values of the two given maps.
837 /// Its \c Key and \c Value types are inherited from \c M1.
838 /// The \c Key and \c Value of \c M2 must be convertible to those of
841 /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for
843 /// SubMap<M1,M2> sm(m1,m2);
845 /// <tt>sm[x]</tt> will be equal to <tt>m1[x]-m2[x]</tt>.
847 /// The simplest way of using this map is through the subMap()
850 /// \sa AddMap, MulMap, DivMap
851 template<typename M1, typename M2>
852 class SubMap : public MapBase<typename M1::Key, typename M1::Value> {
857 typedef typename M1::Key Key;
859 typedef typename M1::Value Value;
862 SubMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {}
864 Value operator[](const Key &k) const { return _m1[k]-_m2[k]; }
867 /// Returns a \c SubMap class
869 /// This function just returns a \c SubMap class.
871 /// For example, if \c m1 and \c m2 are both maps with \c double
872 /// values, then <tt>subMap(m1,m2)[x]</tt> will be equal to
873 /// <tt>m1[x]-m2[x]</tt>.
876 template<typename M1, typename M2>
877 inline SubMap<M1, M2> subMap(const M1 &m1, const M2 &m2) {
878 return SubMap<M1, M2>(m1,m2);
882 /// Product of two maps
884 /// This \ref concepts::ReadMap "read-only map" returns the product
885 /// of the values of the two given maps.
886 /// Its \c Key and \c Value types are inherited from \c M1.
887 /// The \c Key and \c Value of \c M2 must be convertible to those of
890 /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for
892 /// MulMap<M1,M2> mm(m1,m2);
894 /// <tt>mm[x]</tt> will be equal to <tt>m1[x]*m2[x]</tt>.
896 /// The simplest way of using this map is through the mulMap()
899 /// \sa AddMap, SubMap, DivMap
900 /// \sa ScaleMap, ScaleWriteMap
901 template<typename M1, typename M2>
902 class MulMap : public MapBase<typename M1::Key, typename M1::Value> {
907 typedef typename M1::Key Key;
909 typedef typename M1::Value Value;
912 MulMap(const M1 &m1,const M2 &m2) : _m1(m1), _m2(m2) {}
914 Value operator[](const Key &k) const { return _m1[k]*_m2[k]; }
917 /// Returns a \c MulMap class
919 /// This function just returns a \c MulMap class.
921 /// For example, if \c m1 and \c m2 are both maps with \c double
922 /// values, then <tt>mulMap(m1,m2)[x]</tt> will be equal to
923 /// <tt>m1[x]*m2[x]</tt>.
926 template<typename M1, typename M2>
927 inline MulMap<M1, M2> mulMap(const M1 &m1,const M2 &m2) {
928 return MulMap<M1, M2>(m1,m2);
932 /// Quotient of two maps
934 /// This \ref concepts::ReadMap "read-only map" returns the quotient
935 /// of the values of the two given maps.
936 /// Its \c Key and \c Value types are inherited from \c M1.
937 /// The \c Key and \c Value of \c M2 must be convertible to those of
940 /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for
942 /// DivMap<M1,M2> dm(m1,m2);
944 /// <tt>dm[x]</tt> will be equal to <tt>m1[x]/m2[x]</tt>.
946 /// The simplest way of using this map is through the divMap()
949 /// \sa AddMap, SubMap, MulMap
950 template<typename M1, typename M2>
951 class DivMap : public MapBase<typename M1::Key, typename M1::Value> {
956 typedef typename M1::Key Key;
958 typedef typename M1::Value Value;
961 DivMap(const M1 &m1,const M2 &m2) : _m1(m1), _m2(m2) {}
963 Value operator[](const Key &k) const { return _m1[k]/_m2[k]; }
966 /// Returns a \c DivMap class
968 /// This function just returns a \c DivMap class.
970 /// For example, if \c m1 and \c m2 are both maps with \c double
971 /// values, then <tt>divMap(m1,m2)[x]</tt> will be equal to
972 /// <tt>m1[x]/m2[x]</tt>.
975 template<typename M1, typename M2>
976 inline DivMap<M1, M2> divMap(const M1 &m1,const M2 &m2) {
977 return DivMap<M1, M2>(m1,m2);
981 /// Shifts a map with a constant.
983 /// This \ref concepts::ReadMap "read-only map" returns the sum of
984 /// the given map and a constant value (i.e. it shifts the map with
985 /// the constant). Its \c Key and \c Value are inherited from \c M.
989 /// ShiftMap<M> sh(m,v);
993 /// ConstMap<M::Key, M::Value> cm(v);
994 /// AddMap<M, ConstMap<M::Key, M::Value> > sh(m,cm);
997 /// The simplest way of using this map is through the shiftMap()
1000 /// \sa ShiftWriteMap
1001 template<typename M, typename C = typename M::Value>
1002 class ShiftMap : public MapBase<typename M::Key, typename M::Value> {
1007 typedef typename M::Key Key;
1009 typedef typename M::Value Value;
1014 /// \param m The undelying map.
1015 /// \param v The constant value.
1016 ShiftMap(const M &m, const C &v) : _m(m), _v(v) {}
1018 Value operator[](const Key &k) const { return _m[k]+_v; }
1021 /// Shifts a map with a constant (read-write version).
1023 /// This \ref concepts::ReadWriteMap "read-write map" returns the sum
1024 /// of the given map and a constant value (i.e. it shifts the map with
1025 /// the constant). Its \c Key and \c Value are inherited from \c M.
1026 /// It makes also possible to write the map.
1028 /// The simplest way of using this map is through the shiftWriteMap()
1032 template<typename M, typename C = typename M::Value>
1033 class ShiftWriteMap : public MapBase<typename M::Key, typename M::Value> {
1038 typedef typename M::Key Key;
1040 typedef typename M::Value Value;
1045 /// \param m The undelying map.
1046 /// \param v The constant value.
1047 ShiftWriteMap(M &m, const C &v) : _m(m), _v(v) {}
1049 Value operator[](const Key &k) const { return _m[k]+_v; }
1051 void set(const Key &k, const Value &v) { _m.set(k, v-_v); }
1054 /// Returns a \c ShiftMap class
1056 /// This function just returns a \c ShiftMap class.
1058 /// For example, if \c m is a map with \c double values and \c v is
1059 /// \c double, then <tt>shiftMap(m,v)[x]</tt> will be equal to
1060 /// <tt>m[x]+v</tt>.
1062 /// \relates ShiftMap
1063 template<typename M, typename C>
1064 inline ShiftMap<M, C> shiftMap(const M &m, const C &v) {
1065 return ShiftMap<M, C>(m,v);
1068 /// Returns a \c ShiftWriteMap class
1070 /// This function just returns a \c ShiftWriteMap class.
1072 /// For example, if \c m is a map with \c double values and \c v is
1073 /// \c double, then <tt>shiftWriteMap(m,v)[x]</tt> will be equal to
1074 /// <tt>m[x]+v</tt>.
1075 /// Moreover it makes also possible to write the map.
1077 /// \relates ShiftWriteMap
1078 template<typename M, typename C>
1079 inline ShiftWriteMap<M, C> shiftWriteMap(M &m, const C &v) {
1080 return ShiftWriteMap<M, C>(m,v);
1084 /// Scales a map with a constant.
1086 /// This \ref concepts::ReadMap "read-only map" returns the value of
1087 /// the given map multiplied from the left side with a constant value.
1088 /// Its \c Key and \c Value are inherited from \c M.
1092 /// ScaleMap<M> sc(m,v);
1094 /// is equivalent to
1096 /// ConstMap<M::Key, M::Value> cm(v);
1097 /// MulMap<ConstMap<M::Key, M::Value>, M> sc(cm,m);
1100 /// The simplest way of using this map is through the scaleMap()
1103 /// \sa ScaleWriteMap
1104 template<typename M, typename C = typename M::Value>
1105 class ScaleMap : public MapBase<typename M::Key, typename M::Value> {
1110 typedef typename M::Key Key;
1112 typedef typename M::Value Value;
1117 /// \param m The undelying map.
1118 /// \param v The constant value.
1119 ScaleMap(const M &m, const C &v) : _m(m), _v(v) {}
1121 Value operator[](const Key &k) const { return _v*_m[k]; }
1124 /// Scales a map with a constant (read-write version).
1126 /// This \ref concepts::ReadWriteMap "read-write map" returns the value of
1127 /// the given map multiplied from the left side with a constant value.
1128 /// Its \c Key and \c Value are inherited from \c M.
1129 /// It can also be used as write map if the \c / operator is defined
1130 /// between \c Value and \c C and the given multiplier is not zero.
1132 /// The simplest way of using this map is through the scaleWriteMap()
1136 template<typename M, typename C = typename M::Value>
1137 class ScaleWriteMap : public MapBase<typename M::Key, typename M::Value> {
1142 typedef typename M::Key Key;
1144 typedef typename M::Value Value;
1149 /// \param m The undelying map.
1150 /// \param v The constant value.
1151 ScaleWriteMap(M &m, const C &v) : _m(m), _v(v) {}
1153 Value operator[](const Key &k) const { return _v*_m[k]; }
1155 void set(const Key &k, const Value &v) { _m.set(k, v/_v); }
1158 /// Returns a \c ScaleMap class
1160 /// This function just returns a \c ScaleMap class.
1162 /// For example, if \c m is a map with \c double values and \c v is
1163 /// \c double, then <tt>scaleMap(m,v)[x]</tt> will be equal to
1164 /// <tt>v*m[x]</tt>.
1166 /// \relates ScaleMap
1167 template<typename M, typename C>
1168 inline ScaleMap<M, C> scaleMap(const M &m, const C &v) {
1169 return ScaleMap<M, C>(m,v);
1172 /// Returns a \c ScaleWriteMap class
1174 /// This function just returns a \c ScaleWriteMap class.
1176 /// For example, if \c m is a map with \c double values and \c v is
1177 /// \c double, then <tt>scaleWriteMap(m,v)[x]</tt> will be equal to
1178 /// <tt>v*m[x]</tt>.
1179 /// Moreover it makes also possible to write the map.
1181 /// \relates ScaleWriteMap
1182 template<typename M, typename C>
1183 inline ScaleWriteMap<M, C> scaleWriteMap(M &m, const C &v) {
1184 return ScaleWriteMap<M, C>(m,v);
1188 /// Negative of a map
1190 /// This \ref concepts::ReadMap "read-only map" returns the negative
1191 /// of the values of the given map (using the unary \c - operator).
1192 /// Its \c Key and \c Value are inherited from \c M.
1194 /// If M::Value is \c int, \c double etc., then
1196 /// NegMap<M> neg(m);
1198 /// is equivalent to
1200 /// ScaleMap<M> neg(m,-1);
1203 /// The simplest way of using this map is through the negMap()
1207 template<typename M>
1208 class NegMap : public MapBase<typename M::Key, typename M::Value> {
1212 typedef typename M::Key Key;
1214 typedef typename M::Value Value;
1217 NegMap(const M &m) : _m(m) {}
1219 Value operator[](const Key &k) const { return -_m[k]; }
1222 /// Negative of a map (read-write version)
1224 /// This \ref concepts::ReadWriteMap "read-write map" returns the
1225 /// negative of the values of the given map (using the unary \c -
1227 /// Its \c Key and \c Value are inherited from \c M.
1228 /// It makes also possible to write the map.
1230 /// If M::Value is \c int, \c double etc., then
1232 /// NegWriteMap<M> neg(m);
1234 /// is equivalent to
1236 /// ScaleWriteMap<M> neg(m,-1);
1239 /// The simplest way of using this map is through the negWriteMap()
1243 template<typename M>
1244 class NegWriteMap : public MapBase<typename M::Key, typename M::Value> {
1248 typedef typename M::Key Key;
1250 typedef typename M::Value Value;
1253 NegWriteMap(M &m) : _m(m) {}
1255 Value operator[](const Key &k) const { return -_m[k]; }
1257 void set(const Key &k, const Value &v) { _m.set(k, -v); }
1260 /// Returns a \c NegMap class
1262 /// This function just returns a \c NegMap class.
1264 /// For example, if \c m is a map with \c double values, then
1265 /// <tt>negMap(m)[x]</tt> will be equal to <tt>-m[x]</tt>.
1268 template <typename M>
1269 inline NegMap<M> negMap(const M &m) {
1270 return NegMap<M>(m);
1273 /// Returns a \c NegWriteMap class
1275 /// This function just returns a \c NegWriteMap class.
1277 /// For example, if \c m is a map with \c double values, then
1278 /// <tt>negWriteMap(m)[x]</tt> will be equal to <tt>-m[x]</tt>.
1279 /// Moreover it makes also possible to write the map.
1281 /// \relates NegWriteMap
1282 template <typename M>
1283 inline NegWriteMap<M> negWriteMap(M &m) {
1284 return NegWriteMap<M>(m);
1288 /// Absolute value of a map
1290 /// This \ref concepts::ReadMap "read-only map" returns the absolute
1291 /// value of the values of the given map.
1292 /// Its \c Key and \c Value are inherited from \c M.
1293 /// \c Value must be comparable to \c 0 and the unary \c -
1294 /// operator must be defined for it, of course.
1296 /// The simplest way of using this map is through the absMap()
1298 template<typename M>
1299 class AbsMap : public MapBase<typename M::Key, typename M::Value> {
1303 typedef typename M::Key Key;
1305 typedef typename M::Value Value;
1308 AbsMap(const M &m) : _m(m) {}
1310 Value operator[](const Key &k) const {
1312 return tmp >= 0 ? tmp : -tmp;
1317 /// Returns an \c AbsMap class
1319 /// This function just returns an \c AbsMap class.
1321 /// For example, if \c m is a map with \c double values, then
1322 /// <tt>absMap(m)[x]</tt> will be equal to <tt>m[x]</tt> if
1323 /// it is positive or zero and <tt>-m[x]</tt> if <tt>m[x]</tt> is
1327 template<typename M>
1328 inline AbsMap<M> absMap(const M &m) {
1329 return AbsMap<M>(m);
1334 // Logical maps and map adaptors:
1336 /// \addtogroup maps
1339 /// Constant \c true map.
1341 /// This \ref concepts::ReadMap "read-only map" assigns \c true to
1348 /// is equivalent to
1350 /// ConstMap<K,bool> tm(true);
1355 template <typename K>
1356 class TrueMap : public MapBase<K, bool> {
1363 /// Gives back \c true.
1364 Value operator[](const Key&) const { return true; }
1367 /// Returns a \c TrueMap class
1369 /// This function just returns a \c TrueMap class.
1370 /// \relates TrueMap
1371 template<typename K>
1372 inline TrueMap<K> trueMap() {
1373 return TrueMap<K>();
1377 /// Constant \c false map.
1379 /// This \ref concepts::ReadMap "read-only map" assigns \c false to
1386 /// is equivalent to
1388 /// ConstMap<K,bool> fm(false);
1393 template <typename K>
1394 class FalseMap : public MapBase<K, bool> {
1401 /// Gives back \c false.
1402 Value operator[](const Key&) const { return false; }
1405 /// Returns a \c FalseMap class
1407 /// This function just returns a \c FalseMap class.
1408 /// \relates FalseMap
1409 template<typename K>
1410 inline FalseMap<K> falseMap() {
1411 return FalseMap<K>();
1416 /// \addtogroup map_adaptors
1419 /// Logical 'and' of two maps
1421 /// This \ref concepts::ReadMap "read-only map" returns the logical
1422 /// 'and' of the values of the two given maps.
1423 /// Its \c Key type is inherited from \c M1 and its \c Value type is
1424 /// \c bool. \c M2::Key must be convertible to \c M1::Key.
1426 /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for
1428 /// AndMap<M1,M2> am(m1,m2);
1430 /// <tt>am[x]</tt> will be equal to <tt>m1[x]&&m2[x]</tt>.
1432 /// The simplest way of using this map is through the andMap()
1436 /// \sa NotMap, NotWriteMap
1437 template<typename M1, typename M2>
1438 class AndMap : public MapBase<typename M1::Key, bool> {
1443 typedef typename M1::Key Key;
1448 AndMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {}
1450 Value operator[](const Key &k) const { return _m1[k]&&_m2[k]; }
1453 /// Returns an \c AndMap class
1455 /// This function just returns an \c AndMap class.
1457 /// For example, if \c m1 and \c m2 are both maps with \c bool values,
1458 /// then <tt>andMap(m1,m2)[x]</tt> will be equal to
1459 /// <tt>m1[x]&&m2[x]</tt>.
1462 template<typename M1, typename M2>
1463 inline AndMap<M1, M2> andMap(const M1 &m1, const M2 &m2) {
1464 return AndMap<M1, M2>(m1,m2);
1468 /// Logical 'or' of two maps
1470 /// This \ref concepts::ReadMap "read-only map" returns the logical
1471 /// 'or' of the values of the two given maps.
1472 /// Its \c Key type is inherited from \c M1 and its \c Value type is
1473 /// \c bool. \c M2::Key must be convertible to \c M1::Key.
1475 /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for
1477 /// OrMap<M1,M2> om(m1,m2);
1479 /// <tt>om[x]</tt> will be equal to <tt>m1[x]||m2[x]</tt>.
1481 /// The simplest way of using this map is through the orMap()
1485 /// \sa NotMap, NotWriteMap
1486 template<typename M1, typename M2>
1487 class OrMap : public MapBase<typename M1::Key, bool> {
1492 typedef typename M1::Key Key;
1497 OrMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {}
1499 Value operator[](const Key &k) const { return _m1[k]||_m2[k]; }
1502 /// Returns an \c OrMap class
1504 /// This function just returns an \c OrMap class.
1506 /// For example, if \c m1 and \c m2 are both maps with \c bool values,
1507 /// then <tt>orMap(m1,m2)[x]</tt> will be equal to
1508 /// <tt>m1[x]||m2[x]</tt>.
1511 template<typename M1, typename M2>
1512 inline OrMap<M1, M2> orMap(const M1 &m1, const M2 &m2) {
1513 return OrMap<M1, M2>(m1,m2);
1517 /// Logical 'not' of a map
1519 /// This \ref concepts::ReadMap "read-only map" returns the logical
1520 /// negation of the values of the given map.
1521 /// Its \c Key is inherited from \c M and its \c Value is \c bool.
1523 /// The simplest way of using this map is through the notMap()
1527 template <typename M>
1528 class NotMap : public MapBase<typename M::Key, bool> {
1532 typedef typename M::Key Key;
1537 NotMap(const M &m) : _m(m) {}
1539 Value operator[](const Key &k) const { return !_m[k]; }
1542 /// Logical 'not' of a map (read-write version)
1544 /// This \ref concepts::ReadWriteMap "read-write map" returns the
1545 /// logical negation of the values of the given map.
1546 /// Its \c Key is inherited from \c M and its \c Value is \c bool.
1547 /// It makes also possible to write the map. When a value is set,
1548 /// the opposite value is set to the original map.
1550 /// The simplest way of using this map is through the notWriteMap()
1554 template <typename M>
1555 class NotWriteMap : public MapBase<typename M::Key, bool> {
1559 typedef typename M::Key Key;
1564 NotWriteMap(M &m) : _m(m) {}
1566 Value operator[](const Key &k) const { return !_m[k]; }
1568 void set(const Key &k, bool v) { _m.set(k, !v); }
1571 /// Returns a \c NotMap class
1573 /// This function just returns a \c NotMap class.
1575 /// For example, if \c m is a map with \c bool values, then
1576 /// <tt>notMap(m)[x]</tt> will be equal to <tt>!m[x]</tt>.
1579 template <typename M>
1580 inline NotMap<M> notMap(const M &m) {
1581 return NotMap<M>(m);
1584 /// Returns a \c NotWriteMap class
1586 /// This function just returns a \c NotWriteMap class.
1588 /// For example, if \c m is a map with \c bool values, then
1589 /// <tt>notWriteMap(m)[x]</tt> will be equal to <tt>!m[x]</tt>.
1590 /// Moreover it makes also possible to write the map.
1592 /// \relates NotWriteMap
1593 template <typename M>
1594 inline NotWriteMap<M> notWriteMap(M &m) {
1595 return NotWriteMap<M>(m);
1599 /// Combination of two maps using the \c == operator
1601 /// This \ref concepts::ReadMap "read-only map" assigns \c true to
1602 /// the keys for which the corresponding values of the two maps are
1604 /// Its \c Key type is inherited from \c M1 and its \c Value type is
1605 /// \c bool. \c M2::Key must be convertible to \c M1::Key.
1607 /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for
1609 /// EqualMap<M1,M2> em(m1,m2);
1611 /// <tt>em[x]</tt> will be equal to <tt>m1[x]==m2[x]</tt>.
1613 /// The simplest way of using this map is through the equalMap()
1617 template<typename M1, typename M2>
1618 class EqualMap : public MapBase<typename M1::Key, bool> {
1623 typedef typename M1::Key Key;
1628 EqualMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {}
1630 Value operator[](const Key &k) const { return _m1[k]==_m2[k]; }
1633 /// Returns an \c EqualMap class
1635 /// This function just returns an \c EqualMap class.
1637 /// For example, if \c m1 and \c m2 are maps with keys and values of
1638 /// the same type, then <tt>equalMap(m1,m2)[x]</tt> will be equal to
1639 /// <tt>m1[x]==m2[x]</tt>.
1641 /// \relates EqualMap
1642 template<typename M1, typename M2>
1643 inline EqualMap<M1, M2> equalMap(const M1 &m1, const M2 &m2) {
1644 return EqualMap<M1, M2>(m1,m2);
1648 /// Combination of two maps using the \c < operator
1650 /// This \ref concepts::ReadMap "read-only map" assigns \c true to
1651 /// the keys for which the corresponding value of the first map is
1652 /// less then the value of the second map.
1653 /// Its \c Key type is inherited from \c M1 and its \c Value type is
1654 /// \c bool. \c M2::Key must be convertible to \c M1::Key.
1656 /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for
1658 /// LessMap<M1,M2> lm(m1,m2);
1660 /// <tt>lm[x]</tt> will be equal to <tt>m1[x]<m2[x]</tt>.
1662 /// The simplest way of using this map is through the lessMap()
1666 template<typename M1, typename M2>
1667 class LessMap : public MapBase<typename M1::Key, bool> {
1672 typedef typename M1::Key Key;
1677 LessMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {}
1679 Value operator[](const Key &k) const { return _m1[k]<_m2[k]; }
1682 /// Returns an \c LessMap class
1684 /// This function just returns an \c LessMap class.
1686 /// For example, if \c m1 and \c m2 are maps with keys and values of
1687 /// the same type, then <tt>lessMap(m1,m2)[x]</tt> will be equal to
1688 /// <tt>m1[x]<m2[x]</tt>.
1690 /// \relates LessMap
1691 template<typename M1, typename M2>
1692 inline LessMap<M1, M2> lessMap(const M1 &m1, const M2 &m2) {
1693 return LessMap<M1, M2>(m1,m2);
1696 namespace _maps_bits {
1698 template <typename _Iterator, typename Enable = void>
1699 struct IteratorTraits {
1700 typedef typename std::iterator_traits<_Iterator>::value_type Value;
1703 template <typename _Iterator>
1704 struct IteratorTraits<_Iterator,
1705 typename exists<typename _Iterator::container_type>::type>
1707 typedef typename _Iterator::container_type::value_type Value;
1714 /// \addtogroup maps
1717 /// \brief Writable bool map for logging each \c true assigned element
1719 /// A \ref concepts::WriteMap "writable" bool map for logging
1720 /// each \c true assigned element, i.e it copies subsequently each
1721 /// keys set to \c true to the given iterator.
1722 /// The most important usage of it is storing certain nodes or arcs
1723 /// that were marked \c true by an algorithm.
1725 /// There are several algorithms that provide solutions through bool
1726 /// maps and most of them assign \c true at most once for each key.
1727 /// In these cases it is a natural request to store each \c true
1728 /// assigned elements (in order of the assignment), which can be
1729 /// easily done with LoggerBoolMap.
1731 /// The simplest way of using this map is through the loggerBoolMap()
1734 /// \tparam IT The type of the iterator.
1735 /// \tparam KEY The key type of the map. The default value set
1736 /// according to the iterator type should work in most cases.
1738 /// \note The container of the iterator must contain enough space
1739 /// for the elements or the iterator should be an inserter iterator.
1741 template <typename IT, typename KEY>
1743 template <typename IT,
1744 typename KEY = typename _maps_bits::IteratorTraits<IT>::Value>
1746 class LoggerBoolMap : public MapBase<KEY, bool> {
1754 typedef IT Iterator;
1757 LoggerBoolMap(Iterator it)
1758 : _begin(it), _end(it) {}
1760 /// Gives back the given iterator set for the first key
1761 Iterator begin() const {
1765 /// Gives back the the 'after the last' iterator
1766 Iterator end() const {
1770 /// The set function of the map
1771 void set(const Key& key, Value value) {
1782 /// Returns a \c LoggerBoolMap class
1784 /// This function just returns a \c LoggerBoolMap class.
1786 /// The most important usage of it is storing certain nodes or arcs
1787 /// that were marked \c true by an algorithm.
1788 /// For example it makes easier to store the nodes in the processing
1789 /// order of Dfs algorithm, as the following examples show.
1791 /// std::vector<Node> v;
1792 /// dfs(g,s).processedMap(loggerBoolMap(std::back_inserter(v))).run();
1795 /// std::vector<Node> v(countNodes(g));
1796 /// dfs(g,s).processedMap(loggerBoolMap(v.begin())).run();
1799 /// \note The container of the iterator must contain enough space
1800 /// for the elements or the iterator should be an inserter iterator.
1802 /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so
1803 /// it cannot be used when a readable map is needed, for example as
1804 /// \c ReachedMap for \c Bfs, \c Dfs and \c Dijkstra algorithms.
1806 /// \relates LoggerBoolMap
1807 template<typename Iterator>
1808 inline LoggerBoolMap<Iterator> loggerBoolMap(Iterator it) {
1809 return LoggerBoolMap<Iterator>(it);
1814 /// \addtogroup graph_maps
1817 /// \brief Provides an immutable and unique id for each item in a graph.
1819 /// IdMap provides a unique and immutable id for each item of the
1820 /// same type (\c Node, \c Arc or \c Edge) in a graph. This id is
1821 /// - \b unique: different items get different ids,
1822 /// - \b immutable: the id of an item does not change (even if you
1823 /// delete other nodes).
1825 /// Using this map you get access (i.e. can read) the inner id values of
1826 /// the items stored in the graph, which is returned by the \c id()
1827 /// function of the graph. This map can be inverted with its member
1828 /// class \c InverseMap or with the \c operator() member.
1830 /// \tparam GR The graph type.
1831 /// \tparam K The key type of the map (\c GR::Node, \c GR::Arc or
1835 template <typename GR, typename K>
1836 class IdMap : public MapBase<K, int> {
1838 /// The graph type of IdMap.
1841 /// The key type of IdMap (\c Node, \c Arc or \c Edge).
1843 /// The key type of IdMap (\c Node, \c Arc or \c Edge).
1845 /// The value type of IdMap.
1848 /// \brief Constructor.
1850 /// Constructor of the map.
1851 explicit IdMap(const Graph& graph) : _graph(&graph) {}
1853 /// \brief Gives back the \e id of the item.
1855 /// Gives back the immutable and unique \e id of the item.
1856 int operator[](const Item& item) const { return _graph->id(item);}
1858 /// \brief Gives back the \e item by its id.
1860 /// Gives back the \e item by its id.
1861 Item operator()(int id) { return _graph->fromId(id, Item()); }
1864 const Graph* _graph;
1868 /// \brief This class represents the inverse of its owner (IdMap).
1870 /// This class represents the inverse of its owner (IdMap).
1875 /// \brief Constructor.
1877 /// Constructor for creating an id-to-item map.
1878 explicit InverseMap(const Graph& graph) : _graph(&graph) {}
1880 /// \brief Constructor.
1882 /// Constructor for creating an id-to-item map.
1883 explicit InverseMap(const IdMap& map) : _graph(map._graph) {}
1885 /// \brief Gives back the given item from its id.
1887 /// Gives back the given item from its id.
1888 Item operator[](int id) const { return _graph->fromId(id, Item());}
1891 const Graph* _graph;
1894 /// \brief Gives back the inverse of the map.
1896 /// Gives back the inverse of the IdMap.
1897 InverseMap inverse() const { return InverseMap(*_graph);}
1901 /// \brief General cross reference graph map type.
1903 /// This class provides simple invertable graph maps.
1904 /// It wraps an arbitrary \ref concepts::ReadWriteMap "ReadWriteMap"
1905 /// and if a key is set to a new value then store it
1906 /// in the inverse map.
1907 /// The values of the map can be accessed
1908 /// with stl compatible forward iterator.
1910 /// This type is not reference map, so it cannot be modified with
1911 /// the subscription operator.
1913 /// \tparam GR The graph type.
1914 /// \tparam K The key type of the map (\c GR::Node, \c GR::Arc or
1916 /// \tparam V The value type of the map.
1918 /// \see IterableValueMap
1919 template <typename GR, typename K, typename V>
1921 : protected ItemSetTraits<GR, K>::template Map<V>::Type {
1924 typedef typename ItemSetTraits<GR, K>::
1925 template Map<V>::Type Map;
1927 typedef std::map<V, K> Container;
1932 /// The graph type of CrossRefMap.
1935 /// The key type of CrossRefMap (\c Node, \c Arc or \c Edge).
1937 /// The key type of CrossRefMap (\c Node, \c Arc or \c Edge).
1939 /// The value type of CrossRefMap.
1942 /// \brief Constructor.
1944 /// Construct a new CrossRefMap for the given graph.
1945 explicit CrossRefMap(const Graph& graph) : Map(graph) {}
1947 /// \brief Forward iterator for values.
1949 /// This iterator is an stl compatible forward
1950 /// iterator on the values of the map. The values can
1951 /// be accessed in the <tt>[beginValue, endValue)</tt> range.
1953 : public std::iterator<std::forward_iterator_tag, Value> {
1954 friend class CrossRefMap;
1956 ValueIterator(typename Container::const_iterator _it)
1962 ValueIterator& operator++() { ++it; return *this; }
1963 ValueIterator operator++(int) {
1964 ValueIterator tmp(*this);
1969 const Value& operator*() const { return it->first; }
1970 const Value* operator->() const { return &(it->first); }
1972 bool operator==(ValueIterator jt) const { return it == jt.it; }
1973 bool operator!=(ValueIterator jt) const { return it != jt.it; }
1976 typename Container::const_iterator it;
1979 /// \brief Returns an iterator to the first value.
1981 /// Returns an stl compatible iterator to the
1982 /// first value of the map. The values of the
1983 /// map can be accessed in the <tt>[beginValue, endValue)</tt>
1985 ValueIterator beginValue() const {
1986 return ValueIterator(_inv_map.begin());
1989 /// \brief Returns an iterator after the last value.
1991 /// Returns an stl compatible iterator after the
1992 /// last value of the map. The values of the
1993 /// map can be accessed in the <tt>[beginValue, endValue)</tt>
1995 ValueIterator endValue() const {
1996 return ValueIterator(_inv_map.end());
1999 /// \brief Sets the value associated with the given key.
2001 /// Sets the value associated with the given key.
2002 void set(const Key& key, const Value& val) {
2003 Value oldval = Map::operator[](key);
2004 typename Container::iterator it = _inv_map.find(oldval);
2005 if (it != _inv_map.end() && it->second == key) {
2008 _inv_map.insert(std::make_pair(val, key));
2012 /// \brief Returns the value associated with the given key.
2014 /// Returns the value associated with the given key.
2015 typename MapTraits<Map>::ConstReturnValue
2016 operator[](const Key& key) const {
2017 return Map::operator[](key);
2020 /// \brief Gives back the item by its value.
2022 /// Gives back the item by its value.
2023 Key operator()(const Value& key) const {
2024 typename Container::const_iterator it = _inv_map.find(key);
2025 return it != _inv_map.end() ? it->second : INVALID;
2030 /// \brief Erase the key from the map and the inverse map.
2032 /// Erase the key from the map and the inverse map. It is called by the
2033 /// \c AlterationNotifier.
2034 virtual void erase(const Key& key) {
2035 Value val = Map::operator[](key);
2036 typename Container::iterator it = _inv_map.find(val);
2037 if (it != _inv_map.end() && it->second == key) {
2043 /// \brief Erase more keys from the map and the inverse map.
2045 /// Erase more keys from the map and the inverse map. It is called by the
2046 /// \c AlterationNotifier.
2047 virtual void erase(const std::vector<Key>& keys) {
2048 for (int i = 0; i < int(keys.size()); ++i) {
2049 Value val = Map::operator[](keys[i]);
2050 typename Container::iterator it = _inv_map.find(val);
2051 if (it != _inv_map.end() && it->second == keys[i]) {
2058 /// \brief Clear the keys from the map and the inverse map.
2060 /// Clear the keys from the map and the inverse map. It is called by the
2061 /// \c AlterationNotifier.
2062 virtual void clear() {
2069 /// \brief The inverse map type.
2071 /// The inverse of this map. The subscript operator of the map
2072 /// gives back the item that was last assigned to the value.
2075 /// \brief Constructor
2077 /// Constructor of the InverseMap.
2078 explicit InverseMap(const CrossRefMap& inverted)
2079 : _inverted(inverted) {}
2081 /// The value type of the InverseMap.
2082 typedef typename CrossRefMap::Key Value;
2083 /// The key type of the InverseMap.
2084 typedef typename CrossRefMap::Value Key;
2086 /// \brief Subscript operator.
2088 /// Subscript operator. It gives back the item
2089 /// that was last assigned to the given value.
2090 Value operator[](const Key& key) const {
2091 return _inverted(key);
2095 const CrossRefMap& _inverted;
2098 /// \brief It gives back the read-only inverse map.
2100 /// It gives back the read-only inverse map.
2101 InverseMap inverse() const {
2102 return InverseMap(*this);
2107 /// \brief Provides continuous and unique ID for the
2108 /// items of a graph.
2110 /// RangeIdMap provides a unique and continuous
2111 /// ID for each item of a given type (\c Node, \c Arc or
2112 /// \c Edge) in a graph. This id is
2113 /// - \b unique: different items get different ids,
2114 /// - \b continuous: the range of the ids is the set of integers
2115 /// between 0 and \c n-1, where \c n is the number of the items of
2116 /// this type (\c Node, \c Arc or \c Edge).
2117 /// - So, the ids can change when deleting an item of the same type.
2119 /// Thus this id is not (necessarily) the same as what can get using
2120 /// the \c id() function of the graph or \ref IdMap.
2121 /// This map can be inverted with its member class \c InverseMap,
2122 /// or with the \c operator() member.
2124 /// \tparam GR The graph type.
2125 /// \tparam K The key type of the map (\c GR::Node, \c GR::Arc or
2129 template <typename GR, typename K>
2131 : protected ItemSetTraits<GR, K>::template Map<int>::Type {
2133 typedef typename ItemSetTraits<GR, K>::template Map<int>::Type Map;
2136 /// The graph type of RangeIdMap.
2139 /// The key type of RangeIdMap (\c Node, \c Arc or \c Edge).
2141 /// The key type of RangeIdMap (\c Node, \c Arc or \c Edge).
2143 /// The value type of RangeIdMap.
2146 /// \brief Constructor.
2149 explicit RangeIdMap(const Graph& gr) : Map(gr) {
2151 const typename Map::Notifier* nf = Map::notifier();
2152 for (nf->first(it); it != INVALID; nf->next(it)) {
2153 Map::set(it, _inv_map.size());
2154 _inv_map.push_back(it);
2160 /// \brief Adds a new key to the map.
2162 /// Add a new key to the map. It is called by the
2163 /// \c AlterationNotifier.
2164 virtual void add(const Item& item) {
2166 Map::set(item, _inv_map.size());
2167 _inv_map.push_back(item);
2170 /// \brief Add more new keys to the map.
2172 /// Add more new keys to the map. It is called by the
2173 /// \c AlterationNotifier.
2174 virtual void add(const std::vector<Item>& items) {
2176 for (int i = 0; i < int(items.size()); ++i) {
2177 Map::set(items[i], _inv_map.size());
2178 _inv_map.push_back(items[i]);
2182 /// \brief Erase the key from the map.
2184 /// Erase the key from the map. It is called by the
2185 /// \c AlterationNotifier.
2186 virtual void erase(const Item& item) {
2187 Map::set(_inv_map.back(), Map::operator[](item));
2188 _inv_map[Map::operator[](item)] = _inv_map.back();
2189 _inv_map.pop_back();
2193 /// \brief Erase more keys from the map.
2195 /// Erase more keys from the map. It is called by the
2196 /// \c AlterationNotifier.
2197 virtual void erase(const std::vector<Item>& items) {
2198 for (int i = 0; i < int(items.size()); ++i) {
2199 Map::set(_inv_map.back(), Map::operator[](items[i]));
2200 _inv_map[Map::operator[](items[i])] = _inv_map.back();
2201 _inv_map.pop_back();
2206 /// \brief Build the unique map.
2208 /// Build the unique map. It is called by the
2209 /// \c AlterationNotifier.
2210 virtual void build() {
2213 const typename Map::Notifier* nf = Map::notifier();
2214 for (nf->first(it); it != INVALID; nf->next(it)) {
2215 Map::set(it, _inv_map.size());
2216 _inv_map.push_back(it);
2220 /// \brief Clear the keys from the map.
2222 /// Clear the keys from the map. It is called by the
2223 /// \c AlterationNotifier.
2224 virtual void clear() {
2231 /// \brief Returns the maximal value plus one.
2233 /// Returns the maximal value plus one in the map.
2234 unsigned int size() const {
2235 return _inv_map.size();
2238 /// \brief Swaps the position of the two items in the map.
2240 /// Swaps the position of the two items in the map.
2241 void swap(const Item& p, const Item& q) {
2242 int pi = Map::operator[](p);
2243 int qi = Map::operator[](q);
2250 /// \brief Gives back the \e RangeId of the item
2252 /// Gives back the \e RangeId of the item.
2253 int operator[](const Item& item) const {
2254 return Map::operator[](item);
2257 /// \brief Gives back the item belonging to a \e RangeId
2259 /// Gives back the item belonging to a \e RangeId.
2260 Item operator()(int id) const {
2261 return _inv_map[id];
2266 typedef std::vector<Item> Container;
2271 /// \brief The inverse map type of RangeIdMap.
2273 /// The inverse map type of RangeIdMap.
2276 /// \brief Constructor
2278 /// Constructor of the InverseMap.
2279 explicit InverseMap(const RangeIdMap& inverted)
2280 : _inverted(inverted) {}
2283 /// The value type of the InverseMap.
2284 typedef typename RangeIdMap::Key Value;
2285 /// The key type of the InverseMap.
2286 typedef typename RangeIdMap::Value Key;
2288 /// \brief Subscript operator.
2290 /// Subscript operator. It gives back the item
2291 /// that the descriptor currently belongs to.
2292 Value operator[](const Key& key) const {
2293 return _inverted(key);
2296 /// \brief Size of the map.
2298 /// Returns the size of the map.
2299 unsigned int size() const {
2300 return _inverted.size();
2304 const RangeIdMap& _inverted;
2307 /// \brief Gives back the inverse of the map.
2309 /// Gives back the inverse of the map.
2310 const InverseMap inverse() const {
2311 return InverseMap(*this);
2315 /// \brief Dynamic iterable \c bool map.
2317 /// This class provides a special graph map type which can store a
2318 /// \c bool value for graph items (\c Node, \c Arc or \c Edge).
2319 /// For both \c true and \c false values it is possible to iterate on
2322 /// This type is a reference map, so it can be modified with the
2323 /// subscription operator.
2325 /// \tparam GR The graph type.
2326 /// \tparam K The key type of the map (\c GR::Node, \c GR::Arc or
2329 /// \see IterableIntMap, IterableValueMap
2330 /// \see CrossRefMap
2331 template <typename GR, typename K>
2332 class IterableBoolMap
2333 : protected ItemSetTraits<GR, K>::template Map<int>::Type {
2337 typedef typename ItemSetTraits<GR, K>::ItemIt KeyIt;
2338 typedef typename ItemSetTraits<GR, K>::template Map<int>::Type Parent;
2340 std::vector<K> _array;
2345 /// Indicates that the map is reference map.
2346 typedef True ReferenceMapTag;
2352 /// The const reference type.
2353 typedef const Value& ConstReference;
2357 int position(const Key& key) const {
2358 return Parent::operator[](key);
2363 /// \brief Reference to the value of the map.
2365 /// This class is similar to the \c bool type. It can be converted to
2366 /// \c bool and it provides the same operators.
2368 friend class IterableBoolMap;
2370 Reference(IterableBoolMap& map, const Key& key)
2371 : _key(key), _map(map) {}
2374 Reference& operator=(const Reference& value) {
2375 _map.set(_key, static_cast<bool>(value));
2379 operator bool() const {
2380 return static_cast<const IterableBoolMap&>(_map)[_key];
2383 Reference& operator=(bool value) {
2384 _map.set(_key, value);
2387 Reference& operator&=(bool value) {
2388 _map.set(_key, _map[_key] & value);
2391 Reference& operator|=(bool value) {
2392 _map.set(_key, _map[_key] | value);
2395 Reference& operator^=(bool value) {
2396 _map.set(_key, _map[_key] ^ value);
2401 IterableBoolMap& _map;
2404 /// \brief Constructor of the map with a default value.
2406 /// Constructor of the map with a default value.
2407 explicit IterableBoolMap(const Graph& graph, bool def = false)
2409 typename Parent::Notifier* nf = Parent::notifier();
2411 for (nf->first(it); it != INVALID; nf->next(it)) {
2412 Parent::set(it, _array.size());
2413 _array.push_back(it);
2415 _sep = (def ? _array.size() : 0);
2418 /// \brief Const subscript operator of the map.
2420 /// Const subscript operator of the map.
2421 bool operator[](const Key& key) const {
2422 return position(key) < _sep;
2425 /// \brief Subscript operator of the map.
2427 /// Subscript operator of the map.
2428 Reference operator[](const Key& key) {
2429 return Reference(*this, key);
2432 /// \brief Set operation of the map.
2434 /// Set operation of the map.
2435 void set(const Key& key, bool value) {
2436 int pos = position(key);
2438 if (pos < _sep) return;
2439 Key tmp = _array[_sep];
2441 Parent::set(key, _sep);
2443 Parent::set(tmp, pos);
2446 if (pos >= _sep) return;
2448 Key tmp = _array[_sep];
2450 Parent::set(key, _sep);
2452 Parent::set(tmp, pos);
2456 /// \brief Set all items.
2458 /// Set all items in the map.
2459 /// \note Constant time operation.
2460 void setAll(bool value) {
2461 _sep = (value ? _array.size() : 0);
2464 /// \brief Returns the number of the keys mapped to \c true.
2466 /// Returns the number of the keys mapped to \c true.
2467 int trueNum() const {
2471 /// \brief Returns the number of the keys mapped to \c false.
2473 /// Returns the number of the keys mapped to \c false.
2474 int falseNum() const {
2475 return _array.size() - _sep;
2478 /// \brief Iterator for the keys mapped to \c true.
2480 /// Iterator for the keys mapped to \c true. It works
2481 /// like a graph item iterator, it can be converted to
2482 /// the key type of the map, incremented with \c ++ operator, and
2483 /// if the iterator leaves the last valid key, it will be equal to
2485 class TrueIt : public Key {
2489 /// \brief Creates an iterator.
2491 /// Creates an iterator. It iterates on the
2492 /// keys mapped to \c true.
2493 /// \param map The IterableBoolMap.
2494 explicit TrueIt(const IterableBoolMap& map)
2495 : Parent(map._sep > 0 ? map._array[map._sep - 1] : INVALID),
2498 /// \brief Invalid constructor \& conversion.
2500 /// This constructor initializes the iterator to be invalid.
2501 /// \sa Invalid for more details.
2502 TrueIt(Invalid) : Parent(INVALID), _map(0) {}
2504 /// \brief Increment operator.
2506 /// Increment operator.
2507 TrueIt& operator++() {
2508 int pos = _map->position(*this);
2509 Parent::operator=(pos > 0 ? _map->_array[pos - 1] : INVALID);
2514 const IterableBoolMap* _map;
2517 /// \brief Iterator for the keys mapped to \c false.
2519 /// Iterator for the keys mapped to \c false. It works
2520 /// like a graph item iterator, it can be converted to
2521 /// the key type of the map, incremented with \c ++ operator, and
2522 /// if the iterator leaves the last valid key, it will be equal to
2524 class FalseIt : public Key {
2528 /// \brief Creates an iterator.
2530 /// Creates an iterator. It iterates on the
2531 /// keys mapped to \c false.
2532 /// \param map The IterableBoolMap.
2533 explicit FalseIt(const IterableBoolMap& map)
2534 : Parent(map._sep < int(map._array.size()) ?
2535 map._array.back() : INVALID), _map(&map) {}
2537 /// \brief Invalid constructor \& conversion.
2539 /// This constructor initializes the iterator to be invalid.
2540 /// \sa Invalid for more details.
2541 FalseIt(Invalid) : Parent(INVALID), _map(0) {}
2543 /// \brief Increment operator.
2545 /// Increment operator.
2546 FalseIt& operator++() {
2547 int pos = _map->position(*this);
2548 Parent::operator=(pos > _map->_sep ? _map->_array[pos - 1] : INVALID);
2553 const IterableBoolMap* _map;
2556 /// \brief Iterator for the keys mapped to a given value.
2558 /// Iterator for the keys mapped to a given value. It works
2559 /// like a graph item iterator, it can be converted to
2560 /// the key type of the map, incremented with \c ++ operator, and
2561 /// if the iterator leaves the last valid key, it will be equal to
2563 class ItemIt : public Key {
2567 /// \brief Creates an iterator with a value.
2569 /// Creates an iterator with a value. It iterates on the
2570 /// keys mapped to the given value.
2571 /// \param map The IterableBoolMap.
2572 /// \param value The value.
2573 ItemIt(const IterableBoolMap& map, bool value)
2576 map._array[map._sep - 1] : INVALID) :
2577 (map._sep < int(map._array.size()) ?
2578 map._array.back() : INVALID)), _map(&map) {}
2580 /// \brief Invalid constructor \& conversion.
2582 /// This constructor initializes the iterator to be invalid.
2583 /// \sa Invalid for more details.
2584 ItemIt(Invalid) : Parent(INVALID), _map(0) {}
2586 /// \brief Increment operator.
2588 /// Increment operator.
2589 ItemIt& operator++() {
2590 int pos = _map->position(*this);
2591 int _sep = pos >= _map->_sep ? _map->_sep : 0;
2592 Parent::operator=(pos > _sep ? _map->_array[pos - 1] : INVALID);
2597 const IterableBoolMap* _map;
2602 virtual void add(const Key& key) {
2604 Parent::set(key, _array.size());
2605 _array.push_back(key);
2608 virtual void add(const std::vector<Key>& keys) {
2610 for (int i = 0; i < int(keys.size()); ++i) {
2611 Parent::set(keys[i], _array.size());
2612 _array.push_back(keys[i]);
2616 virtual void erase(const Key& key) {
2617 int pos = position(key);
2620 Parent::set(_array[_sep], pos);
2621 _array[pos] = _array[_sep];
2622 Parent::set(_array.back(), _sep);
2623 _array[_sep] = _array.back();
2626 Parent::set(_array.back(), pos);
2627 _array[pos] = _array.back();
2633 virtual void erase(const std::vector<Key>& keys) {
2634 for (int i = 0; i < int(keys.size()); ++i) {
2635 int pos = position(keys[i]);
2638 Parent::set(_array[_sep], pos);
2639 _array[pos] = _array[_sep];
2640 Parent::set(_array.back(), _sep);
2641 _array[_sep] = _array.back();
2644 Parent::set(_array.back(), pos);
2645 _array[pos] = _array.back();
2649 Parent::erase(keys);
2652 virtual void build() {
2654 typename Parent::Notifier* nf = Parent::notifier();
2656 for (nf->first(it); it != INVALID; nf->next(it)) {
2657 Parent::set(it, _array.size());
2658 _array.push_back(it);
2663 virtual void clear() {
2672 namespace _maps_bits {
2673 template <typename Item>
2674 struct IterableIntMapNode {
2675 IterableIntMapNode() : value(-1) {}
2676 IterableIntMapNode(int _value) : value(_value) {}
2682 /// \brief Dynamic iterable integer map.
2684 /// This class provides a special graph map type which can store an
2685 /// integer value for graph items (\c Node, \c Arc or \c Edge).
2686 /// For each non-negative value it is possible to iterate on the keys
2687 /// mapped to the value.
2689 /// This type is a reference map, so it can be modified with the
2690 /// subscription operator.
2692 /// \note The size of the data structure depends on the largest
2693 /// value in the map.
2695 /// \tparam GR The graph type.
2696 /// \tparam K The key type of the map (\c GR::Node, \c GR::Arc or
2699 /// \see IterableBoolMap, IterableValueMap
2700 /// \see CrossRefMap
2701 template <typename GR, typename K>
2702 class IterableIntMap
2703 : protected ItemSetTraits<GR, K>::
2704 template Map<_maps_bits::IterableIntMapNode<K> >::Type {
2706 typedef typename ItemSetTraits<GR, K>::
2707 template Map<_maps_bits::IterableIntMapNode<K> >::Type Parent;
2716 /// \brief Constructor of the map.
2718 /// Constructor of the map. It sets all values to -1.
2719 explicit IterableIntMap(const Graph& graph)
2722 /// \brief Constructor of the map with a given value.
2724 /// Constructor of the map with a given value.
2725 explicit IterableIntMap(const Graph& graph, int value)
2726 : Parent(graph, _maps_bits::IterableIntMapNode<K>(value)) {
2728 for (typename Parent::ItemIt it(*this); it != INVALID; ++it) {
2736 void unlace(const Key& key) {
2737 typename Parent::Value& node = Parent::operator[](key);
2738 if (node.value < 0) return;
2739 if (node.prev != INVALID) {
2740 Parent::operator[](node.prev).next = node.next;
2742 _first[node.value] = node.next;
2744 if (node.next != INVALID) {
2745 Parent::operator[](node.next).prev = node.prev;
2747 while (!_first.empty() && _first.back() == INVALID) {
2752 void lace(const Key& key) {
2753 typename Parent::Value& node = Parent::operator[](key);
2754 if (node.value < 0) return;
2755 if (node.value >= int(_first.size())) {
2756 _first.resize(node.value + 1, INVALID);
2758 node.prev = INVALID;
2759 node.next = _first[node.value];
2760 if (node.next != INVALID) {
2761 Parent::operator[](node.next).prev = key;
2763 _first[node.value] = key;
2768 /// Indicates that the map is reference map.
2769 typedef True ReferenceMapTag;
2771 /// \brief Reference to the value of the map.
2773 /// This class is similar to the \c int type. It can
2774 /// be converted to \c int and it has the same operators.
2776 friend class IterableIntMap;
2778 Reference(IterableIntMap& map, const Key& key)
2779 : _key(key), _map(map) {}
2782 Reference& operator=(const Reference& value) {
2783 _map.set(_key, static_cast<const int&>(value));
2787 operator const int&() const {
2788 return static_cast<const IterableIntMap&>(_map)[_key];
2791 Reference& operator=(int value) {
2792 _map.set(_key, value);
2795 Reference& operator++() {
2796 _map.set(_key, _map[_key] + 1);
2799 int operator++(int) {
2800 int value = _map[_key];
2801 _map.set(_key, value + 1);
2804 Reference& operator--() {
2805 _map.set(_key, _map[_key] - 1);
2808 int operator--(int) {
2809 int value = _map[_key];
2810 _map.set(_key, value - 1);
2813 Reference& operator+=(int value) {
2814 _map.set(_key, _map[_key] + value);
2817 Reference& operator-=(int value) {
2818 _map.set(_key, _map[_key] - value);
2821 Reference& operator*=(int value) {
2822 _map.set(_key, _map[_key] * value);
2825 Reference& operator/=(int value) {
2826 _map.set(_key, _map[_key] / value);
2829 Reference& operator%=(int value) {
2830 _map.set(_key, _map[_key] % value);
2833 Reference& operator&=(int value) {
2834 _map.set(_key, _map[_key] & value);
2837 Reference& operator|=(int value) {
2838 _map.set(_key, _map[_key] | value);
2841 Reference& operator^=(int value) {
2842 _map.set(_key, _map[_key] ^ value);
2845 Reference& operator<<=(int value) {
2846 _map.set(_key, _map[_key] << value);
2849 Reference& operator>>=(int value) {
2850 _map.set(_key, _map[_key] >> value);
2856 IterableIntMap& _map;
2859 /// The const reference type.
2860 typedef const Value& ConstReference;
2862 /// \brief Gives back the maximal value plus one.
2864 /// Gives back the maximal value plus one.
2866 return _first.size();
2869 /// \brief Set operation of the map.
2871 /// Set operation of the map.
2872 void set(const Key& key, const Value& value) {
2874 Parent::operator[](key).value = value;
2878 /// \brief Const subscript operator of the map.
2880 /// Const subscript operator of the map.
2881 const Value& operator[](const Key& key) const {
2882 return Parent::operator[](key).value;
2885 /// \brief Subscript operator of the map.
2887 /// Subscript operator of the map.
2888 Reference operator[](const Key& key) {
2889 return Reference(*this, key);
2892 /// \brief Iterator for the keys with the same value.
2894 /// Iterator for the keys with the same value. It works
2895 /// like a graph item iterator, it can be converted to
2896 /// the item type of the map, incremented with \c ++ operator, and
2897 /// if the iterator leaves the last valid item, it will be equal to
2899 class ItemIt : public Key {
2903 /// \brief Invalid constructor \& conversion.
2905 /// This constructor initializes the iterator to be invalid.
2906 /// \sa Invalid for more details.
2907 ItemIt(Invalid) : Parent(INVALID), _map(0) {}
2909 /// \brief Creates an iterator with a value.
2911 /// Creates an iterator with a value. It iterates on the
2912 /// keys mapped to the given value.
2913 /// \param map The IterableIntMap.
2914 /// \param value The value.
2915 ItemIt(const IterableIntMap& map, int value) : _map(&map) {
2916 if (value < 0 || value >= int(_map->_first.size())) {
2917 Parent::operator=(INVALID);
2919 Parent::operator=(_map->_first[value]);
2923 /// \brief Increment operator.
2925 /// Increment operator.
2926 ItemIt& operator++() {
2927 Parent::operator=(_map->IterableIntMap::Parent::
2928 operator[](static_cast<Parent&>(*this)).next);
2933 const IterableIntMap* _map;
2938 virtual void erase(const Key& key) {
2943 virtual void erase(const std::vector<Key>& keys) {
2944 for (int i = 0; i < int(keys.size()); ++i) {
2947 Parent::erase(keys);
2950 virtual void clear() {
2956 std::vector<Key> _first;
2959 namespace _maps_bits {
2960 template <typename Item, typename Value>
2961 struct IterableValueMapNode {
2962 IterableValueMapNode(Value _value = Value()) : value(_value) {}
2968 /// \brief Dynamic iterable map for comparable values.
2970 /// This class provides a special graph map type which can store an
2971 /// comparable value for graph items (\c Node, \c Arc or \c Edge).
2972 /// For each value it is possible to iterate on the keys mapped to
2975 /// The map stores for each value a linked list with
2976 /// the items which mapped to the value, and the values are stored
2977 /// in balanced binary tree. The values of the map can be accessed
2978 /// with stl compatible forward iterator.
2980 /// This type is not reference map, so it cannot be modified with
2981 /// the subscription operator.
2983 /// \tparam GR The graph type.
2984 /// \tparam K The key type of the map (\c GR::Node, \c GR::Arc or
2986 /// \tparam V The value type of the map. It can be any comparable
2989 /// \see IterableBoolMap, IterableIntMap
2990 /// \see CrossRefMap
2991 template <typename GR, typename K, typename V>
2992 class IterableValueMap
2993 : protected ItemSetTraits<GR, K>::
2994 template Map<_maps_bits::IterableValueMapNode<K, V> >::Type {
2996 typedef typename ItemSetTraits<GR, K>::
2997 template Map<_maps_bits::IterableValueMapNode<K, V> >::Type Parent;
3008 /// \brief Constructor of the map with a given value.
3010 /// Constructor of the map with a given value.
3011 explicit IterableValueMap(const Graph& graph,
3012 const Value& value = Value())
3013 : Parent(graph, _maps_bits::IterableValueMapNode<K, V>(value)) {
3014 for (typename Parent::ItemIt it(*this); it != INVALID; ++it) {
3021 void unlace(const Key& key) {
3022 typename Parent::Value& node = Parent::operator[](key);
3023 if (node.prev != INVALID) {
3024 Parent::operator[](node.prev).next = node.next;
3026 if (node.next != INVALID) {
3027 _first[node.value] = node.next;
3029 _first.erase(node.value);
3032 if (node.next != INVALID) {
3033 Parent::operator[](node.next).prev = node.prev;
3037 void lace(const Key& key) {
3038 typename Parent::Value& node = Parent::operator[](key);
3039 typename std::map<Value, Key>::iterator it = _first.find(node.value);
3040 if (it == _first.end()) {
3041 node.prev = node.next = INVALID;
3042 _first.insert(std::make_pair(node.value, key));
3044 node.prev = INVALID;
3045 node.next = it->second;
3046 if (node.next != INVALID) {
3047 Parent::operator[](node.next).prev = key;
3055 /// \brief Forward iterator for values.
3057 /// This iterator is an stl compatible forward
3058 /// iterator on the values of the map. The values can
3059 /// be accessed in the <tt>[beginValue, endValue)</tt> range.
3061 : public std::iterator<std::forward_iterator_tag, Value> {
3062 friend class IterableValueMap;
3064 ValueIterator(typename std::map<Value, Key>::const_iterator _it)
3070 ValueIterator& operator++() { ++it; return *this; }
3071 ValueIterator operator++(int) {
3072 ValueIterator tmp(*this);
3077 const Value& operator*() const { return it->first; }
3078 const Value* operator->() const { return &(it->first); }
3080 bool operator==(ValueIterator jt) const { return it == jt.it; }
3081 bool operator!=(ValueIterator jt) const { return it != jt.it; }
3084 typename std::map<Value, Key>::const_iterator it;
3087 /// \brief Returns an iterator to the first value.
3089 /// Returns an stl compatible iterator to the
3090 /// first value of the map. The values of the
3091 /// map can be accessed in the <tt>[beginValue, endValue)</tt>
3093 ValueIterator beginValue() const {
3094 return ValueIterator(_first.begin());
3097 /// \brief Returns an iterator after the last value.
3099 /// Returns an stl compatible iterator after the
3100 /// last value of the map. The values of the
3101 /// map can be accessed in the <tt>[beginValue, endValue)</tt>
3103 ValueIterator endValue() const {
3104 return ValueIterator(_first.end());
3107 /// \brief Set operation of the map.
3109 /// Set operation of the map.
3110 void set(const Key& key, const Value& value) {
3112 Parent::operator[](key).value = value;
3116 /// \brief Const subscript operator of the map.
3118 /// Const subscript operator of the map.
3119 const Value& operator[](const Key& key) const {
3120 return Parent::operator[](key).value;
3123 /// \brief Iterator for the keys with the same value.
3125 /// Iterator for the keys with the same value. It works
3126 /// like a graph item iterator, it can be converted to
3127 /// the item type of the map, incremented with \c ++ operator, and
3128 /// if the iterator leaves the last valid item, it will be equal to
3130 class ItemIt : public Key {
3134 /// \brief Invalid constructor \& conversion.
3136 /// This constructor initializes the iterator to be invalid.
3137 /// \sa Invalid for more details.
3138 ItemIt(Invalid) : Parent(INVALID), _map(0) {}
3140 /// \brief Creates an iterator with a value.
3142 /// Creates an iterator with a value. It iterates on the
3143 /// keys which have the given value.
3144 /// \param map The IterableValueMap
3145 /// \param value The value
3146 ItemIt(const IterableValueMap& map, const Value& value) : _map(&map) {
3147 typename std::map<Value, Key>::const_iterator it =
3148 map._first.find(value);
3149 if (it == map._first.end()) {
3150 Parent::operator=(INVALID);
3152 Parent::operator=(it->second);
3156 /// \brief Increment operator.
3158 /// Increment Operator.
3159 ItemIt& operator++() {
3160 Parent::operator=(_map->IterableValueMap::Parent::
3161 operator[](static_cast<Parent&>(*this)).next);
3167 const IterableValueMap* _map;
3172 virtual void add(const Key& key) {
3177 virtual void add(const std::vector<Key>& keys) {
3179 for (int i = 0; i < int(keys.size()); ++i) {
3184 virtual void erase(const Key& key) {
3189 virtual void erase(const std::vector<Key>& keys) {
3190 for (int i = 0; i < int(keys.size()); ++i) {
3193 Parent::erase(keys);
3196 virtual void build() {
3198 for (typename Parent::ItemIt it(*this); it != INVALID; ++it) {
3203 virtual void clear() {
3209 std::map<Value, Key> _first;
3212 /// \brief Map of the source nodes of arcs in a digraph.
3214 /// SourceMap provides access for the source node of each arc in a digraph,
3215 /// which is returned by the \c source() function of the digraph.
3216 /// \tparam GR The digraph type.
3218 template <typename GR>
3223 typedef typename GR::Arc Key;
3225 typedef typename GR::Node Value;
3227 /// \brief Constructor
3230 /// \param digraph The digraph that the map belongs to.
3231 explicit SourceMap(const GR& digraph) : _graph(digraph) {}
3233 /// \brief Returns the source node of the given arc.
3235 /// Returns the source node of the given arc.
3236 Value operator[](const Key& arc) const {
3237 return _graph.source(arc);
3244 /// \brief Returns a \c SourceMap class.
3246 /// This function just returns an \c SourceMap class.
3247 /// \relates SourceMap
3248 template <typename GR>
3249 inline SourceMap<GR> sourceMap(const GR& graph) {
3250 return SourceMap<GR>(graph);
3253 /// \brief Map of the target nodes of arcs in a digraph.
3255 /// TargetMap provides access for the target node of each arc in a digraph,
3256 /// which is returned by the \c target() function of the digraph.
3257 /// \tparam GR The digraph type.
3259 template <typename GR>
3264 typedef typename GR::Arc Key;
3266 typedef typename GR::Node Value;
3268 /// \brief Constructor
3271 /// \param digraph The digraph that the map belongs to.
3272 explicit TargetMap(const GR& digraph) : _graph(digraph) {}
3274 /// \brief Returns the target node of the given arc.
3276 /// Returns the target node of the given arc.
3277 Value operator[](const Key& e) const {
3278 return _graph.target(e);
3285 /// \brief Returns a \c TargetMap class.
3287 /// This function just returns a \c TargetMap class.
3288 /// \relates TargetMap
3289 template <typename GR>
3290 inline TargetMap<GR> targetMap(const GR& graph) {
3291 return TargetMap<GR>(graph);
3294 /// \brief Map of the "forward" directed arc view of edges in a graph.
3296 /// ForwardMap provides access for the "forward" directed arc view of
3297 /// each edge in a graph, which is returned by the \c direct() function
3298 /// of the graph with \c true parameter.
3299 /// \tparam GR The graph type.
3300 /// \see BackwardMap
3301 template <typename GR>
3305 typedef typename GR::Arc Value;
3306 typedef typename GR::Edge Key;
3308 /// \brief Constructor
3311 /// \param graph The graph that the map belongs to.
3312 explicit ForwardMap(const GR& graph) : _graph(graph) {}
3314 /// \brief Returns the "forward" directed arc view of the given edge.
3316 /// Returns the "forward" directed arc view of the given edge.
3317 Value operator[](const Key& key) const {
3318 return _graph.direct(key, true);
3325 /// \brief Returns a \c ForwardMap class.
3327 /// This function just returns an \c ForwardMap class.
3328 /// \relates ForwardMap
3329 template <typename GR>
3330 inline ForwardMap<GR> forwardMap(const GR& graph) {
3331 return ForwardMap<GR>(graph);
3334 /// \brief Map of the "backward" directed arc view of edges in a graph.
3336 /// BackwardMap provides access for the "backward" directed arc view of
3337 /// each edge in a graph, which is returned by the \c direct() function
3338 /// of the graph with \c false parameter.
3339 /// \tparam GR The graph type.
3341 template <typename GR>
3345 typedef typename GR::Arc Value;
3346 typedef typename GR::Edge Key;
3348 /// \brief Constructor
3351 /// \param graph The graph that the map belongs to.
3352 explicit BackwardMap(const GR& graph) : _graph(graph) {}
3354 /// \brief Returns the "backward" directed arc view of the given edge.
3356 /// Returns the "backward" directed arc view of the given edge.
3357 Value operator[](const Key& key) const {
3358 return _graph.direct(key, false);
3365 /// \brief Returns a \c BackwardMap class
3367 /// This function just returns a \c BackwardMap class.
3368 /// \relates BackwardMap
3369 template <typename GR>
3370 inline BackwardMap<GR> backwardMap(const GR& graph) {
3371 return BackwardMap<GR>(graph);
3374 /// \brief Map of the in-degrees of nodes in a digraph.
3376 /// This map returns the in-degree of a node. Once it is constructed,
3377 /// the degrees are stored in a standard \c NodeMap, so each query is done
3378 /// in constant time. On the other hand, the values are updated automatically
3379 /// whenever the digraph changes.
3381 /// \warning Besides \c addNode() and \c addArc(), a digraph structure
3382 /// may provide alternative ways to modify the digraph.
3383 /// The correct behavior of InDegMap is not guarantied if these additional
3384 /// features are used. For example the functions
3385 /// \ref ListDigraph::changeSource() "changeSource()",
3386 /// \ref ListDigraph::changeTarget() "changeTarget()" and
3387 /// \ref ListDigraph::reverseArc() "reverseArc()"
3388 /// of \ref ListDigraph will \e not update the degree values correctly.
3391 template <typename GR>
3393 : protected ItemSetTraits<GR, typename GR::Arc>
3394 ::ItemNotifier::ObserverBase {
3398 /// The graph type of InDegMap
3402 typedef typename Digraph::Node Key;
3406 typedef typename ItemSetTraits<Digraph, typename Digraph::Arc>
3407 ::ItemNotifier::ObserverBase Parent;
3412 : public ItemSetTraits<Digraph, Key>::template Map<int>::Type {
3415 typedef typename ItemSetTraits<Digraph, Key>::
3416 template Map<int>::Type Parent;
3418 AutoNodeMap(const Digraph& digraph) : Parent(digraph, 0) {}
3420 virtual void add(const Key& key) {
3422 Parent::set(key, 0);
3425 virtual void add(const std::vector<Key>& keys) {
3427 for (int i = 0; i < int(keys.size()); ++i) {
3428 Parent::set(keys[i], 0);
3432 virtual void build() {
3435 typename Parent::Notifier* nf = Parent::notifier();
3436 for (nf->first(it); it != INVALID; nf->next(it)) {
3444 /// \brief Constructor.
3446 /// Constructor for creating an in-degree map.
3447 explicit InDegMap(const Digraph& graph)
3448 : _digraph(graph), _deg(graph) {
3449 Parent::attach(_digraph.notifier(typename Digraph::Arc()));
3451 for(typename Digraph::NodeIt it(_digraph); it != INVALID; ++it) {
3452 _deg[it] = countInArcs(_digraph, it);
3456 /// \brief Gives back the in-degree of a Node.
3458 /// Gives back the in-degree of a Node.
3459 int operator[](const Key& key) const {
3465 typedef typename Digraph::Arc Arc;
3467 virtual void add(const Arc& arc) {
3468 ++_deg[_digraph.target(arc)];
3471 virtual void add(const std::vector<Arc>& arcs) {
3472 for (int i = 0; i < int(arcs.size()); ++i) {
3473 ++_deg[_digraph.target(arcs[i])];
3477 virtual void erase(const Arc& arc) {
3478 --_deg[_digraph.target(arc)];
3481 virtual void erase(const std::vector<Arc>& arcs) {
3482 for (int i = 0; i < int(arcs.size()); ++i) {
3483 --_deg[_digraph.target(arcs[i])];
3487 virtual void build() {
3488 for(typename Digraph::NodeIt it(_digraph); it != INVALID; ++it) {
3489 _deg[it] = countInArcs(_digraph, it);
3493 virtual void clear() {
3494 for(typename Digraph::NodeIt it(_digraph); it != INVALID; ++it) {
3500 const Digraph& _digraph;
3504 /// \brief Map of the out-degrees of nodes in a digraph.
3506 /// This map returns the out-degree of a node. Once it is constructed,
3507 /// the degrees are stored in a standard \c NodeMap, so each query is done
3508 /// in constant time. On the other hand, the values are updated automatically
3509 /// whenever the digraph changes.
3511 /// \warning Besides \c addNode() and \c addArc(), a digraph structure
3512 /// may provide alternative ways to modify the digraph.
3513 /// The correct behavior of OutDegMap is not guarantied if these additional
3514 /// features are used. For example the functions
3515 /// \ref ListDigraph::changeSource() "changeSource()",
3516 /// \ref ListDigraph::changeTarget() "changeTarget()" and
3517 /// \ref ListDigraph::reverseArc() "reverseArc()"
3518 /// of \ref ListDigraph will \e not update the degree values correctly.
3521 template <typename GR>
3523 : protected ItemSetTraits<GR, typename GR::Arc>
3524 ::ItemNotifier::ObserverBase {
3528 /// The graph type of OutDegMap
3532 typedef typename Digraph::Node Key;
3536 typedef typename ItemSetTraits<Digraph, typename Digraph::Arc>
3537 ::ItemNotifier::ObserverBase Parent;
3542 : public ItemSetTraits<Digraph, Key>::template Map<int>::Type {
3545 typedef typename ItemSetTraits<Digraph, Key>::
3546 template Map<int>::Type Parent;
3548 AutoNodeMap(const Digraph& digraph) : Parent(digraph, 0) {}
3550 virtual void add(const Key& key) {
3552 Parent::set(key, 0);
3554 virtual void add(const std::vector<Key>& keys) {
3556 for (int i = 0; i < int(keys.size()); ++i) {
3557 Parent::set(keys[i], 0);
3560 virtual void build() {
3563 typename Parent::Notifier* nf = Parent::notifier();
3564 for (nf->first(it); it != INVALID; nf->next(it)) {
3572 /// \brief Constructor.
3574 /// Constructor for creating an out-degree map.
3575 explicit OutDegMap(const Digraph& graph)
3576 : _digraph(graph), _deg(graph) {
3577 Parent::attach(_digraph.notifier(typename Digraph::Arc()));
3579 for(typename Digraph::NodeIt it(_digraph); it != INVALID; ++it) {
3580 _deg[it] = countOutArcs(_digraph, it);
3584 /// \brief Gives back the out-degree of a Node.
3586 /// Gives back the out-degree of a Node.
3587 int operator[](const Key& key) const {
3593 typedef typename Digraph::Arc Arc;
3595 virtual void add(const Arc& arc) {
3596 ++_deg[_digraph.source(arc)];
3599 virtual void add(const std::vector<Arc>& arcs) {
3600 for (int i = 0; i < int(arcs.size()); ++i) {
3601 ++_deg[_digraph.source(arcs[i])];
3605 virtual void erase(const Arc& arc) {
3606 --_deg[_digraph.source(arc)];
3609 virtual void erase(const std::vector<Arc>& arcs) {
3610 for (int i = 0; i < int(arcs.size()); ++i) {
3611 --_deg[_digraph.source(arcs[i])];
3615 virtual void build() {
3616 for(typename Digraph::NodeIt it(_digraph); it != INVALID; ++it) {
3617 _deg[it] = countOutArcs(_digraph, it);
3621 virtual void clear() {
3622 for(typename Digraph::NodeIt it(_digraph); it != INVALID; ++it) {
3628 const Digraph& _digraph;
3632 /// \brief Potential difference map
3634 /// PotentialDifferenceMap returns the difference between the potentials of
3635 /// the source and target nodes of each arc in a digraph, i.e. it returns
3637 /// potential[gr.target(arc)] - potential[gr.source(arc)].
3639 /// \tparam GR The digraph type.
3640 /// \tparam POT A node map storing the potentials.
3641 template <typename GR, typename POT>
3642 class PotentialDifferenceMap {
3645 typedef typename GR::Arc Key;
3647 typedef typename POT::Value Value;
3649 /// \brief Constructor
3651 /// Contructor of the map.
3652 explicit PotentialDifferenceMap(const GR& gr,
3653 const POT& potential)
3654 : _digraph(gr), _potential(potential) {}
3656 /// \brief Returns the potential difference for the given arc.
3658 /// Returns the potential difference for the given arc, i.e.
3660 /// potential[gr.target(arc)] - potential[gr.source(arc)].
3662 Value operator[](const Key& arc) const {
3663 return _potential[_digraph.target(arc)] -
3664 _potential[_digraph.source(arc)];
3669 const POT& _potential;
3672 /// \brief Returns a PotentialDifferenceMap.
3674 /// This function just returns a PotentialDifferenceMap.
3675 /// \relates PotentialDifferenceMap
3676 template <typename GR, typename POT>
3677 PotentialDifferenceMap<GR, POT>
3678 potentialDifferenceMap(const GR& gr, const POT& potential) {
3679 return PotentialDifferenceMap<GR, POT>(gr, potential);
3685 #endif // LEMON_MAPS_H