LEMON/LEMON-main Changeset - r29:0cb4ba427bfd

Repositories » LEMON » LEMON-main

Summary
Changelog
Files
Switch To
- loading...
Options
- Lightweight changelog
- Search
Pull Requests

Changeset - r29:0cb4ba427bfd

« 26:61bf7f

30:72364b »

r29:0cb4ba427bfd

Fri, 04 Jan 2008 08:08:50

[Not Reviewed]

0 comments (0 inline)

kpeter (Peter Kovacs)
kpeter@inf.elte.hu

Several doc improvements and fixes in maps.h.

0 1 0

default

1 file changed with 197 insertions and 142 deletions:

lemon/maps.h

197

142

↑ Collapse diff ↑

lemon/maps.h

Show inline comments

@@ -49,15 +49,16 @@
 		    ///\e
 		    typedef T Value;
 		  };
 		  /// Null map. (a.k.a. DoNothingMap)
 		  /// 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 will sent to <tt>/dev/null</tt>...
+		  /// 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
 		  /// <tt>/dev/null</tt>).
 		  template<typename K, typename T>
 		  class NullMap : public MapBase<K, T> {
 		  public:
 		    typedef MapBase<K, T> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
@@ -65,12 +66,16 @@
 		    /// Gives back a default constructed element.
 		    T operator[](const K&) const { return T(); }
 		    /// Absorbs the value.
 		    void set(const K&, const T&) {}
 		  };
 		  ///Returns a \c NullMap class
 		  ///This function just returns a \c NullMap class.
 		  ///\relates NullMap
 		  template <typename K, typename V>
 		  NullMap<K, V> nullMap() {
 		    return NullMap<K, V>();
+		  }
@@ -87,19 +92,21 @@
 		    typedef MapBase<K, T> 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.)
 		    ConstMap() {}
-		    ///\e
 		    /// Constructor with specified initial value
 		    /// \param _v The initial value of the map.
 		    ///
 		    /// 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; }
 		    ///\e
