# HG changeset patch # User Peter Kovacs # Date 1205611644 -3600 # Node ID 15968e25ca0848cb75539af99ad7e177f98166f7 # Parent d73c2e8b25cb0eb089f1559e928ac9f5b06751a2 Overall clean-up in maps.h - Rename some map types: * IntegerMap -> RangeMap * StdMap -> SparseMap * FunctorMap -> FunctorToMap * MapFunctor -> MapToFunctor * ForkWriteMap -> ForkMap * SimpleMap -> WrapMap * SimpleWriteMap -> WrapWriteMap - Remove the read-only ForkMap version. - Rename map-creator functions for the read-write arithmetic and logical maps. - Small fixes and improvements in the code. - Fix the typedefs of RangeMap to work correctly with bool type, too. - Rename template parameters, function parameters, and private members in many classes to be uniform and to avoid parameter names starting with underscore. - Use Key and Value types instead of K and V template parameters in public functions. - Extend the documentation with examples (e.g. for basic arithmetic and logical maps). - Many doc improvements. - Reorder the classes. - StoreBoolMap, BackInserterBoolMap, FrontInserterBoolMap, InserterBoolMap, FillBoolMap, SettingOrderBoolMap are almost unchanged, since they will be removed. - Also improve maps_test.cc to correctly check every map class, every constructor, and every creator function. diff -r d73c2e8b25cb -r 15968e25ca08 lemon/maps.h --- a/lemon/maps.h Sat Mar 15 20:21:21 2008 +0100 +++ b/lemon/maps.h Sat Mar 15 21:07:24 2008 +0100 @@ -24,12 +24,12 @@ #include #include -// #include +#include ///\file ///\ingroup maps ///\brief Miscellaneous property maps -/// + #include namespace lemon { @@ -39,41 +39,46 @@ /// Base class of maps. - /// Base class of maps. - /// It provides the necessary typedefs required by the map concept. - template + /// Base class of maps. It provides the necessary type definitions + /// required by the map %concepts. + template class MapBase { public: - /// The key type of the map. + /// \biref The key type of the map. typedef K Key; - /// The value type of the map. (The type of objects associated with the keys). - typedef T Value; + /// \brief The value type of the map. + /// (The type of objects associated with the keys). + typedef V Value; }; + /// Null map. (a.k.a. DoNothingMap) /// This map can be used if you have to provide a map only for - /// its type definitions, or if you have to provide a writable map, - /// but data written to it is not required (i.e. it will be sent to + /// its type definitions, or if you have to provide a writable map, + /// but data written to it is not required (i.e. it will be sent to /// /dev/null). - template - class NullMap : public MapBase { + /// It conforms the \ref concepts::ReadWriteMap "ReadWriteMap" concept. + /// + /// \sa ConstMap + template + class NullMap : public MapBase { public: - typedef MapBase Parent; + typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; - + /// Gives back a default constructed element. - T operator[](const K&) const { return T(); } + Value operator[](const Key&) const { return Value(); } /// Absorbs the value. - void set(const K&, const T&) {} + void set(const Key&, const Value&) {} }; - ///Returns a \c NullMap class + /// Returns a \ref NullMap class - ///This function just returns a \c NullMap class. - ///\relates NullMap - template + /// This function just returns a \ref NullMap class. + /// \relates NullMap + template NullMap nullMap() { return NullMap(); } @@ -81,62 +86,81 @@ /// Constant map. - /// This is a \ref concepts::ReadMap "readable" map which assigns a + /// This is a \ref concepts::ReadMap "readable" map which assigns a /// specified value to each key. - /// In other aspects it is equivalent to \c NullMap. - template - class ConstMap : public MapBase { + /// + /// In other aspects it is equivalent to \ref NullMap. + /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap" + /// concept, but it absorbs the data written to it. + /// + /// The simplest way of using this map is through the constMap() + /// function. + /// + /// \sa NullMap + /// \sa IdentityMap + template + class ConstMap : public MapBase { private: - T v; + V _value; public: - - typedef MapBase Parent; + typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; /// Default constructor /// Default constructor. - /// The value of the map will be uninitialized. - /// (More exactly it will be default constructed.) + /// The value of the map will be default constructed. ConstMap() {} - + /// Constructor with specified initial value /// Constructor with specified initial value. - /// \param _v is the initial value of the map. - ConstMap(const T &_v) : v(_v) {} - - ///\e - T operator[](const K&) const { return v; } + /// \param v is the initial value of the map. + ConstMap(const Value &v) : _value(v) {} - ///\e - void setAll(const T &t) { - v = t; - } + /// Gives back the specified value. + Value operator[](const Key&) const { return _value; } - template - ConstMap(const ConstMap &, const T &_v) : v(_v) {} + /// Absorbs the value. + void set(const Key&, const Value&) {} + + /// Sets the value that is assigned to each key. + void setAll(const Value &v) { + _value = v; + } + + template + ConstMap(const ConstMap &, const Value &v) : _value(v) {} }; - ///Returns a \c ConstMap class + /// Returns a \ref ConstMap class - ///This function just returns a \c ConstMap class. - ///\relates ConstMap - template + /// This function just returns a \ref ConstMap class. + /// \relates ConstMap + template inline ConstMap constMap(const V &v) { return ConstMap(v); } template - struct Const { }; + struct Const {}; /// Constant map with inlined constant value. - /// This is a \ref concepts::ReadMap "readable" map which assigns a + /// This is a \ref concepts::ReadMap "readable" map which assigns a /// specified value to each key. - /// In other aspects it is equivalent to \c NullMap. + /// + /// In other aspects it is equivalent to \ref NullMap. + /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap" + /// concept, but it absorbs the data written to it. + /// + /// The simplest way of using this map is through the constMap() + /// function. + /// + /// \sa NullMap + /// \sa IdentityMap template class ConstMap > : public MapBase { public: @@ -144,69 +168,230 @@ typedef typename Parent::Key Key; typedef typename Parent::Value Value; - ConstMap() { } - ///\e - V operator[](const K&) const { return v; } - ///\e - void set(const K&, const V&) { } + /// Constructor. + ConstMap() {} + + /// Gives back the specified value. + Value operator[](const Key&) const { return v; } + + /// Absorbs the value. + void set(const Key&, const Value&) {} }; - ///Returns a \c ConstMap class with inlined value + /// Returns a \ref ConstMap class with inlined constant value - ///This function just returns a \c ConstMap class with inlined value. - ///\relates ConstMap - template + /// This function just returns a \ref ConstMap class with inlined + /// constant value. + /// \relates ConstMap + template inline ConstMap > constMap() { return ConstMap >(); } - ///Map based on \c std::map - ///This is essentially a wrapper for \c std::map with addition that - ///you can specify a default value different from \c Value(). - ///It meets the \ref concepts::ReferenceMap "ReferenceMap" concept. - template > - class StdMap : public MapBase { - template - friend class StdMap; + /// \brief Identity map. + /// + /// This map gives back the given key as value without any + /// modification. + /// + /// \sa ConstMap + template + class IdentityMap : public MapBase { + public: + typedef MapBase Parent; + typedef typename Parent::Key Key; + typedef typename Parent::Value Value; + + /// Gives back the given value without any modification. + const T& operator[](const T& t) const { + return t; + } + }; + + /// Returns an \ref IdentityMap class + + /// This function just returns an \ref IdentityMap class. + /// \relates IdentityMap + template + inline IdentityMap identityMap() { + return IdentityMap(); + } + + + /// \brief Map for storing values for integer keys from the range + /// [0..size-1]. + /// + /// This map is essentially a wrapper for \c std::vector. It assigns + /// values to integer keys from the range [0..size-1]. + /// It can be used with some data structures, for example + /// \ref UnionFind, \ref BinHeap, when the used items are small + /// integers. This map conforms the \ref concepts::ReferenceMap + /// "ReferenceMap" concept. + /// + /// The simplest way of using this map is through the rangeMap() + /// function. + template + class RangeMap : public MapBase { + template + friend class RangeMap; + private: + + typedef std::vector Vector; + Vector _vector; + public: - typedef MapBase Parent; - ///Key type + typedef MapBase Parent; + /// Key type typedef typename Parent::Key Key; - ///Value type + /// Value type typedef typename Parent::Value Value; - ///Reference Type - typedef T& Reference; - ///Const reference type - typedef const T& ConstReference; + /// Reference type + typedef typename Vector::reference Reference; + /// Const reference type + typedef typename Vector::const_reference ConstReference; + + typedef True ReferenceMapTag; + + public: + + /// Constructor with specified default value. + RangeMap(int size = 0, const Value &value = Value()) + : _vector(size, value) {} + + /// Constructs the map from an appropriate \c std::vector. + template + RangeMap(const std::vector& vector) + : _vector(vector.begin(), vector.end()) {} + + /// Constructs the map from another \ref RangeMap. + template + RangeMap(const RangeMap &c) + : _vector(c._vector.begin(), c._vector.end()) {} + + /// Returns the size of the map. + int size() { + return _vector.size(); + } + + /// Resizes the map. + + /// Resizes the underlying \c std::vector container, so changes the + /// keyset of the map. + /// \param size The new size of the map. The new keyset will be the + /// range [0..size-1]. + /// \param value The default value to assign to the new keys. + void resize(int size, const Value &value = Value()) { + _vector.resize(size, value); + } + + private: + + RangeMap& operator=(const RangeMap&); + + public: + + ///\e + Reference operator[](const Key &k) { + return _vector[k]; + } + + ///\e + ConstReference operator[](const Key &k) const { + return _vector[k]; + } + + ///\e + void set(const Key &k, const Value &v) { + _vector[k] = v; + } + }; + + /// Returns a \ref RangeMap class + + /// This function just returns a \ref RangeMap class. + /// \relates RangeMap + template + inline RangeMap rangeMap(int size = 0, const V &value = V()) { + return RangeMap(size, value); + } + + /// \brief Returns a \ref RangeMap class created from an appropriate + /// \c std::vector + + /// This function just returns a \ref RangeMap class created from an + /// appropriate \c std::vector. + /// \relates RangeMap + template + inline RangeMap rangeMap(const std::vector &vector) { + return RangeMap(vector); + } + + + /// Map type based on \c std::map + + /// This map is essentially a wrapper for \c std::map with addition + /// that you can specify a default value for the keys that are not + /// stored actually. This value can be different from the default + /// contructed value (i.e. \c %Value()). + /// This type conforms the \ref concepts::ReferenceMap "ReferenceMap" + /// concept. + /// + /// This map is useful if a default value should be assigned to most of + /// the keys and different values should be assigned only to a few + /// keys (i.e. the map is "sparse"). + /// The name of this type also refers to this important usage. + /// + /// Apart form that this map can be used in many other cases since it + /// is based on \c std::map, which is a general associative container. + /// However keep in mind that it is usually not as efficient as other + /// maps. + /// + /// The simplest way of using this map is through the sparseMap() + /// function. + template > + class SparseMap : public MapBase { + template + friend class SparseMap; + public: + + typedef MapBase Parent; + /// Key type + typedef typename Parent::Key Key; + /// Value type + typedef typename Parent::Value Value; + /// Reference type + typedef Value& Reference; + /// Const reference type + typedef const Value& ConstReference; typedef True ReferenceMapTag; private: - - typedef std::map Map; + + typedef std::map Map; + Map _map; Value _value; - Map _map; public: - /// Constructor with specified default value - StdMap(const T& value = T()) : _value(value) {} - /// \brief Constructs the map from an appropriate \c std::map, and + /// \brief Constructor with specified default value. + SparseMap(const Value &value = Value()) : _value(value) {} + /// \brief Constructs the map from an appropriate \c std::map, and /// explicitly specifies a default value. - template - StdMap(const std::map &map, const T& value = T()) + template + SparseMap(const std::map &map, + const Value &value = Value()) : _map(map.begin(), map.end()), _value(value) {} - - /// \brief Constructs a map from an other \ref StdMap. - template - StdMap(const StdMap &c) + + /// \brief Constructs the map from another \ref SparseMap. + template + SparseMap(const SparseMap &c) : _map(c._map.begin(), c._map.end()), _value(c._value) {} private: - StdMap& operator=(const StdMap&); + SparseMap& operator=(const SparseMap&); public: @@ -219,7 +404,7 @@ return _map.insert(it, std::make_pair(k, _value))->second; } - /// \e + ///\e ConstReference operator[](const Key &k) const { typename Map::const_iterator it = _map.find(k); if (it != _map.end()) @@ -228,149 +413,48 @@ return _value; } - /// \e - void set(const Key &k, const T &t) { + ///\e + void set(const Key &k, const Value &v) { typename Map::iterator it = _map.lower_bound(k); if (it != _map.end() && !_map.key_comp()(k, it->first)) - it->second = t; + it->second = v; else - _map.insert(it, std::make_pair(k, t)); + _map.insert(it, std::make_pair(k, v)); } - /// \e - void setAll(const T &t) { - _value = t; + ///\e + void setAll(const Value &v) { + _value = v; _map.clear(); - } + } + }; - }; - - ///Returns a \c StdMap class + /// Returns a \ref SparseMap class - ///This function just returns a \c StdMap class with specified - ///default value. - ///\relates StdMap - template - inline StdMap stdMap(const V& value = V()) { - return StdMap(value); - } - - ///Returns a \c StdMap class - - ///This function just returns a \c StdMap class with specified - ///default value. - ///\relates StdMap - template - inline StdMap > stdMap(const V& value = V()) { - return StdMap >(value); - } - - ///Returns a \c StdMap class created from an appropriate std::map - - ///This function just returns a \c StdMap class created from an - ///appropriate std::map. - ///\relates StdMap - template - inline StdMap stdMap( const std::map &map, - const V& value = V() ) { - return StdMap(map, value); + /// This function just returns a \ref SparseMap class with specified + /// default value. + /// \relates SparseMap + template + inline SparseMap sparseMap(const V& value = V()) { + return SparseMap(value); } - ///Returns a \c StdMap class created from an appropriate std::map - - ///This function just returns a \c StdMap class created from an - ///appropriate std::map. - ///\relates StdMap - template - inline StdMap > stdMap( const std::map > &map, - const V& value = V() ) { - return StdMap >(map, value); + template + inline SparseMap > sparseMap(const V& value = V()) { + return SparseMap >(value); } - /// \brief Map for storing values for keys from the range [0..size-1] - /// - /// This map has the [0..size-1] keyset and the values - /// are stored in a \c std::vector container. It can be used with - /// some data structures, for example \c UnionFind, \c BinHeap, when - /// the used items are small integer numbers. - /// This map meets the \ref concepts::ReferenceMap "ReferenceMap" concept. - /// - /// \todo Revise its name - template - class IntegerMap : public MapBase { + /// \brief Returns a \ref SparseMap class created from an appropriate + /// \c std::map - template - friend class IntegerMap; - - public: - - typedef MapBase Parent; - ///\e - typedef typename Parent::Key Key; - ///\e - typedef typename Parent::Value Value; - ///\e - typedef T& Reference; - ///\e - typedef const T& ConstReference; - - typedef True ReferenceMapTag; - - private: - - typedef std::vector Vector; - Vector _vector; - - public: - - /// Constructor with specified default value - IntegerMap(int size = 0, const T& value = T()) : _vector(size, value) {} - - /// \brief Constructs the map from an appropriate \c std::vector. - template - IntegerMap(const std::vector& vector) - : _vector(vector.begin(), vector.end()) {} - - /// \brief Constructs a map from an other \ref IntegerMap. - template - IntegerMap(const IntegerMap &c) - : _vector(c._vector.begin(), c._vector.end()) {} - - /// \brief Resize the container - void resize(int size, const T& value = T()) { - _vector.resize(size, value); - } - - private: - - IntegerMap& operator=(const IntegerMap&); - - public: - - ///\e - Reference operator[](Key k) { - return _vector[k]; - } - - /// \e - ConstReference operator[](Key k) const { - return _vector[k]; - } - - /// \e - void set(const Key &k, const T& t) { - _vector[k] = t; - } - - }; - - ///Returns an \c IntegerMap class - - ///This function just returns an \c IntegerMap class. - ///\relates IntegerMap - template - inline IntegerMap integerMap(int size = 0, const T& value = T()) { - return IntegerMap(size, value); + /// This function just returns a \ref SparseMap class created from an + /// appropriate \c std::map. + /// \relates SparseMap + template + inline SparseMap + sparseMap(const std::map &map, const V& value = V()) + { + return SparseMap(map, value); } /// @} @@ -378,886 +462,1008 @@ /// \addtogroup map_adaptors /// @{ - /// \brief Identity map. + /// Composition of two maps + + /// This \ref concepts::ReadMap "read only map" returns the + /// composition of two given maps. That is to say, if \c m1 is of + /// type \c M1 and \c m2 is of \c M2, then for + /// \code + /// ComposeMap cm(m1,m2); + /// \endcode + /// cm[x] will be equal to m1[m2[x]]. /// - /// This map gives back the given key as value without any - /// modification. - template - class IdentityMap : public MapBase { + /// The \c Key type of the map is inherited from \c M2 and the + /// \c Value type is from \c M1. + /// \c M2::Value must be convertible to \c M1::Key. + /// + /// The simplest way of using this map is through the composeMap() + /// function. + /// + /// \sa CombineMap + /// + /// \todo Check the requirements. + template + class ComposeMap : public MapBase { + const M1 &_m1; + const M2 &_m2; public: - typedef MapBase Parent; + typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; + /// Constructor + ComposeMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {} + /// \e - const T& operator[](const T& t) const { - return t; - } + typename MapTraits::ConstReturnValue + operator[](const Key &k) const { return _m1[_m2[k]]; } }; - ///Returns an \c IdentityMap class + /// Returns a \ref ComposeMap class - ///This function just returns an \c IdentityMap class. - ///\relates IdentityMap - template - inline IdentityMap identityMap() { - return IdentityMap(); + /// This function just returns a \ref ComposeMap class. + /// + /// If \c m1 and \c m2 are maps and the \c Value type of \c m2 is + /// convertible to the \c Key of \c m1, then composeMap(m1,m2)[x] + /// will be equal to m1[m2[x]]. + /// + /// \relates ComposeMap + template + inline ComposeMap composeMap(const M1 &m1, const M2 &m2) { + return ComposeMap(m1, m2); } - - ///\brief Convert the \c Value of a map to another type using - ///the default conversion. + + /// Combination of two maps using an STL (binary) functor. + + /// This \ref concepts::ReadMap "read only map" takes two maps and a + /// binary functor and returns the combination of the two given maps + /// using the functor. + /// That is to say, if \c m1 is of type \c M1 and \c m2 is of \c M2 + /// and \c f is of \c F, then for + /// \code + /// CombineMap cm(m1,m2,f); + /// \endcode + /// cm[x] will be equal to f(m1[x],m2[x]). /// - ///This \ref concepts::ReadMap "read only map" - ///converts the \c Value of a map to type \c T. - ///Its \c Key is inherited from \c M. - template - class ConvertMap : public MapBase { - const M& m; + /// The \c Key type of the map is inherited from \c M1 (\c M1::Key + /// must be convertible to \c M2::Key) and the \c Value type is \c V. + /// \c M2::Value and \c M1::Value must be convertible to the + /// corresponding input parameter of \c F and the return type of \c F + /// must be convertible to \c V. + /// + /// The simplest way of using this map is through the combineMap() + /// function. + /// + /// \sa ComposeMap + /// + /// \todo Check the requirements. + template + class CombineMap : public MapBase { + const M1 &_m1; + const M2 &_m2; + F _f; public: - typedef MapBase Parent; + typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; - ///Constructor + /// Constructor + CombineMap(const M1 &m1, const M2 &m2, const F &f = F()) + : _m1(m1), _m2(m2), _f(f) {} + /// \e + Value operator[](const Key &k) const { return _f(_m1[k],_m2[k]); } + }; - ///Constructor. - ///\param _m is the underlying map. - ConvertMap(const M &_m) : m(_m) {}; + /// Returns a \ref CombineMap class - ///\e - Value operator[](const Key& k) const {return m[k];} - }; - - ///Returns a \c ConvertMap class - - ///This function just returns a \c ConvertMap class. - ///\relates ConvertMap - template - inline ConvertMap convertMap(const M &m) { - return ConvertMap(m); + /// This function just returns a \ref CombineMap class. + /// + /// For example, if \c m1 and \c m2 are both maps with \c double + /// values, then + /// \code + /// combineMap(m1,m2,std::plus()) + /// \endcode + /// is equivalent to + /// \code + /// addMap(m1,m2) + /// \endcode + /// + /// This function is specialized for adaptable binary function + /// classes and C++ functions. + /// + /// \relates CombineMap + template + inline CombineMap + combineMap(const M1 &m1, const M2 &m2, const F &f) { + return CombineMap(m1,m2,f); } - ///Simple wrapping of a map + template + inline CombineMap + combineMap(const M1 &m1, const M2 &m2, const F &f) { + return combineMap(m1,m2,f); + } - ///This \ref concepts::ReadMap "read only map" returns the simple - ///wrapping of the given map. Sometimes the reference maps cannot be - ///combined with simple read maps. This map adaptor wraps the given - ///map to simple read map. + template + inline CombineMap + combineMap(const M1 &m1, const M2 &m2, V (*f)(K1, K2)) { + return combineMap(m1,m2,f); + } + + + /// Converts an STL style (unary) functor to a map + + /// This \ref concepts::ReadMap "read only map" returns the value + /// of a given functor. Actually, it just wraps the functor and + /// provides the \c Key and \c Value typedefs. /// - ///\sa SimpleWriteMap + /// Template parameters \c K and \c V will become its \c Key and + /// \c Value. In most cases they have to be given explicitly because + /// a functor typically does not provide \c argument_type and + /// \c result_type typedefs. + /// Parameter \c F is the type of the used functor. /// - /// \todo Revise the misleading name - template - class SimpleMap : public MapBase { - const M& m; + /// The simplest way of using this map is through the functorToMap() + /// function. + /// + /// \sa MapToFunctor + template + class FunctorToMap : public MapBase { + const F &_f; + public: + typedef MapBase Parent; + typedef typename Parent::Key Key; + typedef typename Parent::Value Value; + /// Constructor + FunctorToMap(const F &f = F()) : _f(f) {} + /// \e + Value operator[](const Key &k) const { return _f(k); } + }; + + /// Returns a \ref FunctorToMap class + + /// This function just returns a \ref FunctorToMap class. + /// + /// This function is specialized for adaptable binary function + /// classes and C++ functions. + /// + /// \relates FunctorToMap + template + inline FunctorToMap functorToMap(const F &f) { + return FunctorToMap(f); + } + + template + inline FunctorToMap + functorToMap(const F &f) + { + return FunctorToMap(f); + } + + template + inline FunctorToMap functorToMap(V (*f)(K)) { + return FunctorToMap(f); + } + + + /// Converts a map to an STL style (unary) functor + + /// This class converts a map to an STL style (unary) functor. + /// That is it provides an operator() to read its values. + /// + /// For the sake of convenience it also works as a usual + /// \ref concepts::ReadMap "readable map", i.e. operator[] + /// and the \c Key and \c Value typedefs also exist. + /// + /// The simplest way of using this map is through the mapToFunctor() + /// function. + /// + ///\sa FunctorToMap + template + class MapToFunctor : public MapBase { + const M &_m; public: typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; - ///Constructor - SimpleMap(const M &_m) : m(_m) {}; - ///\e - Value operator[](Key k) const {return m[k];} + typedef typename Parent::Key argument_type; + typedef typename Parent::Value result_type; + + /// Constructor + MapToFunctor(const M &m) : _m(m) {} + /// \e + Value operator()(const Key &k) const { return _m[k]; } + /// \e + Value operator[](const Key &k) const { return _m[k]; } }; - - ///Returns a \c SimpleMap class - ///This function just returns a \c SimpleMap class. - ///\relates SimpleMap + /// Returns a \ref MapToFunctor class + + /// This function just returns a \ref MapToFunctor class. + /// \relates MapToFunctor template - inline SimpleMap simpleMap(const M &m) { - return SimpleMap(m); + inline MapToFunctor mapToFunctor(const M &m) { + return MapToFunctor(m); } - ///Simple writable wrapping of a map - ///This \ref concepts::ReadWriteMap "read-write map" returns the simple - ///wrapping of the given map. Sometimes the reference maps cannot be - ///combined with simple read-write maps. This map adaptor wraps the - ///given map to simple read-write map. + /// \brief Map adaptor to convert the \c Value type of a map to + /// another type using the default conversion. + + /// Map adaptor to convert the \c Value type of a \ref concepts::ReadMap + /// "readable map" to another type using the default conversion. + /// The \c Key type of it is inherited from \c M and the \c Value + /// type is \c V. + /// This type conforms the \ref concepts::ReadMap "ReadMap" concept. /// - ///\sa SimpleMap + /// The simplest way of using this map is through the convertMap() + /// function. + template + class ConvertMap : public MapBase { + const M &_m; + public: + typedef MapBase Parent; + typedef typename Parent::Key Key; + typedef typename Parent::Value Value; + + /// Constructor + + /// Constructor. + /// \param m The underlying map. + ConvertMap(const M &m) : _m(m) {} + + /// \e + Value operator[](const Key &k) const { return _m[k]; } + }; + + /// Returns a \ref ConvertMap class + + /// This function just returns a \ref ConvertMap class. + /// \relates ConvertMap + template + inline ConvertMap convertMap(const M &map) { + return ConvertMap(map); + } + + + /// Applies all map setting operations to two maps + + /// This map has two \ref concepts::WriteMap "writable map" parameters + /// and each write request will be passed to both of them. + /// If \c M1 is also \ref concepts::ReadMap "readable", then the read + /// operations will return the corresponding values of \c M1. /// - /// \todo Revise the misleading name - template - class SimpleWriteMap : public MapBase { - M& m; + /// The \c Key and \c Value types are inherited from \c M1. + /// The \c Key and \c Value of \c M2 must be convertible from those + /// of \c M1. + /// + /// The simplest way of using this map is through the forkMap() + /// function. + template + class ForkMap : public MapBase { + M1 &_m1; + M2 &_m2; + public: + typedef MapBase Parent; + typedef typename Parent::Key Key; + typedef typename Parent::Value Value; + /// Constructor + ForkMap(M1 &m1, M2 &m2) : _m1(m1), _m2(m2) {} + /// Returns the value associated with the given key in the first map. + Value operator[](const Key &k) const { return _m1[k]; } + /// Sets the value associated with the given key in both maps. + void set(const Key &k, const Value &v) { _m1.set(k,v); _m2.set(k,v); } + }; + + /// Returns a \ref ForkMap class + + /// This function just returns a \ref ForkMap class. + /// \relates ForkMap + template + inline ForkMap forkMap(M1 &m1, M2 &m2) { + return ForkMap(m1,m2); + } + + + /// Simple wrapping of a map + + /// This \ref concepts::ReadMap "read only map" returns the simple + /// wrapping of the given map. Sometimes the reference maps cannot be + /// combined with simple read maps. This map adaptor wraps the given + /// map to simple read map. + /// + /// The simplest way of using this map is through the wrapMap() + /// function. + /// + /// \sa WrapWriteMap + template + class WrapMap : public MapBase { + const M &_m; public: typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; - ///Constructor - SimpleWriteMap(M &_m) : m(_m) {}; - ///\e - Value operator[](Key k) const {return m[k];} - ///\e - void set(Key k, const Value& c) { m.set(k, c); } + /// Constructor + WrapMap(const M &m) : _m(m) {} + /// \e + Value operator[](const Key &k) const { return _m[k]; } }; - ///Returns a \c SimpleWriteMap class + /// Returns a \ref WrapMap class - ///This function just returns a \c SimpleWriteMap class. - ///\relates SimpleWriteMap + /// This function just returns a \ref WrapMap class. + /// \relates WrapMap template - inline SimpleWriteMap simpleWriteMap(M &m) { - return SimpleWriteMap(m); + inline WrapMap wrapMap(const M &map) { + return WrapMap(map); } - ///Sum of two maps - ///This \ref concepts::ReadMap "read only map" returns the sum of the two - ///given maps. - ///Its \c Key and \c Value are inherited from \c M1. - ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1. - template + /// Simple writable wrapping of a map + + /// This \ref concepts::ReadWriteMap "read-write map" returns the simple + /// wrapping of the given map. Sometimes the reference maps cannot be + /// combined with simple read-write maps. This map adaptor wraps the + /// given map to simple read-write map. + /// + /// The simplest way of using this map is through the wrapWriteMap() + /// function. + /// + /// \sa WrapMap + template + class WrapWriteMap : public MapBase { + M &_m; + public: + typedef MapBase Parent; + typedef typename Parent::Key Key; + typedef typename Parent::Value Value; + + /// Constructor + WrapWriteMap(M &m) : _m(m) {} + /// \e + Value operator[](const Key &k) const { return _m[k]; } + /// \e + void set(const Key &k, const Value &c) { _m.set(k, c); } + }; + + ///Returns a \ref WrapWriteMap class + + ///This function just returns a \ref WrapWriteMap class. + ///\relates WrapWriteMap + template + inline WrapWriteMap wrapWriteMap(M &map) { + return WrapWriteMap(map); + } + + + /// Sum of two maps + + /// This \ref concepts::ReadMap "read only map" returns the sum + /// of the values of the two given maps. + /// Its \c Key and \c Value types are inherited from \c M1. + /// The \c Key and \c Value of \c M2 must be convertible to those of + /// \c M1. + /// + /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for + /// \code + /// AddMap am(m1,m2); + /// \endcode + /// am[x] will be equal to m1[x]+m2[x]. + /// + /// The simplest way of using this map is through the addMap() + /// function. + /// + /// \sa SubMap, MulMap, DivMap + /// \sa ShiftMap, ShiftWriteMap + template class AddMap : public MapBase { - const M1& m1; - const M2& m2; - + const M1 &_m1; + const M2 &_m2; public: typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; - ///Constructor - AddMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {}; - ///\e - Value operator[](Key k) const {return m1[k]+m2[k];} + /// Constructor + AddMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {} + /// \e + Value operator[](const Key &k) const { return _m1[k]+_m2[k]; } }; - - ///Returns an \c AddMap class - ///This function just returns an \c AddMap class. - ///\todo Extend the documentation: how to call these type of functions? + /// Returns an \ref AddMap class + + /// This function just returns an \ref AddMap class. /// - ///\relates AddMap - template - inline AddMap addMap(const M1 &m1,const M2 &m2) { + /// For example, if \c m1 and \c m2 are both maps with \c double + /// values, then addMap(m1,m2)[x] will be equal to + /// m1[x]+m2[x]. + /// + /// \relates AddMap + template + inline AddMap addMap(const M1 &m1, const M2 &m2) { return AddMap(m1,m2); } - ///Shift a map with a constant. - ///This \ref concepts::ReadMap "read only map" returns the sum of the - ///given map and a constant value. - ///Its \c Key and \c Value are inherited from \c M. + /// Difference of two maps + + /// This \ref concepts::ReadMap "read only map" returns the difference + /// of the values of the two given maps. + /// Its \c Key and \c Value types are inherited from \c M1. + /// The \c Key and \c Value of \c M2 must be convertible to those of + /// \c M1. /// - ///Actually, - ///\code - /// ShiftMap sh(x,v); - ///\endcode - ///is equivalent to - ///\code - /// ConstMap c_tmp(v); - /// AddMap > sh(x,v); - ///\endcode + /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for + /// \code + /// SubMap sm(m1,m2); + /// \endcode + /// sm[x] will be equal to m1[x]-m2[x]. /// - ///\sa ShiftWriteMap - template + /// The simplest way of using this map is through the subMap() + /// function. + /// + /// \sa AddMap, MulMap, DivMap + template + class SubMap : public MapBase { + const M1 &_m1; + const M2 &_m2; + public: + typedef MapBase Parent; + typedef typename Parent::Key Key; + typedef typename Parent::Value Value; + + /// Constructor + SubMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {} + /// \e + Value operator[](const Key &k) const { return _m1[k]-_m2[k]; } + }; + + /// Returns a \ref SubMap class + + /// This function just returns a \ref SubMap class. + /// + /// For example, if \c m1 and \c m2 are both maps with \c double + /// values, then subMap(m1,m2)[x] will be equal to + /// m1[x]-m2[x]. + /// + /// \relates SubMap + template + inline SubMap subMap(const M1 &m1, const M2 &m2) { + return SubMap(m1,m2); + } + + + /// Product of two maps + + /// This \ref concepts::ReadMap "read only map" returns the product + /// of the values of the two given maps. + /// Its \c Key and \c Value types are inherited from \c M1. + /// The \c Key and \c Value of \c M2 must be convertible to those of + /// \c M1. + /// + /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for + /// \code + /// MulMap mm(m1,m2); + /// \endcode + /// mm[x] will be equal to m1[x]*m2[x]. + /// + /// The simplest way of using this map is through the mulMap() + /// function. + /// + /// \sa AddMap, SubMap, DivMap + /// \sa ScaleMap, ScaleWriteMap + template + class MulMap : public MapBase { + const M1 &_m1; + const M2 &_m2; + public: + typedef MapBase Parent; + typedef typename Parent::Key Key; + typedef typename Parent::Value Value; + + /// Constructor + MulMap(const M1 &m1,const M2 &m2) : _m1(m1), _m2(m2) {} + /// \e + Value operator[](const Key &k) const { return _m1[k]*_m2[k]; } + }; + + /// Returns a \ref MulMap class + + /// This function just returns a \ref MulMap class. + /// + /// For example, if \c m1 and \c m2 are both maps with \c double + /// values, then mulMap(m1,m2)[x] will be equal to + /// m1[x]*m2[x]. + /// + /// \relates MulMap + template + inline MulMap mulMap(const M1 &m1,const M2 &m2) { + return MulMap(m1,m2); + } + + + /// Quotient of two maps + + /// This \ref concepts::ReadMap "read only map" returns the quotient + /// of the values of the two given maps. + /// Its \c Key and \c Value types are inherited from \c M1. + /// The \c Key and \c Value of \c M2 must be convertible to those of + /// \c M1. + /// + /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for + /// \code + /// DivMap dm(m1,m2); + /// \endcode + /// dm[x] will be equal to m1[x]/m2[x]. + /// + /// The simplest way of using this map is through the divMap() + /// function. + /// + /// \sa AddMap, SubMap, MulMap + template + class DivMap : public MapBase { + const M1 &_m1; + const M2 &_m2; + public: + typedef MapBase Parent; + typedef typename Parent::Key Key; + typedef typename Parent::Value Value; + + /// Constructor + DivMap(const M1 &m1,const M2 &m2) : _m1(m1), _m2(m2) {} + /// \e + Value operator[](const Key &k) const { return _m1[k]/_m2[k]; } + }; + + /// Returns a \ref DivMap class + + /// This function just returns a \ref DivMap class. + /// + /// For example, if \c m1 and \c m2 are both maps with \c double + /// values, then divMap(m1,m2)[x] will be equal to + /// m1[x]/m2[x]. + /// + /// \relates DivMap + template + inline DivMap divMap(const M1 &m1,const M2 &m2) { + return DivMap(m1,m2); + } + + + /// Shifts a map with a constant. + + /// This \ref concepts::ReadMap "read only map" returns the sum of + /// the given map and a constant value (i.e. it shifts the map with + /// the constant). Its \c Key and \c Value are inherited from \c M. + /// + /// Actually, + /// \code + /// ShiftMap sh(m,v); + /// \endcode + /// is equivalent to + /// \code + /// ConstMap cm(v); + /// AddMap > sh(m,cm); + /// \endcode + /// + /// The simplest way of using this map is through the shiftMap() + /// function. + /// + /// \sa ShiftWriteMap + template class ShiftMap : public MapBase { - const M& m; - C v; + const M &_m; + C _v; public: typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; - ///Constructor + /// Constructor - ///Constructor. - ///\param _m is the undelying map. - ///\param _v is the shift value. - ShiftMap(const M &_m, const C &_v ) : m(_m), v(_v) {}; - ///\e - Value operator[](Key k) const {return m[k] + v;} + /// Constructor. + /// \param m The undelying map. + /// \param v The constant value. + ShiftMap(const M &m, const C &v) : _m(m), _v(v) {} + /// \e + Value operator[](const Key &k) const { return _m[k]+_v; } }; - ///Shift a map with a constant (ReadWrite version). + /// Shifts a map with a constant (read-write version). - ///This \ref concepts::ReadWriteMap "read-write map" returns the sum of the - ///given map and a constant value. It makes also possible to write the map. - ///Its \c Key and \c Value are inherited from \c M. + /// This \ref concepts::ReadWriteMap "read-write map" returns the sum + /// of the given map and a constant value (i.e. it shifts the map with + /// the constant). Its \c Key and \c Value are inherited from \c M. + /// It makes also possible to write the map. /// - ///\sa ShiftMap - template + /// The simplest way of using this map is through the shiftWriteMap() + /// function. + /// + /// \sa ShiftMap + template class ShiftWriteMap : public MapBase { - M& m; - C v; + M &_m; + C _v; public: typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; - ///Constructor + /// Constructor - ///Constructor. - ///\param _m is the undelying map. - ///\param _v is the shift value. - ShiftWriteMap(M &_m, const C &_v ) : m(_m), v(_v) {}; + /// Constructor. + /// \param m The undelying map. + /// \param v The constant value. + ShiftWriteMap(M &m, const C &v) : _m(m), _v(v) {} /// \e - Value operator[](Key k) const {return m[k] + v;} + Value operator[](const Key &k) const { return _m[k]+_v; } /// \e - void set(Key k, const Value& c) { m.set(k, c - v); } + void set(const Key &k, const Value &v) { _m.set(k, v-_v); } }; - - ///Returns a \c ShiftMap class - ///This function just returns a \c ShiftMap class. - ///\relates ShiftMap - template - inline ShiftMap shiftMap(const M &m,const C &v) { + /// Returns a \ref ShiftMap class + + /// This function just returns a \ref ShiftMap class. + /// + /// For example, if \c m is a map with \c double values and \c v is + /// \c double, then shiftMap(m,v)[x] will be equal to + /// m[x]+v. + /// + /// \relates ShiftMap + template + inline ShiftMap shiftMap(const M &m, const C &v) { return ShiftMap(m,v); } - ///Returns a \c ShiftWriteMap class + /// Returns a \ref ShiftWriteMap class - ///This function just returns a \c ShiftWriteMap class. - ///\relates ShiftWriteMap - template - inline ShiftWriteMap shiftMap(M &m,const C &v) { + /// This function just returns a \ref ShiftWriteMap class. + /// + /// For example, if \c m is a map with \c double values and \c v is + /// \c double, then shiftWriteMap(m,v)[x] will be equal to + /// m[x]+v. + /// Moreover it makes also possible to write the map. + /// + /// \relates ShiftWriteMap + template + inline ShiftWriteMap shiftWriteMap(M &m, const C &v) { return ShiftWriteMap(m,v); } - ///Difference of two maps - ///This \ref concepts::ReadMap "read only map" returns the difference - ///of the values of the two given maps. - ///Its \c Key and \c Value are inherited from \c M1. - ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1. + /// Scales a map with a constant. + + /// This \ref concepts::ReadMap "read only map" returns the value of + /// the given map multiplied from the left side with a constant value. + /// Its \c Key and \c Value are inherited from \c M. /// - /// \todo Revise the misleading name - template - class SubMap : public MapBase { - const M1& m1; - const M2& m2; - public: - typedef MapBase Parent; - typedef typename Parent::Key Key; - typedef typename Parent::Value Value; - - ///Constructor - SubMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {}; - /// \e - Value operator[](Key k) const {return m1[k]-m2[k];} - }; - - ///Returns a \c SubMap class - - ///This function just returns a \c SubMap class. + /// Actually, + /// \code + /// ScaleMap sc(m,v); + /// \endcode + /// is equivalent to + /// \code + /// ConstMap cm(v); + /// MulMap, M> sc(cm,m); + /// \endcode /// - ///\relates SubMap - template - inline SubMap subMap(const M1 &m1, const M2 &m2) { - return SubMap(m1, m2); - } - - ///Product of two maps - - ///This \ref concepts::ReadMap "read only map" returns the product of the - ///values of the two given maps. - ///Its \c Key and \c Value are inherited from \c M1. - ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1. - template - class MulMap : public MapBase { - const M1& m1; - const M2& m2; - public: - typedef MapBase Parent; - typedef typename Parent::Key Key; - typedef typename Parent::Value Value; - - ///Constructor - MulMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {}; - /// \e - Value operator[](Key k) const {return m1[k]*m2[k];} - }; - - ///Returns a \c MulMap class - - ///This function just returns a \c MulMap class. - ///\relates MulMap - template - inline MulMap mulMap(const M1 &m1,const M2 &m2) { - return MulMap(m1,m2); - } - - ///Scales a map with a constant. - - ///This \ref concepts::ReadMap "read only map" returns the value of the - ///given map multiplied from the left side with a constant value. - ///Its \c Key and \c Value are inherited from \c M. + /// The simplest way of using this map is through the scaleMap() + /// function. /// - ///Actually, - ///\code - /// ScaleMap sc(x,v); - ///\endcode - ///is equivalent to - ///\code - /// ConstMap c_tmp(v); - /// MulMap > sc(x,v); - ///\endcode - /// - ///\sa ScaleWriteMap - template + /// \sa ScaleWriteMap + template class ScaleMap : public MapBase { - const M& m; - C v; + const M &_m; + C _v; public: typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; - ///Constructor + /// Constructor - ///Constructor. - ///\param _m is the undelying map. - ///\param _v is the scaling value. - ScaleMap(const M &_m, const C &_v ) : m(_m), v(_v) {}; + /// Constructor. + /// \param m The undelying map. + /// \param v The constant value. + ScaleMap(const M &m, const C &v) : _m(m), _v(v) {} /// \e - Value operator[](Key k) const {return v * m[k];} + Value operator[](const Key &k) const { return _v*_m[k]; } }; - ///Scales a map with a constant (ReadWrite version). + /// Scales a map with a constant (read-write version). - ///This \ref concepts::ReadWriteMap "read-write map" returns the value of the - ///given map multiplied from the left side with a constant value. It can - ///also be used as write map if the \c / operator is defined between - ///\c Value and \c C and the given multiplier is not zero. - ///Its \c Key and \c Value are inherited from \c M. + /// This \ref concepts::ReadWriteMap "read-write map" returns the value of + /// the given map multiplied from the left side with a constant value. + /// Its \c Key and \c Value are inherited from \c M. + /// It can also be used as write map if the \c / operator is defined + /// between \c Value and \c C and the given multiplier is not zero. /// - ///\sa ScaleMap - template + /// The simplest way of using this map is through the scaleWriteMap() + /// function. + /// + /// \sa ScaleMap + template class ScaleWriteMap : public MapBase { - M& m; - C v; + M &_m; + C _v; public: typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; - ///Constructor + /// Constructor - ///Constructor. - ///\param _m is the undelying map. - ///\param _v is the scaling value. - ScaleWriteMap(M &_m, const C &_v ) : m(_m), v(_v) {}; + /// Constructor. + /// \param m The undelying map. + /// \param v The constant value. + ScaleWriteMap(M &m, const C &v) : _m(m), _v(v) {} /// \e - Value operator[](Key k) const {return v * m[k];} + Value operator[](const Key &k) const { return _v*_m[k]; } /// \e - void set(Key k, const Value& c) { m.set(k, c / v);} + void set(const Key &k, const Value &v) { _m.set(k, v/_v); } }; - - ///Returns a \c ScaleMap class - ///This function just returns a \c ScaleMap class. - ///\relates ScaleMap - template - inline ScaleMap scaleMap(const M &m,const C &v) { + /// Returns a \ref ScaleMap class + + /// This function just returns a \ref ScaleMap class. + /// + /// For example, if \c m is a map with \c double values and \c v is + /// \c double, then scaleMap(m,v)[x] will be equal to + /// v*m[x]. + /// + /// \relates ScaleMap + template + inline ScaleMap scaleMap(const M &m, const C &v) { return ScaleMap(m,v); } - ///Returns a \c ScaleWriteMap class + /// Returns a \ref ScaleWriteMap class - ///This function just returns a \c ScaleWriteMap class. - ///\relates ScaleWriteMap - template - inline ScaleWriteMap scaleMap(M &m,const C &v) { + /// This function just returns a \ref ScaleWriteMap class. + /// + /// For example, if \c m is a map with \c double values and \c v is + /// \c double, then scaleWriteMap(m,v)[x] will be equal to + /// v*m[x]. + /// Moreover it makes also possible to write the map. + /// + /// \relates ScaleWriteMap + template + inline ScaleWriteMap scaleWriteMap(M &m, const C &v) { return ScaleWriteMap(m,v); } - ///Quotient of two maps - ///This \ref concepts::ReadMap "read only map" returns the quotient of the - ///values of the two given maps. - ///Its \c Key and \c Value are inherited from \c M1. - ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1. - template - class DivMap : public MapBase { - const M1& m1; - const M2& m2; - public: - typedef MapBase Parent; - typedef typename Parent::Key Key; - typedef typename Parent::Value Value; + /// Negative of a map - ///Constructor - DivMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {}; - /// \e - Value operator[](Key k) const {return m1[k]/m2[k];} - }; - - ///Returns a \c DivMap class - - ///This function just returns a \c DivMap class. - ///\relates DivMap - template - inline DivMap divMap(const M1 &m1,const M2 &m2) { - return DivMap(m1,m2); - } - - ///Composition of two maps - - ///This \ref concepts::ReadMap "read only map" returns the composition of - ///two given maps. - ///That is to say, if \c m1 is of type \c M1 and \c m2 is of \c M2, - ///then for - ///\code - /// ComposeMap cm(m1,m2); - ///\endcode - /// cm[x] will be equal to m1[m2[x]]. + /// This \ref concepts::ReadMap "read only map" returns the negative + /// of the values of the given map (using the unary \c - operator). + /// Its \c Key and \c Value are inherited from \c M. /// - ///Its \c Key is inherited from \c M2 and its \c Value is from \c M1. - ///\c M2::Value must be convertible to \c M1::Key. + /// If M::Value is \c int, \c double etc., then + /// \code + /// NegMap neg(m); + /// \endcode + /// is equivalent to + /// \code + /// ScaleMap neg(m,-1); + /// \endcode /// - ///\sa CombineMap + /// The simplest way of using this map is through the negMap() + /// function. /// - ///\todo Check the requirements. - template - class ComposeMap : public MapBase { - const M1& m1; - const M2& m2; - public: - typedef MapBase Parent; - typedef typename Parent::Key Key; - typedef typename Parent::Value Value; - - ///Constructor - ComposeMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {}; - - /// \e - - - /// \todo Use the MapTraits once it is ported. - /// - - //typename MapTraits::ConstReturnValue - typename M1::Value - operator[](Key k) const {return m1[m2[k]];} - }; - - ///Returns a \c ComposeMap class - - ///This function just returns a \c ComposeMap class. - ///\relates ComposeMap - template - inline ComposeMap composeMap(const M1 &m1,const M2 &m2) { - return ComposeMap(m1,m2); - } - - ///Combine of two maps using an STL (binary) functor. - - ///Combine of two maps using an STL (binary) functor. - /// - ///This \ref concepts::ReadMap "read only map" takes two maps and a - ///binary functor and returns the composition of the two - ///given maps unsing the functor. - ///That is to say, if \c m1 and \c m2 is of type \c M1 and \c M2 - ///and \c f is of \c F, then for - ///\code - /// CombineMap cm(m1,m2,f); - ///\endcode - /// cm[x] will be equal to f(m1[x],m2[x]) - /// - ///Its \c Key is inherited from \c M1 and its \c Value is \c V. - ///\c M2::Value and \c M1::Value must be convertible to the corresponding - ///input parameter of \c F and the return type of \c F must be convertible - ///to \c V. - /// - ///\sa ComposeMap - /// - ///\todo Check the requirements. - template - class CombineMap : public MapBase { - const M1& m1; - const M2& m2; - F f; - public: - typedef MapBase Parent; - typedef typename Parent::Key Key; - typedef typename Parent::Value Value; - - ///Constructor - CombineMap(const M1 &_m1,const M2 &_m2,const F &_f = F()) - : m1(_m1), m2(_m2), f(_f) {}; - /// \e - Value operator[](Key k) const {return f(m1[k],m2[k]);} - }; - - ///Returns a \c CombineMap class - - ///This function just returns a \c CombineMap class. - /// - ///For example if \c m1 and \c m2 are both \c double valued maps, then - ///\code - ///combineMap(m1,m2,std::plus()) - ///\endcode - ///is equivalent to - ///\code - ///addMap(m1,m2) - ///\endcode - /// - ///This function is specialized for adaptable binary function - ///classes and C++ functions. - /// - ///\relates CombineMap - template - inline CombineMap - combineMap(const M1& m1,const M2& m2, const F& f) { - return CombineMap(m1,m2,f); - } - - template - inline CombineMap - combineMap(const M1& m1, const M2& m2, const F& f) { - return combineMap(m1,m2,f); - } - - template - inline CombineMap - combineMap(const M1 &m1, const M2 &m2, V (*f)(K1, K2)) { - return combineMap(m1,m2,f); - } - - ///Negative value of a map - - ///This \ref concepts::ReadMap "read only map" returns the negative - ///value of the value returned by the given map. - ///Its \c Key and \c Value are inherited from \c M. - ///The unary \c - operator must be defined for \c Value, of course. - /// - ///\sa NegWriteMap - template + /// \sa NegWriteMap + template class NegMap : public MapBase { - const M& m; + const M& _m; public: typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; - ///Constructor - NegMap(const M &_m) : m(_m) {}; + /// Constructor + NegMap(const M &m) : _m(m) {} /// \e - Value operator[](Key k) const {return -m[k];} + Value operator[](const Key &k) const { return -_m[k]; } }; - - ///Negative value of a map (ReadWrite version) - ///This \ref concepts::ReadWriteMap "read-write map" returns the negative - ///value of the value returned by the given map. - ///Its \c Key and \c Value are inherited from \c M. - ///The unary \c - operator must be defined for \c Value, of course. + /// Negative of a map (read-write version) + + /// This \ref concepts::ReadWriteMap "read-write map" returns the + /// negative of the values of the given map (using the unary \c - + /// operator). + /// Its \c Key and \c Value are inherited from \c M. + /// It makes also possible to write the map. + /// + /// If M::Value is \c int, \c double etc., then + /// \code + /// NegWriteMap neg(m); + /// \endcode + /// is equivalent to + /// \code + /// ScaleWriteMap neg(m,-1); + /// \endcode + /// + /// The simplest way of using this map is through the negWriteMap() + /// function. /// /// \sa NegMap - template + template class NegWriteMap : public MapBase { - M& m; + M &_m; public: typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; - ///Constructor - NegWriteMap(M &_m) : m(_m) {}; + /// Constructor + NegWriteMap(M &m) : _m(m) {} /// \e - Value operator[](Key k) const {return -m[k];} + Value operator[](const Key &k) const { return -_m[k]; } /// \e - void set(Key k, const Value& v) { m.set(k, -v); } + void set(const Key &k, const Value &v) { _m.set(k, -v); } }; - ///Returns a \c NegMap class + /// Returns a \ref NegMap class - ///This function just returns a \c NegMap class. - ///\relates NegMap - template + /// This function just returns a \ref NegMap class. + /// + /// For example, if \c m is a map with \c double values, then + /// negMap(m)[x] will be equal to -m[x]. + /// + /// \relates NegMap + template inline NegMap negMap(const M &m) { return NegMap(m); } - ///Returns a \c NegWriteMap class + /// Returns a \ref NegWriteMap class - ///This function just returns a \c NegWriteMap class. - ///\relates NegWriteMap - template - inline NegWriteMap negMap(M &m) { + /// This function just returns a \ref NegWriteMap class. + /// + /// For example, if \c m is a map with \c double values, then + /// negWriteMap(m)[x] will be equal to -m[x]. + /// Moreover it makes also possible to write the map. + /// + /// \relates NegWriteMap + template + inline NegWriteMap negWriteMap(M &m) { return NegWriteMap(m); } - ///Absolute value of a map - ///This \ref concepts::ReadMap "read only map" returns the absolute value - ///of the value returned by the given map. - ///Its \c Key and \c Value are inherited from \c M. - ///\c Value must be comparable to \c 0 and the unary \c - - ///operator must be defined for it, of course. - template + /// Absolute value of a map + + /// This \ref concepts::ReadMap "read only map" returns the absolute + /// value of the values of the given map. + /// Its \c Key and \c Value are inherited from \c M. + /// \c Value must be comparable to \c 0 and the unary \c - + /// operator must be defined for it, of course. + /// + /// The simplest way of using this map is through the absMap() + /// function. + template class AbsMap : public MapBase { - const M& m; + const M &_m; public: typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; - ///Constructor - AbsMap(const M &_m) : m(_m) {}; + /// Constructor + AbsMap(const M &m) : _m(m) {} /// \e - Value operator[](Key k) const { - Value tmp = m[k]; + Value operator[](const Key &k) const { + Value tmp = _m[k]; return tmp >= 0 ? tmp : -tmp; } }; - - ///Returns an \c AbsMap class - ///This function just returns an \c AbsMap class. - ///\relates AbsMap - template + /// Returns an \ref AbsMap class + + /// This function just returns an \ref AbsMap class. + /// + /// For example, if \c m is a map with \c double values, then + /// absMap(m)[x] will be equal to m[x] if + /// it is positive or zero and -m[x] if m[x] is + /// negative. + /// + /// \relates AbsMap + template inline AbsMap absMap(const M &m) { return AbsMap(m); } - ///Converts an STL style functor to a map - ///This \ref concepts::ReadMap "read only map" returns the value - ///of a given functor. + /// Logical 'not' of a map + + /// This \ref concepts::ReadMap "read only map" returns the logical + /// negation of the values of the given map. + /// Its \c Key is inherited from \c M and its \c Value is \c bool. /// - ///Template parameters \c K and \c V will become its - ///\c Key and \c Value. - ///In most cases they have to be given explicitly because a - ///functor typically does not provide \c argument_type and - ///\c result_type typedefs. + /// The simplest way of using this map is through the notMap() + /// function. /// - ///Parameter \c F is the type of the used functor. - /// - ///\sa MapFunctor - template - class FunctorMap : public MapBase { - F f; - public: - typedef MapBase Parent; - typedef typename Parent::Key Key; - typedef typename Parent::Value Value; - - ///Constructor - FunctorMap(const F &_f = F()) : f(_f) {} - /// \e - Value operator[](Key k) const { return f(k);} - }; - - ///Returns a \c FunctorMap class - - ///This function just returns a \c FunctorMap class. - /// - ///This function is specialized for adaptable binary function - ///classes and C++ functions. - /// - ///\relates FunctorMap - template inline - FunctorMap functorMap(const F &f) { - return FunctorMap(f); - } - - template inline - FunctorMap - functorMap(const F &f) { - return FunctorMap(f); - } - - template inline - FunctorMap functorMap(V (*f)(K)) { - return FunctorMap(f); - } - - - ///Converts a map to an STL style (unary) functor - - ///This class Converts a map to an STL style (unary) functor. - ///That is it provides an operator() to read its values. - /// - ///For the sake of convenience it also works as - ///a ususal \ref concepts::ReadMap "readable map", - ///i.e. operator[] and the \c Key and \c Value typedefs also exist. - /// - ///\sa FunctorMap - template - class MapFunctor : public MapBase { - const M& m; - public: - typedef MapBase Parent; - typedef typename Parent::Key Key; - typedef typename Parent::Value Value; - - typedef typename M::Key argument_type; - typedef typename M::Value result_type; - - ///Constructor - MapFunctor(const M &_m) : m(_m) {}; - ///\e - Value operator()(Key k) const {return m[k];} - ///\e - Value operator[](Key k) const {return m[k];} - }; - - ///Returns a \c MapFunctor class - - ///This function just returns a \c MapFunctor class. - ///\relates MapFunctor - template - inline MapFunctor mapFunctor(const M &m) { - return MapFunctor(m); - } - - ///Just readable version of \ref ForkWriteMap - - ///This map has two \ref concepts::ReadMap "readable map" - ///parameters and each read request will be passed just to the - ///first map. This class is the just readable map type of \c ForkWriteMap. - /// - ///The \c Key and \c Value are inherited from \c M1. - ///The \c Key and \c Value of \c M2 must be convertible from those of \c M1. - /// - ///\sa ForkWriteMap - /// - /// \todo Why is it needed? - template - class ForkMap : public MapBase { - const M1& m1; - const M2& m2; - public: - typedef MapBase Parent; - typedef typename Parent::Key Key; - typedef typename Parent::Value Value; - - ///Constructor - ForkMap(const M1 &_m1, const M2 &_m2) : m1(_m1), m2(_m2) {}; - /// \e - Value operator[](Key k) const {return m1[k];} - }; - - - ///Applies all map setting operations to two maps - - ///This map has two \ref concepts::WriteMap "writable map" - ///parameters and each write request will be passed to both of them. - ///If \c M1 is also \ref concepts::ReadMap "readable", - ///then the read operations will return the - ///corresponding values of \c M1. - /// - ///The \c Key and \c Value are inherited from \c M1. - ///The \c Key and \c Value of \c M2 must be convertible from those of \c M1. - /// - ///\sa ForkMap - template - class ForkWriteMap : public MapBase { - M1& m1; - M2& m2; - public: - typedef MapBase Parent; - typedef typename Parent::Key Key; - typedef typename Parent::Value Value; - - ///Constructor - ForkWriteMap(M1 &_m1, M2 &_m2) : m1(_m1), m2(_m2) {}; - ///\e - Value operator[](Key k) const {return m1[k];} - ///\e - void set(Key k, const Value &v) {m1.set(k,v); m2.set(k,v);} - }; - - ///Returns a \c ForkMap class - - ///This function just returns a \c ForkMap class. - ///\relates ForkMap - template - inline ForkMap forkMap(const M1 &m1, const M2 &m2) { - return ForkMap(m1,m2); - } - - ///Returns a \c ForkWriteMap class - - ///This function just returns a \c ForkWriteMap class. - ///\relates ForkWriteMap - template - inline ForkWriteMap forkMap(M1 &m1, M2 &m2) { - return ForkWriteMap(m1,m2); - } - - - - /* ************* BOOL MAPS ******************* */ - - ///Logical 'not' of a map - - ///This bool \ref concepts::ReadMap "read only map" returns the - ///logical negation of the value returned by the given map. - ///Its \c Key is inherited from \c M, its \c Value is \c bool. - /// - ///\sa NotWriteMap - template + /// \sa NotWriteMap + template class NotMap : public MapBase { - const M& m; + const M &_m; public: typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; /// Constructor - NotMap(const M &_m) : m(_m) {}; - ///\e - Value operator[](Key k) const {return !m[k];} + NotMap(const M &m) : _m(m) {} + /// \e + Value operator[](const Key &k) const { return !_m[k]; } }; - ///Logical 'not' of a map (ReadWrie version) - - ///This bool \ref concepts::ReadWriteMap "read-write map" returns the - ///logical negation of the value returned by the given map. When it is set, - ///the opposite value is set to the original map. - ///Its \c Key is inherited from \c M, its \c Value is \c bool. + /// Logical 'not' of a map (read-write version) + + /// This \ref concepts::ReadWriteMap "read-write map" returns the + /// logical negation of the values of the given map. + /// Its \c Key is inherited from \c M and its \c Value is \c bool. + /// It makes also possible to write the map. When a value is set, + /// the opposite value is set to the original map. /// - ///\sa NotMap - template + /// The simplest way of using this map is through the notWriteMap() + /// function. + /// + /// \sa NotMap + template class NotWriteMap : public MapBase { - M& m; + M &_m; public: typedef MapBase Parent; typedef typename Parent::Key Key; typedef typename Parent::Value Value; /// Constructor - NotWriteMap(M &_m) : m(_m) {}; - ///\e - Value operator[](Key k) const {return !m[k];} - ///\e - void set(Key k, bool v) { m.set(k, !v); } + NotWriteMap(M &m) : _m(m) {} + /// \e + Value operator[](const Key &k) const { return !_m[k]; } + /// \e + void set(const Key &k, bool v) { _m.set(k, !v); } }; - - ///Returns a \c NotMap class - - ///This function just returns a \c NotMap class. - ///\relates NotMap - template + + /// Returns a \ref NotMap class + + /// This function just returns a \ref NotMap class. + /// + /// For example, if \c m is a map with \c bool values, then + /// notMap(m)[x] will be equal to !m[x]. + /// + /// \relates NotMap + template inline NotMap notMap(const M &m) { return NotMap(m); } - - ///Returns a \c NotWriteMap class - - ///This function just returns a \c NotWriteMap class. - ///\relates NotWriteMap - template - inline NotWriteMap notMap(M &m) { + + /// Returns a \ref NotWriteMap class + + /// This function just returns a \ref NotWriteMap class. + /// + /// For example, if \c m is a map with \c bool values, then + /// notWriteMap(m)[x] will be equal to !m[x]. + /// Moreover it makes also possible to write the map. + /// + /// \relates NotWriteMap + template + inline NotWriteMap notWriteMap(M &m) { return NotWriteMap(m); } + namespace _maps_bits { template @@ -1276,44 +1482,44 @@ template struct IteratorTraits<_Iterator, - typename exists::type> + typename exists::type> { typedef typename _Iterator::container_type::value_type Value; }; } - + /// \brief Writable bool map for logging each \c true assigned element /// - /// A \ref concepts::ReadWriteMap "read-write" bool map for logging - /// each \c true assigned element, i.e it copies all the keys set + /// A \ref concepts::ReadWriteMap "read-write" bool map for logging + /// each \c true assigned element, i.e it copies all the keys set /// to \c true to the given iterator. /// - /// \note The container of the iterator should contain space + /// \note The container of the iterator should contain space /// for each element. /// - /// The following example shows how you can write the edges found by + /// The following example shows how you can write the edges found by /// the \ref Prim algorithm directly to the standard output. - ///\code - /// typedef IdMap EdgeIdMap; - /// EdgeIdMap edgeId(graph); + /// \code + /// typedef IdMap EdgeIdMap; + /// EdgeIdMap edgeId(graph); /// - /// typedef MapFunctor EdgeIdFunctor; - /// EdgeIdFunctor edgeIdFunctor(edgeId); + /// typedef MapToFunctor EdgeIdFunctor; + /// EdgeIdFunctor edgeIdFunctor(edgeId); /// - /// StoreBoolMap, EdgeIdFunctor> - /// writerMap(ostream_iterator(cout, " "), edgeIdFunctor); + /// StoreBoolMap, EdgeIdFunctor> + /// writerMap(ostream_iterator(cout, " "), edgeIdFunctor); /// - /// prim(graph, cost, writerMap); - ///\endcode + /// prim(graph, cost, writerMap); + /// \endcode /// - ///\sa BackInserterBoolMap - ///\sa FrontInserterBoolMap - ///\sa InserterBoolMap + /// \sa BackInserterBoolMap + /// \sa FrontInserterBoolMap + /// \sa InserterBoolMap /// - ///\todo Revise the name of this class and the related ones. - template ::Value> > @@ -1327,33 +1533,33 @@ typedef _Functor Functor; /// Constructor - StoreBoolMap(Iterator it, const Functor& functor = Functor()) + StoreBoolMap(Iterator it, const Functor& functor = Functor()) : _begin(it), _end(it), _functor(functor) {} /// Gives back the given iterator set for the first key Iterator begin() const { return _begin; } - + /// Gives back the the 'after the last' iterator Iterator end() const { return _end; } - /// The \c set function of the map + /// The set function of the map void set(const Key& key, Value value) const { if (value) { *_end++ = _functor(key); } } - + private: Iterator _begin; mutable Iterator _end; Functor _functor; }; - /// \brief Writable bool map for logging each \c true assigned element in + /// \brief Writable bool map for logging each \c true assigned element in /// a back insertable container. /// /// Writable bool map for logging each \c true assigned element by pushing @@ -1362,15 +1568,15 @@ /// container. The next example shows how you can store the /// edges found by the Prim algorithm in a vector. /// - ///\code - /// vector span_tree_edges; - /// BackInserterBoolMap > inserter_map(span_tree_edges); - /// prim(graph, cost, inserter_map); - ///\endcode + /// \code + /// vector span_tree_edges; + /// BackInserterBoolMap > inserter_map(span_tree_edges); + /// prim(graph, cost, inserter_map); + /// \endcode /// - ///\sa StoreBoolMap - ///\sa FrontInserterBoolMap - ///\sa InserterBoolMap + /// \sa StoreBoolMap + /// \sa FrontInserterBoolMap + /// \sa InserterBoolMap template > @@ -1380,23 +1586,23 @@ typedef bool Value; /// Constructor - BackInserterBoolMap(Container& _container, - const Functor& _functor = Functor()) + BackInserterBoolMap(Container& _container, + const Functor& _functor = Functor()) : container(_container), functor(_functor) {} - /// The \c set function of the map + /// The set function of the map void set(const Key& key, Value value) { if (value) { container.push_back(functor(key)); } } - + private: Container& container; Functor functor; }; - /// \brief Writable bool map for logging each \c true assigned element in + /// \brief Writable bool map for logging each \c true assigned element in /// a front insertable container. /// /// Writable bool map for logging each \c true assigned element by pushing @@ -1404,8 +1610,8 @@ /// It can be used to retrieve the items into a standard /// container. For example see \ref BackInserterBoolMap. /// - ///\sa BackInserterBoolMap - ///\sa InserterBoolMap + /// \sa BackInserterBoolMap + /// \sa InserterBoolMap template > @@ -1416,39 +1622,39 @@ /// Constructor FrontInserterBoolMap(Container& _container, - const Functor& _functor = Functor()) + const Functor& _functor = Functor()) : container(_container), functor(_functor) {} - /// The \c set function of the map + /// The set function of the map void set(const Key& key, Value value) { if (value) { container.push_front(functor(key)); } } - + private: - Container& container; + Container& container; Functor functor; }; - /// \brief Writable bool map for storing each \c true assigned element in + /// \brief Writable bool map for storing each \c true assigned element in /// an insertable container. /// - /// Writable bool map for storing each \c true assigned element in an + /// Writable bool map for storing each \c true assigned element in an /// insertable container. It will insert all the keys set to \c true into /// the container. /// /// For example, if you want to store the cut arcs of the strongly /// connected components in a set you can use the next code: /// - ///\code - /// set cut_arcs; - /// InserterBoolMap > inserter_map(cut_arcs); - /// stronglyConnectedCutArcs(digraph, cost, inserter_map); - ///\endcode + /// \code + /// set cut_arcs; + /// InserterBoolMap > inserter_map(cut_arcs); + /// stronglyConnectedCutArcs(digraph, cost, inserter_map); + /// \endcode /// - ///\sa BackInserterBoolMap - ///\sa FrontInserterBoolMap + /// \sa BackInserterBoolMap + /// \sa FrontInserterBoolMap template > @@ -1458,13 +1664,13 @@ typedef bool Value; /// Constructor with specified iterator - + /// Constructor with specified iterator. /// \param _container The container for storing the elements. /// \param _it The elements will be inserted before this iterator. /// \param _functor The functor that is used when an element is stored. InserterBoolMap(Container& _container, typename Container::iterator _it, - const Functor& _functor = Functor()) + const Functor& _functor = Functor()) : container(_container), it(_it), functor(_functor) {} /// Constructor @@ -1476,45 +1682,45 @@ InserterBoolMap(Container& _container, const Functor& _functor = Functor()) : container(_container), it(_container.end()), functor(_functor) {} - /// The \c set function of the map + /// The set function of the map void set(const Key& key, Value value) { if (value) { it = container.insert(it, functor(key)); ++it; } } - + private: Container& container; typename Container::iterator it; Functor functor; }; - /// \brief Writable bool map for filling each \c true assigned element with a + /// \brief Writable bool map for filling each \c true assigned element with a /// given value. /// - /// Writable bool map for filling each \c true assigned element with a + /// Writable bool map for filling each \c true assigned element with a /// given value. The value can set the container. /// /// The following code finds the connected components of a graph /// and stores it in the \c comp map: - ///\code - /// typedef Graph::NodeMap ComponentMap; - /// ComponentMap comp(graph); - /// typedef FillBoolMap > ComponentFillerMap; - /// ComponentFillerMap filler(comp, 0); + /// \code + /// typedef Graph::NodeMap ComponentMap; + /// ComponentMap comp(graph); + /// typedef FillBoolMap > ComponentFillerMap; + /// ComponentFillerMap filler(comp, 0); /// - /// Dfs::DefProcessedMap::Create dfs(graph); - /// dfs.processedMap(filler); - /// dfs.init(); - /// for (NodeIt it(graph); it != INVALID; ++it) { - /// if (!dfs.reached(it)) { - /// dfs.addSource(it); - /// dfs.start(); - /// ++filler.fillValue(); + /// Dfs::DefProcessedMap::Create dfs(graph); + /// dfs.processedMap(filler); + /// dfs.init(); + /// for (NodeIt it(graph); it != INVALID; ++it) { + /// if (!dfs.reached(it)) { + /// dfs.addSource(it); + /// dfs.start(); + /// ++filler.fillValue(); + /// } /// } - /// } - ///\endcode + /// \endcode template class FillBoolMap { public: @@ -1522,90 +1728,90 @@ typedef bool Value; /// Constructor - FillBoolMap(Map& _map, const typename Map::Value& _fill) + FillBoolMap(Map& _map, const typename Map::Value& _fill) : map(_map), fill(_fill) {} /// Constructor - FillBoolMap(Map& _map) + FillBoolMap(Map& _map) : map(_map), fill() {} /// Gives back the current fill value const typename Map::Value& fillValue() const { return fill; - } + } /// Gives back the current fill value typename Map::Value& fillValue() { return fill; - } + } /// Sets the current fill value void fillValue(const typename Map::Value& _fill) { fill = _fill; - } + } - /// The \c set function of the map + /// The set function of the map void set(const Key& key, Value value) { if (value) { map.set(key, fill); } } - + private: Map& map; typename Map::Value fill; }; - /// \brief Writable bool map for storing the sequence number of - /// \c true assignments. - /// - /// Writable bool map that stores for each \c true assigned elements + /// \brief Writable bool map for storing the sequence number of + /// \c true assignments. + /// + /// Writable bool map that stores for each \c true assigned elements /// the sequence number of this setting. /// It makes it easy to calculate the leaving - /// order of the nodes in the \c Dfs algorithm. + /// order of the nodes in the \ref Dfs algorithm. /// - ///\code - /// typedef Digraph::NodeMap OrderMap; - /// OrderMap order(digraph); - /// typedef SettingOrderBoolMap OrderSetterMap; - /// OrderSetterMap setter(order); - /// Dfs::DefProcessedMap::Create dfs(digraph); - /// dfs.processedMap(setter); - /// dfs.init(); - /// for (NodeIt it(digraph); it != INVALID; ++it) { - /// if (!dfs.reached(it)) { - /// dfs.addSource(it); - /// dfs.start(); + /// \code + /// typedef Digraph::NodeMap OrderMap; + /// OrderMap order(digraph); + /// typedef SettingOrderBoolMap OrderSetterMap; + /// OrderSetterMap setter(order); + /// Dfs::DefProcessedMap::Create dfs(digraph); + /// dfs.processedMap(setter); + /// dfs.init(); + /// for (NodeIt it(digraph); it != INVALID; ++it) { + /// if (!dfs.reached(it)) { + /// dfs.addSource(it); + /// dfs.start(); + /// } /// } - /// } - ///\endcode + /// \endcode /// /// The storing of the discovering order is more difficult because the /// ReachedMap should be readable in the dfs algorithm but the setting /// order map is not readable. Thus we must use the fork map: /// - ///\code - /// typedef Digraph::NodeMap OrderMap; - /// OrderMap order(digraph); - /// typedef SettingOrderBoolMap OrderSetterMap; - /// OrderSetterMap setter(order); - /// typedef Digraph::NodeMap StoreMap; - /// StoreMap store(digraph); + /// \code + /// typedef Digraph::NodeMap OrderMap; + /// OrderMap order(digraph); + /// typedef SettingOrderBoolMap OrderSetterMap; + /// OrderSetterMap setter(order); + /// typedef Digraph::NodeMap StoreMap; + /// StoreMap store(digraph); /// - /// typedef ForkWriteMap ReachedMap; - /// ReachedMap reached(store, setter); + /// typedef ForkMap ReachedMap; + /// ReachedMap reached(store, setter); /// - /// Dfs::DefReachedMap::Create dfs(digraph); - /// dfs.reachedMap(reached); - /// dfs.init(); - /// for (NodeIt it(digraph); it != INVALID; ++it) { - /// if (!dfs.reached(it)) { - /// dfs.addSource(it); - /// dfs.start(); + /// Dfs::DefReachedMap::Create dfs(digraph); + /// dfs.reachedMap(reached); + /// dfs.init(); + /// for (NodeIt it(digraph); it != INVALID; ++it) { + /// if (!dfs.reached(it)) { + /// dfs.addSource(it); + /// dfs.start(); + /// } /// } - /// } - ///\endcode + /// \endcode template class SettingOrderBoolMap { public: @@ -1613,7 +1819,7 @@ typedef bool Value; /// Constructor - SettingOrderBoolMap(Map& _map) + SettingOrderBoolMap(Map& _map) : map(_map), counter(0) {} /// Number of set operations. @@ -1621,13 +1827,13 @@ return counter; } - /// The \c set function of the map + /// The set function of the map void set(const Key& key, Value value) { if (value) { map.set(key, counter++); } } - + private: Map& map; int counter; diff -r d73c2e8b25cb -r 15968e25ca08 test/maps_test.cc --- a/test/maps_test.cc Sat Mar 15 20:21:21 2008 +0100 +++ b/test/maps_test.cc Sat Mar 15 21:07:24 2008 +0100 @@ -37,72 +37,232 @@ typedef A argument_type; typedef B result_type; - B operator()(const A &) const {return B();} + B operator()(const A&) const { return B(); } +private: + F& operator=(const F&); }; -int func(A) {return 3;} +int func(A) { return 3; } -int binc(int, B) {return 4;} +int binc(int a, B) { return a+1; } -typedef ReadMap DoubleMap; -typedef ReadWriteMap WriteDoubleMap; +typedef ReadMap DoubleMap; +typedef ReadWriteMap DoubleWriteMap; +typedef ReferenceMap DoubleRefMap; -typedef ReadMap BoolMap; +typedef ReadMap BoolMap; typedef ReadWriteMap BoolWriteMap; +typedef ReferenceMap BoolRefMap; int main() -{ // checking graph components - +{ + // Map concepts checkConcept, ReadMap >(); checkConcept, WriteMap >(); checkConcept, ReadWriteMap >(); checkConcept, ReferenceMap >(); - checkConcept, AddMap >(); - checkConcept, SubMap >(); - checkConcept, MulMap >(); - checkConcept, DivMap >(); - checkConcept, NegMap >(); - checkConcept, NegWriteMap >(); - checkConcept, AbsMap >(); - checkConcept, ShiftMap >(); - checkConcept, ShiftWriteMap >(); - checkConcept, ScaleMap >(); - checkConcept, ScaleWriteMap >(); - checkConcept, ForkMap >(); - checkConcept, - ForkWriteMap >(); + // NullMap + { + checkConcept, NullMap >(); + NullMap map1; + NullMap map2 = map1; + map1 = nullMap(); + } + + // ConstMap + { + checkConcept, ConstMap >(); + ConstMap map1; + ConstMap map2(B()); + ConstMap map3 = map1; + map1 = constMap(B()); + map1.setAll(B()); + + checkConcept, ConstMap >(); + check(constMap(10)[A()] == 10, "Something is wrong with ConstMap"); + + checkConcept, ConstMap > >(); + ConstMap > map4; + ConstMap > map5 = map4; + map4 = map5; + check(map4[A()] == 10 && map5[A()] == 10, "Something is wrong with ConstMap"); + } + + // IdentityMap + { + checkConcept, IdentityMap >(); + IdentityMap map1; + IdentityMap map2 = map1; + map1 = identityMap(); + + checkConcept, IdentityMap >(); + check(identityMap()[1.0] == 1.0 && identityMap()[3.14] == 3.14, + "Something is wrong with IdentityMap"); + } + + // RangeMap + { + checkConcept, RangeMap >(); + RangeMap map1; + RangeMap map2(10); + RangeMap map3(10,B()); + RangeMap map4 = map1; + RangeMap map5 = rangeMap(); + RangeMap map6 = rangeMap(10); + RangeMap map7 = rangeMap(10,B()); + + checkConcept< ReferenceMap, + RangeMap >(); + std::vector v(10, 0); + v[5] = 100; + RangeMap map8(v); + RangeMap map9 = rangeMap(v); + check(map9.size() == 10 && map9[2] == 0 && map9[5] == 100, + "Something is wrong with RangeMap"); + } + + // SparseMap + { + checkConcept, SparseMap >(); + SparseMap map1; + SparseMap map2(B()); + SparseMap map3 = sparseMap(); + SparseMap map4 = sparseMap(B()); + + checkConcept< ReferenceMap, + SparseMap >(); + std::map m; + SparseMap map5(m); + SparseMap map6(m,10); + SparseMap map7 = sparseMap(m); + SparseMap map8 = sparseMap(m,10); + + check(map5[1.0] == 0 && map5[3.14] == 0 && map6[1.0] == 10 && map6[3.14] == 10, + "Something is wrong with SparseMap"); + map5[1.0] = map6[3.14] = 100; + check(map5[1.0] == 100 && map5[3.14] == 0 && map6[1.0] == 10 && map6[3.14] == 100, + "Something is wrong with SparseMap"); + } + + // ComposeMap + { + typedef ComposeMap > CompMap; + checkConcept, CompMap>(); + CompMap map1(DoubleMap(),ReadMap()); + CompMap map2 = composeMap(DoubleMap(), ReadMap()); + + SparseMap m1(false); m1[3.14] = true; + RangeMap m2(2); m2[0] = 3.0; m2[1] = 3.14; + check(!composeMap(m1,m2)[0] && composeMap(m1,m2)[1], "Something is wrong with ComposeMap") + } + + // CombineMap + { + typedef CombineMap > CombMap; + checkConcept, CombMap>(); + CombMap map1(DoubleMap(), DoubleMap()); + CombMap map2 = combineMap(DoubleMap(), DoubleMap(), std::plus()); + + check(combineMap(constMap(), identityMap(), &binc)[B()] == 3, + "Something is wrong with CombineMap"); + } + + // FunctorToMap, MapToFunctor + { + checkConcept, FunctorToMap >(); + checkConcept, FunctorToMap >(); + FunctorToMap map1; + FunctorToMap map2(F()); + B b = functorToMap(F())[A()]; + + checkConcept, MapToFunctor > >(); + MapToFunctor > map(ReadMap()); + + check(functorToMap(&func)[A()] == 3, "Something is wrong with FunctorToMap"); + check(mapToFunctor(constMap(2))(A()) == 2, "Something is wrong with MapToFunctor"); + check(mapToFunctor(functorToMap(&func))(A()) == 3 && mapToFunctor(functorToMap(&func))[A()] == 3, + "Something is wrong with FunctorToMap or MapToFunctor"); + check(functorToMap(mapToFunctor(constMap(2)))[A()] == 2, + "Something is wrong with FunctorToMap or MapToFunctor"); + } + + // ConvertMap + { + checkConcept, ConvertMap, double> >(); + ConvertMap, int> map1(rangeMap(1, true)); + ConvertMap, int> map2 = convertMap(rangeMap(2, false)); + } + + // ForkMap + { + checkConcept >(); + + typedef RangeMap RM; + typedef SparseMap SM; + RM m1(10, -1); + SM m2(-1); + checkConcept, ForkMap >(); + checkConcept, ForkMap >(); + ForkMap map1(m1,m2); + ForkMap map2 = forkMap(m2,m1); + map2.set(5, 10); + check(m1[1] == -1 && m1[5] == 10 && m2[1] == -1 && m2[5] == 10 && map2[1] == -1 && map2[5] == 10, + "Something is wrong with ForkMap"); + } - checkConcept, ComposeMap > >(); + // Arithmetic maps: + // - AddMap, SubMap, MulMap, DivMap + // - ShiftMap, ShiftWriteMap, ScaleMap, ScaleWriteMap + // - NegMap, NegWriteMap, AbsMap + { + checkConcept >(); + checkConcept >(); + checkConcept >(); + checkConcept >(); + + ConstMap c1(1.0), c2(3.14); + IdentityMap im; + ConvertMap, double> id(im); + check(addMap(c1,id)[0] == 1.0 && addMap(c1,id)[10] == 11.0, "Something is wrong with AddMap"); + check(subMap(id,c1)[0] == -1.0 && subMap(id,c1)[10] == 9.0, "Something is wrong with SubMap"); + check(mulMap(id,c2)[0] == 0 && mulMap(id,c2)[2] == 6.28, "Something is wrong with MulMap"); + check(divMap(c2,id)[1] == 3.14 && divMap(c2,id)[2] == 1.57, "Something is wrong with DivMap"); + + checkConcept >(); + checkConcept >(); + checkConcept >(); + checkConcept >(); + checkConcept >(); + checkConcept >(); + checkConcept >(); - checkConcept, FunctorMap >(); + check(shiftMap(id, 2.0)[1] == 3.0 && shiftMap(id, 2.0)[10] == 12.0, + "Something is wrong with ShiftMap"); + check(shiftWriteMap(id, 2.0)[1] == 3.0 && shiftWriteMap(id, 2.0)[10] == 12.0, + "Something is wrong with ShiftWriteMap"); + check(scaleMap(id, 2.0)[1] == 2.0 && scaleMap(id, 2.0)[10] == 20.0, + "Something is wrong with ScaleMap"); + check(scaleWriteMap(id, 2.0)[1] == 2.0 && scaleWriteMap(id, 2.0)[10] == 20.0, + "Something is wrong with ScaleWriteMap"); + check(negMap(id)[1] == -1.0 && negMap(id)[-10] == 10.0, + "Something is wrong with NegMap"); + check(negWriteMap(id)[1] == -1.0 && negWriteMap(id)[-10] == 10.0, + "Something is wrong with NegWriteMap"); + check(absMap(id)[1] == 1.0 && absMap(id)[-10] == 10.0, + "Something is wrong with AbsMap"); + } + + // Logical maps + { + checkConcept >(); + checkConcept >(); + + RangeMap rm(2); + rm[0] = true; rm[1] = false; + check(!(notMap(rm)[0]) && notMap(rm)[1], "Something is wrong with NotMap"); + check(!(notWriteMap(rm)[0]) && notWriteMap(rm)[1], "Something is wrong with NotWriteMap"); + } - checkConcept, NotMap >(); - checkConcept, NotWriteMap >(); - - checkConcept, StoreBoolMap >(); - checkConcept, BackInserterBoolMap > >(); - checkConcept, FrontInserterBoolMap > >(); - checkConcept, InserterBoolMap > >(); - checkConcept, FillBoolMap > >(); - checkConcept, SettingOrderBoolMap > >(); - - int a; - - a=mapFunctor(constMap(2))(A()); - check(a==2,"Something is wrong with mapFunctor"); - - B b; - b=functorMap(F())[A()]; - - a=functorMap(&func)[A()]; - check(a==3,"Something is wrong with functorMap"); - - a=combineMap(constMap(), identityMap(), &binc)[B()]; - check(a==4,"Something is wrong with combineMap"); - - - std::cout << __FILE__ ": All tests passed.\n"; - return 0; }