@@ -155,14 +162,14 @@
 		  inline ConstMap<K, Const<V, v> > constMap() {
 		    return ConstMap<K, Const<V, v> >();
+		  }
 		  ///Map based on std::map
 		  ///This is essentially a wrapper for \c std::map. With addition that
 		  ///you can specify a default value different from \c Value() .
 		  ///This is essentially a wrapper for \c std::map with addition that
 		  ///you can specify a default value different from \c Value().
 		  template <typename K, typename T, typename Compare = std::less<K> >
 		  class StdMap {
 		    template <typename K1, typename T1, typename C1>
 		    friend class StdMap;
 		  public:
@@ -318,15 +325,15 @@
 		  /// @}
 		  /// \addtogroup map_adaptors
 		  /// @{
-		  /// \brief Identity mapping.
+		  /// \brief Identity map.
 		  ///
-		  /// This mapping gives back the given key as value without any
+		  /// This map gives back the given key as value without any
 		  /// modification.
 		  template <typename T>
 		  class IdentityMap : public MapBase<T, T> {
 		  public:
 		    typedef MapBase<T, T> Parent;
 		    typedef typename Parent::Key Key;
@@ -349,51 +356,53 @@
 		  ///\brief Convert the \c Value of a map to another type using
 		  ///the default conversion.
 		  ///
 		  ///This \c concepts::ReadMap "read only map"
-		  ///converts the \c Value of a maps to type \c T.
+		  ///converts the \c Value of a map to type \c T.
 		  ///Its \c Key is inherited from \c M.
 		  template <typename M, typename T>
 		  class ConvertMap : public MapBase<typename M::Key, T> {
 		    const M& m;
 		  public:
 		    typedef MapBase<typename M::Key, T> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    ///Constructor
 		    ///\param _m is the underlying map
 		    ///Constructor.
 		    ///\param _m is the underlying map.
 		    ConvertMap(const M &_m) : m(_m) {};
 		    /// \brief The subscript operator.
 		    ///
 		    /// The subscript operator.
 		    Value operator[](const Key& k) const {return m[k];}
 		  };
-		  ///Returns an \c ConvertMap class
+		  ///Returns a \c ConvertMap class
-		  ///This function just returns an \c ConvertMap class.
+		  ///This function just returns a \c ConvertMap class.
 		  ///\relates ConvertMap
 		  template<typename T, typename M>
 		  inline ConvertMap<M, T> convertMap(const M &m) {
 		    return ConvertMap<M, T>(m);
+		  }
-		  ///Simple wrapping of the map
+		  ///Simple wrapping of a map
 		  ///This \c 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.
 		  ///
-		  /// \todo Revise the misleading name
+		  ///\sa SimpleWriteMap
 		  ///
 		  /// \todo Revise the misleading name
 		  template<typename M>
 		  class SimpleMap : public MapBase<typename M::Key, typename M::Value> {
 		    const M& m;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
@@ -403,19 +412,21 @@
 		    ///Constructor
 		    SimpleMap(const M &_m) : m(_m) {};
 		    ///\e
 		    Value operator[](Key k) const {return m[k];}
 		  };
-		  ///Simple writeable wrapping of the map
+		  ///Simple writable wrapping of the map
 		  ///This \c concepts::WriteMap "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.
 		  ///
 		  ///\sa SimpleMap
 		  ///
 		  /// \todo Revise the misleading name
 		  template<typename M>
 		  class SimpleWriteMap : public MapBase<typename M::Key, typename M::Value> {
 		    M& m;
 		  public:
@@ -431,15 +442,15 @@
 		    void set(Key k, const Value& c) { m.set(k, c); }
 		  };
 		  ///Sum of two maps
 		  ///This \c concepts::ReadMap "read only map" returns the sum of the two
-		  ///given maps. Its \c Key and \c Value will be inherited from \c M1.
 		  ///given maps.
 		  ///Its \c Key and \c Value are inherited from \c M1.
 		  ///The \c Key and \c Value of M2 must be convertible to those of \c M1.
 		  template<typename M1, typename M2>
 		  class AddMap : public MapBase<typename M1::Key, typename M1::Value> {
 		    const M1& m1;
 		    const M2& m2;
 		  public:
@@ -465,97 +476,95 @@
+		  }
 		  ///Shift a map with a constant.
 		  ///This \c concepts::ReadMap "read only map" returns the sum of the
 		  ///given map and a constant value.
-		  ///Its \c Key and \c Value is inherited from \c M.
+		  ///Its \c Key and \c Value are inherited from \c M.
 		  ///
 		  ///Actually,
 		  ///\code
 		  ///  ShiftMap<X> sh(x,v);
 		  ///\endcode
-		  ///is equivalent with
+		  ///is equivalent to
 		  ///\code
 		  ///  ConstMap<X::Key, X::Value> c_tmp(v);
 		  ///  AddMap<X, ConstMap<X::Key, X::Value> > sh(x,v);
 		  ///\endcode
 		  ///
 		  ///\sa ShiftWriteMap
 		  template<typename M, typename C = typename M::Value>
 		  class ShiftMap : public MapBase<typename M::Key, typename M::Value> {
 		    const M& m;
 		    C v;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    ///Constructor
 		    ///\param _m is the undelying map
-		    ///\param _v is the shift value
+		    ///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;}
 		  };
-		  ///Shift a map with a constant. This map is also writable.
+		  ///Shift a map with a constant (ReadWrite version).
 		  ///This \c 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 is inherited from \c M.
+		  ///Its \c Key and \c Value are inherited from \c M.
 		  ///
 		  ///Actually,
 		  ///\code
 		  ///  ShiftMap<X> sh(x,v);
 		  ///\endcode
 		  ///is equivalent with
 		  ///\code
 		  ///  ConstMap<X::Key, X::Value> c_tmp(v);
 		  ///  AddMap<X, ConstMap<X::Key, X::Value> > sh(x,v);
-		  ///\endcode
+		  ///\sa ShiftMap
 		  template<typename M, typename C = typename M::Value>
 		  class ShiftWriteMap : public MapBase<typename M::Key, typename M::Value> {
 		    M& m;
 		    C v;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    ///Constructor
 		    ///\param _m is the undelying map
-		    ///\param _v is the shift value
+		    ///Constructor.
 		    ///\param _m is the undelying map.
 		    ///\param _v is the shift value.
 		    ShiftWriteMap(M &_m, const C &_v ) : m(_m), v(_v) {};
 		    /// \e
 		    Value operator[](Key k) const {return m[k] + v;}
 		    /// \e
 		    void set(Key k, const Value& c) { m.set(k, c - v); }
 		  };
-		  ///Returns an \c ShiftMap class
+		  ///Returns a \c ShiftMap class
-		  ///This function just returns an \c ShiftMap class.
+		  ///This function just returns a \c ShiftMap class.
 		  ///\relates ShiftMap
 		  template<typename M, typename C>
 		  inline ShiftMap<M, C> shiftMap(const M &m,const C &v) {
 		    return ShiftMap<M, C>(m,v);
+		  }
 		  ///Returns a \c ShiftWriteMap class
 		  ///This function just returns a \c ShiftWriteMap class.
 		  ///\relates ShiftWriteMap
 		  template<typename M, typename C>
 		  inline ShiftWriteMap<M, C> shiftMap(M &m,const C &v) {
 		    return ShiftWriteMap<M, C>(m,v);
+		  }
 		  ///Difference of two maps
 		  ///This \c concepts::ReadMap "read only map" returns the difference
 		  ///of the values of the two
 		  ///given maps. Its \c Key and \c Value will be inherited from \c M1.
 		  ///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.
 		  ///
 		  /// \todo Revise the misleading name
 		  template<typename M1, typename M2>
 		  class SubMap : public MapBase<typename M1::Key, typename M1::Value> {
 		    const M1& m1;
@@ -581,17 +590,15 @@
 		    return SubMap<M1, M2>(m1, m2);
+		  }
 		  ///Product of two maps
 		  ///This \c concepts::ReadMap "read only map" returns the product of the
 		  ///values of the two
 		  ///given
-		  ///maps. Its \c Key and \c Value will be inherited from \c M1.
+		  ///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<typename M1, typename M2>
 		  class MulMap : public MapBase<typename M1::Key, typename M1::Value> {
 		    const M1& m1;
 		    const M2& m2;
 		  public:
 		    typedef MapBase<typename M1::Key, typename M1::Value> Parent;
@@ -610,94 +617,102 @@
 		  ///\relates MulMap
 		  template<typename M1, typename M2>
 		  inline MulMap<M1, M2> mulMap(const M1 &m1,const M2 &m2) {
 		    return MulMap<M1, M2>(m1,m2);
+		  }
-		  ///Scales a maps with a constant.
+		  ///Scales a map with a constant.
 		  ///This \c 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 is inherited from \c M.
+		  ///Its \c Key and \c Value are inherited from \c M.
 		  ///
 		  ///Actually,
 		  ///\code
 		  ///  ScaleMap<X> sc(x,v);
 		  ///\endcode
-		  ///is equivalent with
+		  ///is equivalent to
 		  ///\code
 		  ///  ConstMap<X::Key, X::Value> c_tmp(v);
 		  ///  MulMap<X, ConstMap<X::Key, X::Value> > sc(x,v);
 		  ///\endcode
 		  ///
 		  ///\sa ScaleWriteMap
 		  template<typename M, typename C = typename M::Value>
 		  class ScaleMap : public MapBase<typename M::Key, typename M::Value> {
 		    const M& m;
 		    C v;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    ///Constructor
 		    ///\param _m is the undelying map
-		    ///\param _v is the scaling value
+		    ///Constructor.
 		    ///\param _m is the undelying map.
 		    ///\param _v is the scaling value.
 		    ScaleMap(const M &_m, const C &_v ) : m(_m), v(_v) {};
 		    /// \e
 		    Value operator[](Key k) const {return v * m[k];}
 		  };
-		  ///Scales a maps with a constant (ReadWrite version).
+		  ///Scales a map with a constant (ReadWrite version).
 		  ///This \c concepts::ReadWriteMap "read-write map" returns the value of the
 		  ///given map multiplied from the left side with a constant value. It can
 		  ///be used as write map also if the given multiplier is not zero.
 		  ///Its \c Key and \c Value is inherited from \c M.
 		  ///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.
 		  ///
 		  ///\sa ScaleMap
 		  template<typename M, typename C = typename M::Value>
 		  class ScaleWriteMap : public MapBase<typename M::Key, typename M::Value> {
 		    M& m;
 		    C v;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    ///Constructor
 		    ///\param _m is the undelying map
-		    ///\param _v is the scaling value
+		    ///Constructor.
 		    ///\param _m is the undelying map.
 		    ///\param _v is the scaling value.
 		    ScaleWriteMap(M &_m, const C &_v ) : m(_m), v(_v) {};
 		    /// \e
 		    Value operator[](Key k) const {return v * m[k];}
 		    /// \e
 		    void set(Key k, const Value& c) { m.set(k, c / v);}
 		  };
-		  ///Returns an \c ScaleMap class
+		  ///Returns a \c ScaleMap class
-		  ///This function just returns an \c ScaleMap class.
+		  ///This function just returns a \c ScaleMap class.
 		  ///\relates ScaleMap
 		  template<typename M, typename C>
 		  inline ScaleMap<M, C> scaleMap(const M &m,const C &v) {
 		    return ScaleMap<M, C>(m,v);
+		  }
 		  ///Returns a \c ScaleWriteMap class
 		  ///This function just returns a \c ScaleWriteMap class.
 		  ///\relates ScaleWriteMap
 		  template<typename M, typename C>
 		  inline ScaleWriteMap<M, C> scaleMap(M &m,const C &v) {
 		    return ScaleWriteMap<M, C>(m,v);
+		  }
 		  ///Quotient of two maps
 		  ///This \c concepts::ReadMap "read only map" returns the quotient of the
 		  ///values of the two
 		  ///given maps. Its \c Key and \c Value will be inherited from \c M1.
 		  ///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<typename M1, typename M2>
 		  class DivMap : public MapBase<typename M1::Key, typename M1::Value> {
 		    const M1& m1;
 		    const M2& m2;
 		  public:
 		    typedef MapBase<typename M1::Key, typename M1::Value> Parent;
@@ -719,24 +734,25 @@
 		    return DivMap<M1, M2>(m1,m2);
+		  }
 		  ///Composition of two maps
 		  ///This \c 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,
+		  ///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<M1, M2> cm(m1,m2);
 		  ///\endcode
 		  /// <tt>cm[x]</tt> will be equal to <tt>m1[m2[x]]</tt>
+		  /// <tt>cm[x]</tt> will be equal to <tt>m1[m2[x]]</tt>.
 		  ///
 		  ///Its \c Key is inherited from \c M2 and its \c Value is from
 		  ///\c M1.
-		  ///The \c M2::Value must be convertible to \c M1::Key.
+		  ///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.
 		  ///
 		  ///\sa CombineMap
 		  ///
 		  ///\todo Check the requirements.
 		  template <typename M1, typename M2>
 		  class ComposeMap : public MapBase<typename M2::Key, typename M1::Value> {
 		    const M1& m1;
 		    const M2& m2;
 		  public:
@@ -754,43 +770,43 @@
 		    ///
 		    //typename MapTraits<M1>::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 <typename M1, typename M2>
 		  inline ComposeMap<M1, M2> composeMap(const M1 &m1,const M2 &m2) {
 		    return ComposeMap<M1, M2>(m1,m2);
+		  }
-		  ///Combines of two maps using an STL (binary) functor.
+		  ///Combine of two maps using an STL (binary) functor.
 		  ///Combines of two maps using an STL (binary) functor.
 		  ///
 		  ///Combine of two maps using an STL (binary) functor.
 		  ///
 		  ///This \c concepts::ReadMap "read only map" takes two maps and a
 		  ///binary functor and returns the composition of
 		  ///the two
 		  ///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
 		  ///and \c f is of \c F, then for
 		  ///\code
-		  ///  CombineMap<M1, M2,F,V> cm(m1,m2,f);
 		  ///  CombineMap<M1,M2,F,V> cm(m1,m2,f);
 		  ///\endcode
 		  /// <tt>cm[x]</tt> will be equal to <tt>f(m1[x],m2[x])</tt>
 		  ///
 		  ///Its \c Key is inherited from \c M1 and its \c Value is \c V.
-		  ///The \c M2::Value and \c M1::Value must be convertible to the corresponding
 		  ///\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<typename M1, typename M2, typename F,
 			   typename V = typename F::result_type>
 		  class CombineMap : public MapBase<typename M1::Key, V> {
 		    const M1& m1;
 		    const M2& m2;
@@ -812,19 +828,19 @@
 		  ///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<double>(m1,m2,std::plus<double>())
 		  ///\endcode
-		  ///is equivalent with
+		  ///is equivalent to
 		  ///\code
 		  ///addMap(m1,m2)
 		  ///\endcode
 		  ///
 		  ///This function is specialized for adaptable binary function
-		  ///classes and c++ functions.
+		  ///classes and C++ functions.
 		  ///
 		  ///\relates CombineMap
 		  template<typename M1, typename M2, typename F, typename V>
 		  inline CombineMap<M1, M2, F, V>
 		  combineMap(const M1& m1,const M2& m2, const F& f) {
 		    return CombineMap<M1, M2, F, V>(m1,m2,f);
@@ -842,17 +858,17 @@
 		    return combineMap<M1, M2, V (*)(K1, K2), V>(m1,m2,f);
+		  }
 		  ///Negative value of a map
 		  ///This \c concepts::ReadMap "read only map" returns the negative
 		  ///value of the
 		  ///value returned by the
-		  ///given map. Its \c Key and \c Value will be inherited from \c M.
+		  ///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<typename M>
 		  class NegMap : public MapBase<typename M::Key, typename M::Value> {
 		    const M& m;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
@@ -864,16 +880,17 @@
 		    Value operator[](Key k) const {return -m[k];}
 		  };
 		  ///Negative value of a map (ReadWrite version)
 		  ///This \c concepts::ReadWriteMap "read-write map" returns the negative
 		  ///value of the value returned by the
 		  ///given map. Its \c Key and \c Value will be inherited from \c M.
 		  ///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 NegMap
 		  template<typename M>
 		  class NegWriteMap : public MapBase<typename M::Key, typename M::Value> {
 		    M& m;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
@@ -893,28 +910,28 @@
 		  ///\relates NegMap
 		  template <typename M>
 		  inline NegMap<M> negMap(const M &m) {
 		    return NegMap<M>(m);
+		  }
 		  ///Returns a \c NegWriteMap class
 		  ///This function just returns a \c NegWriteMap class.
 		  ///\relates NegWriteMap
 		  template <typename M>
 		  inline NegWriteMap<M> negMap(M &m) {
 		    return NegWriteMap<M>(m);
+		  }
 		  ///Absolute value of a map
 		  ///This \c concepts::ReadMap "read only map" returns the absolute value
 		  ///of the
 		  ///value returned by the
 		  ///given map. Its \c Key and \c Value will be inherited
 		  ///from <tt>M</tt>. <tt>Value</tt>
-		  ///must be comparable to <tt>0</tt> and the unary <tt>-</tt>
+		  ///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<typename M>
 		  class AbsMap : public MapBase<typename M::Key, typename M::Value> {
 		    const M& m;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
@@ -927,32 +944,33 @@
 		      Value tmp = m[k];
 		      return tmp >= 0 ? tmp : -tmp;
+		    }
 		  };
-		  ///Returns a \c AbsMap class
+		  ///Returns an \c AbsMap class
-		  ///This function just returns a \c AbsMap class.
+		  ///This function just returns an \c AbsMap class.
 		  ///\relates AbsMap
 		  template<typename M>
 		  inline AbsMap<M> absMap(const M &m) {
 		    return AbsMap<M>(m);
+		  }
 		  ///Converts an STL style functor to a map
 		  ///This \c concepts::ReadMap "read only map" returns the value
 		  ///of a
 		  ///given map.
 		  ///of a given functor.
 		  ///
 		  ///Template parameters \c K and \c V will become its
-		  ///\c Key and \c Value. They must be given explicitely
+		  ///\c Key and \c Value. They must be given explicitly
 		  ///because a functor does not provide such typedefs.
 		  ///
 		  ///Parameter \c F is the type of the used functor.
 		  ///
 		  ///\sa MapFunctor
 		  template<typename F,
 			   typename K = typename F::argument_type,
 			   typename V = typename F::result_type>
 		  class FunctorMap : public MapBase<K, V> {
 		    F f;
 		  public:
@@ -968,13 +986,13 @@
 		  ///Returns a \c FunctorMap class
 		  ///This function just returns a \c FunctorMap class.
 		  ///
 		  ///It is specialized for adaptable function classes and
-		  ///c++ functions.
+		  ///C++ functions.
 		  ///\relates FunctorMap
 		  template<typename K, typename V, typename F> inline
 		  FunctorMap<F, K, V> functorMap(const F &f) {
 		    return FunctorMap<F, K, V>(f);
+		  }
@@ -996,12 +1014,14 @@
 		  ///This class Converts a map to an STL style (unary) functor.
 		  ///that is it provides an <tt>operator()</tt> to read its values.
 		  ///
 		  ///For the sake of convenience it also works as
 		  ///a ususal \c concepts::ReadMap "readable map",
 		  ///i.e. <tt>operator[]</tt> and the \c Key and \c Value typedefs also exist.
 		  ///
 		  ///\sa FunctorMap
 		  template <typename M>
 		  class MapFunctor : public MapBase<typename M::Key, typename M::Value> {
 		    const M& m;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
@@ -1030,15 +1050,17 @@
 		  ///Applies all map setting operations to two maps
 		  ///This map has two \c 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 the ForkWriteMap.
 		  ///
-		  ///The \c Key and \c Value will be inherited from \c M1.
+		  ///The \c Key and \c Value are inherited from \c M1.
 		  ///The \c Key and \c Value of M2 must be convertible from those of \c M1.
 		  ///
 		  ///\sa ForkWriteMap
 		  ///
 		  /// \todo Why is it needed?
 		  template<typename  M1, typename M2>
 		  class ForkMap : public MapBase<typename M1::Key, typename M1::Value> {
 		    const M1& m1;
 		    const M2& m2;
 		  public:
@@ -1058,14 +1080,16 @@
 		  ///This map has two \c concepts::WriteMap "writable map"
 		  ///parameters and each write request will be passed to both of them.
 		  ///If \c M1 is also \c concepts::ReadMap "readable",
 		  ///then the read operations will return the
 		  ///corresponding values of \c M1.
 		  ///
-		  ///The \c Key and \c Value will be inherited from \c M1.
+		  ///The \c Key and \c Value are inherited from \c M1.
 		  ///The \c Key and \c Value of M2 must be convertible from those of \c M1.
 		  ///
 		  ///\sa ForkMap
 		  template<typename  M1, typename M2>
 		  class ForkWriteMap : public MapBase<typename M1::Key, typename M1::Value> {
 		    M1& m1;
 		    M2& m2;
 		  public:
 		    typedef MapBase<typename M1::Key, typename M1::Value> Parent;
@@ -1077,38 +1101,41 @@
 		    ///\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 an \c ForkMap class
+		  ///Returns a \c ForkMap class
 		  ///This function just returns an \c ForkMap class.
 		  ///
 		  ///This function just returns a \c ForkMap class.
 		  ///\relates ForkMap
 		  template <typename M1, typename M2>
 		  inline ForkMap<M1, M2> forkMap(const M1 &m1, const M2 &m2) {
 		    return ForkMap<M1, M2>(m1,m2);
+		  }
 		  ///Returns a \c ForkWriteMap class
 		  ///This function just returns a \c ForkWriteMap class.
 		  ///\relates ForkWriteMap
 		  template <typename M1, typename M2>
 		  inline ForkWriteMap<M1, M2> forkMap(M1 &m1, M2 &m2) {
 		    return ForkWriteMap<M1, M2>(m1,m2);
+		  }
 		  /* ************* BOOL MAPS ******************* */
 		  ///Logical 'not' of a map
 		  ///This bool \c concepts::ReadMap "read only map" returns the
 		  ///logical negation of
 		  ///value returned by the
 		  ///given map. Its \c Key and will be inherited from \c M,
 		  ///its Value is <tt>bool</tt>.
 		  ///logical negation of the value returned by the given map.
 		  ///Its \c Key is inherited from \c M, its Value is \c bool.
 		  ///
 		  ///\sa NotWriteMap
 		  template <typename M>
 		  class NotMap : public MapBase<typename M::Key, bool> {
 		    const M& m;
 		  public:
 		    typedef MapBase<typename M::Key, bool> Parent;
 		    typedef typename Parent::Key Key;
@@ -1120,16 +1147,17 @@
 		    Value operator[](Key k) const {return !m[k];}
 		  };
 		  ///Logical 'not' of a map (ReadWrie version)
 		  ///This bool \c concepts::ReadWriteMap "read-write map" returns the
 		  ///logical negation of value returned by the given map. When it is set,
+		  ///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 and will be inherited from \c M,
 		  ///its Value is <tt>bool</tt>.
 		  ///Its \c Key is inherited from \c M, its Value is \c bool.
 		  ///
 		  ///\sa NotMap
 		  template <typename M>
 		  class NotWriteMap : public MapBase<typename M::Key, bool> {
 		    M& m;
 		  public:
 		    typedef MapBase<typename M::Key, bool> Parent;
 		    typedef typename Parent::Key Key;
@@ -1149,12 +1177,16 @@
 		  ///\relates NotMap
 		  template <typename M>
 		  inline NotMap<M> notMap(const M &m) {
 		    return NotMap<M>(m);
+		  }
 		  ///Returns a \c NotWriteMap class
 		  ///This function just returns a \c NotWriteMap class.
 		  ///\relates NotWriteMap
 		  template <typename M>
 		  inline NotWriteMap<M> notMap(M &m) {
 		    return NotWriteMap<M>(m);
+		  }
 		  namespace _maps_bits {
@@ -1180,16 +1212,16 @@
 		      typedef typename _Iterator::container_type::value_type Value;
 		    };
+		  }
-		  /// \brief Writable bool map for logging each true assigned elements
+		  /// \brief Writable bool map for logging each \c true assigned element
 		  ///
 		  /// Writable bool map for logging each true assigned elements, i.e it
 		  /// copies all the keys set to true to the given iterator.
 		  /// Writable 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
 		  /// for each element.
 		  ///
 		  /// The following example shows how you can write the edges found by the Prim
 		  /// algorithm directly
@@ -1204,13 +1236,15 @@
 		  /// StoreBoolMap<ostream_iterator<int>, EdgeIdFunctor>
 		  ///   writerMap(ostream_iterator<int>(cout, " "), edgeIdFunctor);
 		  ///
 		  /// prim(graph, cost, writerMap);
 		  ///\endcode
 		  ///
-		  ///\todo Revise the name of this class and the relates ones.
+		  ///\sa BackInserterBoolMap
 		  ///
 		  ///\todo Revise the name of this class and the related ones.
 		  template <typename _Iterator,
 		            typename _Functor =
 		            _maps_bits::Identity<typename _maps_bits::
 		                                 IteratorTraits<_Iterator>::Value> >
 		  class StoreBoolMap {
 		  public:
@@ -1232,39 +1266,43 @@
 		    /// Gives back the the 'after the last' iterator
 		    Iterator end() const {
 		      return _end;
+		    }
-		    /// Setter function of the map
+		    /// The \c 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 true assigned elements in
 		  /// a back insertable container
 		  /// \brief Writable bool map for logging each \c true assigned element in
 		  /// a back insertable container.
 		  ///
 		  /// Writable bool map for logging each true assigned elements by pushing
 		  /// back them into a back insertable container.
 		  /// Writable bool map for logging each \c true assigned element by pushing
 		  /// them into a back insertable container.
 		  /// It can be used to retrieve the items into a standard
 		  /// container. The next example shows how you can store the
 		  /// edges found by the Prim algorithm in a vector.
 		  ///
 		  ///\code
 		  /// vector<Edge> span_tree_edges;
 		  /// BackInserterBoolMap<vector<Edge> > inserter_map(span_tree_edges);
 		  /// prim(graph, cost, inserter_map);
 		  ///\endcode
 		  ///
 		  ///\sa StoreBoolMap
 		  ///\sa FrontInserterBoolMap
 		  ///\sa InserterBoolMap
 		  template <typename Container,
 		            typename Functor =
 		            _maps_bits::Identity<typename Container::value_type> >
 		  class BackInserterBoolMap {
 		  public:
 		    typedef typename Container::value_type Key;
@@ -1272,30 +1310,34 @@
 		    /// Constructor
 		    BackInserterBoolMap(Container& _container,
 		                        const Functor& _functor = Functor())
 		      : container(_container), functor(_functor) {}
-		    /// Setter function of the map
+		    /// The \c 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 storing each true assignments in
+		  /// \brief Writable bool map for logging each \c true assigned element in
 		  /// a front insertable container.
 		  ///
 		  /// Writable bool map for storing each true assignment in a front
 		  /// insertable container. It will push front all the keys set to \c true into
-		  /// the container. For example see the BackInserterBoolMap.
+		  /// Writable bool map for logging each \c true assigned element by pushing
 		  /// them into a front insertable container.
 		  /// It can be used to retrieve the items into a standard
 		  /// container. For example see \ref BackInserterBoolMap.
 		  ///
 		  ///\sa BackInserterBoolMap
 		  ///\sa InserterBoolMap
 		  template <typename Container,
 		            typename Functor =
 		            _maps_bits::Identity<typename Container::value_type> >
 		  class FrontInserterBoolMap {
 		  public:
 		    typedef typename Container::value_type Key;
@@ -1303,57 +1345,70 @@
 		    /// Constructor
 		    FrontInserterBoolMap(Container& _container,
 		                         const Functor& _functor = Functor())
 		      : container(_container), functor(_functor) {}
-		    /// Setter function of the map
+		    /// The \c set function of the map
 		    void set(const Key& key, Value value) {
 		      if (value) {
 			container.push_front(key);
+		      }
+		    }
 		  private:
 		    Container& container;
 		    Functor functor;
 		  };
-		  /// \brief Writable bool map for storing each true assigned elements in
+		  /// \brief Writable bool map for storing each \c true assigned element in
 		  /// an insertable container.
 		  ///
-		  /// Writable bool map for storing each true assigned elements 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<Arc> cut_arcs;
 		  /// InserterBoolMap<set<Arc> > inserter_map(cut_arcs);
 		  /// stronglyConnectedCutArcs(digraph, cost, inserter_map);
 		  ///\endcode
 		  ///
 		  ///\sa BackInserterBoolMap
 		  ///\sa FrontInserterBoolMap
 		  template <typename Container,
 		            typename Functor =
 		            _maps_bits::Identity<typename Container::value_type> >
 		  class InserterBoolMap {
 		  public:
 		    typedef typename Container::value_type Key;
 		    typedef bool Value;
 		    /// Constructor
+		    /// 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())
 		      : container(_container), it(_it), functor(_functor) {}
 		    /// Constructor
 		    /// Constructor without specified iterator.
 		    /// The elements will be inserted before <tt>_container.end()</tt>.
 		    /// \param _container The container for storing the elements.
 		    /// \param _functor The functor that is used when an element is stored.
 		    InserterBoolMap(Container& _container, const Functor& _functor = Functor())
 		      : container(_container), it(_container.end()), functor(_functor) {}
-		    /// Setter function of the map
+		    /// The \c set function of the map
 		    void set(const Key& key, Value value) {
 		      if (value) {
 			it = container.insert(it, key);
 		        ++it;
+		      }
+		    }
@@ -1361,17 +1416,17 @@
 		  private:
 		    Container& container;
 		    typename Container::iterator it;
 		    Functor functor;
 		  };
-		  /// \brief Fill the true set elements with a given value.
+		  /// \brief Writable bool map for filling each \c true assigned element with a
 		  /// given value.
 		  ///
 		  /// Writable bool map to fill the elements set to \c true with a given value.
 		  /// The value can set
-		  /// the container.
+		  /// 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<int> ComponentMap;
 		  /// ComponentMap comp(graph);
@@ -1415,29 +1470,29 @@
 		    /// Sets the current fill value
 		    void fillValue(const typename Map::Value& _fill) {
 		      fill = _fill;
+		    }
-		    /// Set function of the map
+		    /// The \c 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 which stores the sequence number of
 		  /// true assignments.
 		  /// \brief Writable bool map for storing the sequence number of
 		  /// \c true assignments.
 		  ///
-		  /// Writable bool map which stores for each true assigned elements
+		  /// 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.
 		  ///
 		  ///\code
 		  /// typedef Digraph::NodeMap<int> OrderMap;

0 comments (0 inline)

RhodeCode

Login to your account