LEMON/LEMON-main Changeset - r51:90201bb15a8d

Repositories » LEMON » LEMON-main

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

Changeset - r51:90201bb15a8d

« 48:93ae26
« 50:a34c58

52:ea3056 »

r51:90201bb15a8d

Tue, 08 Jan 2008 20:26:48

[Not Reviewed]

0 comments (0 inline)

alpar (Alpar Juttner)
alpar@cs.elte.hu

Merge

0 2 0

merge default

2 files changed with 123 insertions and 66 deletions:

lemon/concepts/maps.h

lemon/maps.h

118

↑ Collapse diff ↑

lemon/concepts/maps.h

Show inline comments

@@ -39,24 +39,25 @@
 		    ///
 		    template<typename K, typename T>
 		    class ReadMap
+		    {
 		    public:
 		      /// 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;
 		      /// Returns the value associated with a key.
 		      /// Returns the value associated with a key.
 		      /// \bug Value shouldn't need to be default constructible.
 		      ///
 		      Value operator[](const Key &) const {return Value();}
 		      template<typename _ReadMap>
 		      struct Constraints {
 			void constraints() {
 			  Value val = m[key];
 			  val = m[key];
 			  typename _ReadMap::Value own_val = m[own_key];
 			  own_val = m[own_key];
@@ -104,25 +105,25 @@
 			  ignore_unused_variable_warning(own_val);
+			}
 			Value& val;
 			typename _WriteMap::Value own_val;
 			Key& key;
 			typename _WriteMap::Key& own_key;
 			_WriteMap& m;
 		      };
 		    };
-		    /// Read/Writable map concept
+		    /// Read/writable map concept
 		    /// Read/writable map concept.
 		    ///
 		    template<typename K, typename T>
 		    class ReadWriteMap : public ReadMap<K,T>,
 					 public WriteMap<K,T>
+		    {
 		    public:
 		      /// 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;
@@ -137,51 +138,51 @@
 			void constraints() {
 			  checkConcept<ReadMap<K, T>, _ReadWriteMap >();
 			  checkConcept<WriteMap<K, T>, _ReadWriteMap >();
+			}
 		      };
 		    };
 		    /// Dereferable map concept
 		    /// Dereferable map concept.
 		    ///
 		    /// \todo Rethink this concept.
 		    template<typename K, typename T, typename R, typename CR>
 		    class ReferenceMap : public ReadWriteMap<K,T>
+		    {
 		    public:
 		      /// Tag for reference maps.
 		      typedef True ReferenceMapTag;
 		      /// 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;
 		      /// The reference type of the map.
 		      typedef R Reference;
 		      /// The const reference type of the map.
 		      typedef CR ConstReference;
 		    protected:
 		      Value tmp;
 		    public:
-		      ///Returns a reference to the value associated to a key.
+		      ///Returns a reference to the value associated with a key.
 		      Reference operator[](const Key &) { return tmp; }
-		      ///Returns a const reference to the value associated to a key.
+		      ///Returns a const reference to the value associated with a key.
 		      ConstReference operator[](const Key &) const { return tmp; }
 		      /// Sets the value associated with a key.
 		      void set(const Key &k,const Value &t) { operator[](k)=t; }
 		      /// \todo Rethink this concept.
 		      template<typename _ReferenceMap>
 		      struct ReferenceMapConcept {
 			void constraints() {
 			  checkConcept<ReadWriteMap, _ReferenceMap >();
 			  m[key] = val;
 			  val  = m[key];
 			  m[key] = ref;
 			  ref = m[key];
 			  m[own_key] = own_val;
 			  own_val  = m[own_key];
 			  m[own_key] = own_ref;

lemon/maps.h

Show inline comments

@@ -72,26 +72,27 @@
 		  ///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>();
+		  }
 		  /// Constant map.
 		  /// This is a readable map which assigns a specified value to each key.
 		  /// In other aspects it is equivalent to the \c NullMap.
 		  /// 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<typename K, typename T>
 		  class ConstMap : public MapBase<K, T> {
 		  private:
 		    T v;
 		  public:
 		    typedef MapBase<K, T> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    /// Default constructor
@@ -124,86 +125,90 @@
 		  ///\relates ConstMap
 		  template<typename K, typename V>
 		  inline ConstMap<K, V> constMap(const V &v) {
 		    return ConstMap<K, V>(v);
+		  }
 		  template<typename T, T v>
 		  struct Const { };
 		  /// Constant map with inlined constant value.
 		  /// This is a readable map which assigns a specified value to each key.
 		  /// In other aspects it is equivalent to the \c NullMap.
 		  /// 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<typename K, typename V, V v>
 		  class ConstMap<K, Const<V, v> > : public MapBase<K, V> {
 		  public:
 		    typedef MapBase<K, V> Parent;
 		    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&) { }
 		  };
 		  ///Returns a \c ConstMap class
+		  ///Returns a \c ConstMap class with inlined value
 		  ///This function just returns a \c ConstMap class with inlined value.
 		  ///\relates ConstMap
 		  template<typename K, typename V, V v>
 		  inline ConstMap<K, Const<V, v> > constMap() {
 		    return ConstMap<K, Const<V, v> >();
+		  }
 		  ///Map based on std::map
+		  ///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 <typename K, typename T, typename Compare = std::less<K> >
 		  class StdMap {
+		  class StdMap : public MapBase<K, T> {
 		    template <typename K1, typename T1, typename C1>
 		    friend class StdMap;
 		  public:
-		    typedef True ReferenceMapTag;
+		    typedef MapBase<K, T> Parent;
 		    ///Key type
-		    typedef K Key;
+		    typedef typename Parent::Key Key;
 		    ///Value type
-		    typedef T Value;
+		    typedef typename Parent::Value Value;
 		    ///Reference Type
 		    typedef T& Reference;
 		    ///Const reference type
 		    typedef const T& ConstReference;
 		    typedef True ReferenceMapTag;
 		  private:
 		    typedef std::map<K, T, Compare> 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 std::map, and explicitly
 		    /// specifies a default value.
 		    /// \brief Constructs the map from an appropriate \c std::map, and
 		    /// explicitly specifies a default value.
 		    template <typename T1, typename Comp1>
 		    StdMap(const std::map<Key, T1, Comp1> &map, const T& value = T())
 		      : _map(map.begin(), map.end()), _value(value) {}
 		    /// \brief Constructs a map from an other StdMap.
+		    /// \brief Constructs a map from an other \ref StdMap.
 		    template<typename T1, typename Comp1>
 		    StdMap(const StdMap<Key, T1, Comp1> &c)
 		      : _map(c._map.begin(), c._map.end()), _value(c._value) {}
 		  private:
 		    StdMap& operator=(const StdMap&);
 		  public:
 		    ///\e
 		    Reference operator[](const Key &k) {
@@ -231,66 +236,90 @@
 		      else
 			_map.insert(it, std::make_pair(k, t));
+		    }
 		    /// \e
 		    void setAll(const T &t) {
 		      _value = t;
 		      _map.clear();
+		    }
 		  };
 		  ///Returns a \c StdMap class
 		  ///This function just returns a \c StdMap class with specified
 		  ///default value.
 		  ///\relates StdMap
 		  template<typename K, typename V, typename Compare = std::less<K> >
 		  inline StdMap<K, V, Compare> stdMap(const V& value = V()) {
 		    return StdMap<K, V, Compare>(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<typename K, typename V, typename Compare = std::less<K> >
 		  inline StdMap<K, V, Compare> stdMap( const std::map<K, V, Compare> &map,
 		                                       const V& value = V() ) {
 		    return StdMap<K, V, Compare>(map, value);
+		  }
 		  /// \brief Map for storing values for keys from the range <tt>[0..size-1]</tt>
 		  ///
-		  /// The current map has the <tt>[0..size-1]</tt> keyset and the values
+		  /// This map has the <tt>[0..size-1]</tt> keyset and the values
 		  /// are stored in a \c std::vector<T>  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 <typename T>
 		  class IntegerMap {
+		  class IntegerMap : public MapBase<int, T> {
 		    template <typename T1>
 		    friend class IntegerMap;
 		  public:
-		    typedef True ReferenceMapTag;
+		    typedef MapBase<int, T> Parent;
 		    ///\e
-		    typedef int Key;
+		    typedef typename Parent::Key Key;
 		    ///\e
-		    typedef T Value;
+		    typedef typename Parent::Value Value;
 		    ///\e
 		    typedef T& Reference;
 		    ///\e
 		    typedef const T& ConstReference;
 		    typedef True ReferenceMapTag;
 		  private:
 		    typedef std::vector<T> 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 std::vector.
+		    /// \brief Constructs the map from an appropriate \c std::vector.
 		    template <typename T1>
 		    IntegerMap(const std::vector<T1>& vector)
 		      : _vector(vector.begin(), vector.end()) {}
 		    /// \brief Constructs a map from an other IntegerMap.
+		    /// \brief Constructs a map from an other \ref IntegerMap.
 		    template <typename T1>
 		    IntegerMap(const IntegerMap<T1> &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&);
@@ -305,24 +334,33 @@
 		    /// \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<typename T>
 		  inline IntegerMap<T> integerMap(int size = 0, const T& value = T()) {
 		    return IntegerMap<T>(size, value);
+		  }
 		  /// @}
 		  /// \addtogroup map_adaptors
 		  /// @{
 		  /// \brief Identity map.
 		  ///
 		  /// This map gives back the given key as value without any
 		  /// modification.
 		  template <typename T>
 		  class IdentityMap : public MapBase<T, T> {
 		  public:
@@ -340,44 +378,42 @@
 		  ///This function just returns an \c IdentityMap class.
 		  ///\relates IdentityMap
 		  template<typename T>
 		  inline IdentityMap<T> identityMap() {
 		    return IdentityMap<T>();
+		  }
 		  ///\brief Convert the \c Value of a map to another type using
 		  ///the default conversion.
 		  ///
-		  ///This \c concepts::ReadMap "read only map"
+		  ///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 <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.
 		    ConvertMap(const M &_m) : m(_m) {};
 		    /// \brief The subscript operator.
 		    ///
-		    /// The subscript operator.
+		    ///\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<typename T, typename M>
 		  inline ConvertMap<M, T> convertMap(const M &m) {
 		    return ConvertMap<M, T>(m);
+		  }
@@ -397,87 +433,105 @@
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> 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];}
 		  };
 		  ///Returns a \c SimpleMap class
 		  ///This function just returns a \c SimpleMap class.
 		  ///\relates SimpleMap
 		  template<typename M>
 		  inline SimpleMap<M> simpleMap(const M &m) {
 		    return SimpleMap<M>(m);
+		  }
 		  ///Simple writable wrapping of a map
-		  ///This \ref concepts::WriteMap "write map" returns the simple
+		  ///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.
 		  ///
 		  ///\sa SimpleMap
 		  ///
 		  /// \todo Revise the misleading name
 		  template<typename M>
 		  class SimpleWriteMap : 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;
 		    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); }
 		  };
 		  ///Returns a \c SimpleWriteMap class
 		  ///This function just returns a \c SimpleWriteMap class.
 		  ///\relates SimpleWriteMap
 		  template<typename M>
 		  inline SimpleWriteMap<M> simpleWriteMap(M &m) {
 		    return SimpleWriteMap<M>(m);
+		  }
 		  ///Sum of two maps
-		  ///This \c concepts::ReadMap "read only map" returns the sum of the two
+		  ///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 M2 must be convertible to those of \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 AddMap : public MapBase<typename M1::Key, typename M1::Value> {
 		    const M1& m1;
 		    const M2& m2;
 		  public:
 		    typedef MapBase<typename M1::Key, typename M1::Value> 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];}
 		  };
 		  ///Returns an \c AddMap class
 		  ///This function just returns an \c AddMap class.
-		  ///\todo How to call these type of functions?
+		  ///\todo Extend the documentation: how to call these type of functions?
 		  ///
 		  ///\relates AddMap
 		  template<typename M1, typename M2>
 		  inline AddMap<M1, M2> addMap(const M1 &m1,const M2 &m2) {
 		    return AddMap<M1, M2>(m1,m2);
+		  }
 		  ///Shift a map with a constant.
-		  ///This \c concepts::ReadMap "read only map" returns the sum of the
+		  ///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.
 		  ///
 		  ///Actually,
 		  ///\code
 		  ///  ShiftMap<X> sh(x,v);
 		  ///\endcode
 		  ///is equivalent to
 		  ///\code
 		  ///  ConstMap<X::Key, X::Value> c_tmp(v);
 		  ///  AddMap<X, ConstMap<X::Key, X::Value> > sh(x,v);
 		  ///\endcode
@@ -495,25 +549,25 @@
 		    ///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;}
 		  };
 		  ///Shift a map with a constant (ReadWrite version).
-		  ///This \c concepts::ReadWriteMap "read-write map" returns the sum of the
+		  ///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.
 		  ///
 		  ///\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;
@@ -541,25 +595,25 @@
 		  ///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
+		  ///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.
 		  ///
 		  /// \todo Revise the misleading name
 		  template<typename M1, typename M2>
 		  class SubMap : public MapBase<typename M1::Key, typename M1::Value> {
 		    const M1& m1;
 		    const M2& m2;
 		  public:
 		    typedef MapBase<typename M1::Key, typename M1::Value> Parent;
 		    typedef typename Parent::Key Key;
@@ -574,25 +628,25 @@
 		  ///Returns a \c SubMap class
 		  ///This function just returns a \c SubMap class.
 		  ///
 		  ///\relates SubMap
 		  template<typename M1, typename M2>
 		  inline SubMap<M1, M2> subMap(const M1 &m1, const M2 &m2) {
 		    return SubMap<M1, M2>(m1, m2);
+		  }
 		  ///Product of two maps
-		  ///This \c concepts::ReadMap "read only map" returns the product of the
+		  ///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<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;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
@@ -604,25 +658,25 @@
 		  ///Returns a \c MulMap class
 		  ///This function just returns a \c MulMap class.
 		  ///\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 map with a constant.
-		  ///This \c concepts::ReadMap "read only map" returns the value of the
+		  ///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.
 		  ///
 		  ///Actually,
 		  ///\code
 		  ///  ScaleMap<X> sc(x,v);
 		  ///\endcode
 		  ///is equivalent to
 		  ///\code
 		  ///  ConstMap<X::Key, X::Value> c_tmp(v);
 		  ///  MulMap<X, ConstMap<X::Key, X::Value> > sc(x,v);
 		  ///\endcode
@@ -640,25 +694,25 @@
 		    ///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) {};
 		    /// \e
 		    Value operator[](Key k) const {return v * m[k];}
 		  };
 		  ///Scales a map with a constant (ReadWrite version).
-		  ///This \c concepts::ReadWriteMap "read-write map" returns the value of the
+		  ///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.
 		  ///
 		  ///\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;
@@ -688,25 +742,25 @@
 		  ///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
+		  ///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<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;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
@@ -718,25 +772,25 @@
 		  ///Returns a \c DivMap class
 		  ///This function just returns a \c DivMap class.
 		  ///\relates DivMap
 		  template<typename M1, typename M2>
 		  inline DivMap<M1, M2> divMap(const M1 &m1,const M2 &m2) {
 		    return DivMap<M1, M2>(m1,m2);
+		  }
 		  ///Composition of two maps
-		  ///This \c concepts::ReadMap "read only map" returns the composition of
+		  ///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<M1, M2> cm(m1,m2);
 		  ///\endcode
 		  /// <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.
 		  ///\c M2::Value must be convertible to \c M1::Key.
 		  ///
 		  ///\sa CombineMap
@@ -769,25 +823,25 @@
 		  ///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);
+		  }
 		  ///Combine 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
+		  ///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<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.
 		  ///\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
@@ -842,47 +896,47 @@
 		  combineMap(const M1& m1, const M2& m2, const F& f) {
 		    return combineMap<M1, M2, F, typename F::result_type>(m1,m2,f);
+		  }
 		  template<typename M1, typename M2, typename K1, typename K2, typename V>
 		  inline CombineMap<M1, M2, V (*)(K1, K2), V>
 		  combineMap(const M1 &m1, const M2 &m2, V (*f)(K1, K2)) {
 		    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
+		  ///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<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;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    NegMap(const M &_m) : m(_m) {};
 		    /// \e
 		    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
+		  ///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.
 		  ///
 		  /// \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;
 		    typedef typename Parent::Value Value;
@@ -906,25 +960,25 @@
 		  ///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
+		  ///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<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;
 		    typedef typename Parent::Value Value;
@@ -940,83 +994,85 @@
 		  ///Returns an \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
+		  ///This \ref concepts::ReadMap "read only map" returns the value
 		  ///of a given functor.
 		  ///
 		  ///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 such typedefs.
+		  ///functor typically does not provide \c argument_type and
 		  ///\c result_type 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:
 		    typedef MapBase<K, V> 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.
 		  ///
 		  ///It is specialized for adaptable function classes and
 		  ///C++ functions.
 		  ///This function is specialized for adaptable binary function
 		  ///classes and 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);
+		  }
 		  template <typename F> inline
 		  FunctorMap<F, typename F::argument_type, typename F::result_type>
 		  functorMap(const F &f) {
 		    return FunctorMap<F, typename F::argument_type,
 		      typename F::result_type>(f);
+		  }
 		  template <typename K, typename V> inline
 		  FunctorMap<V (*)(K), K, V> functorMap(V (*f)(K)) {
 		    return FunctorMap<V (*)(K), K, V>(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 <tt>operator()</tt> to read its values.
+		  ///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",
+		  ///a ususal \ref 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;
 		    typedef typename Parent::Value Value;
 		    typedef typename M::Key argument_type;
@@ -1030,62 +1086,62 @@
 		    Value operator[](Key k) const {return m[k];}
 		  };
 		  ///Returns a \c MapFunctor class
 		  ///This function just returns a \c MapFunctor class.
 		  ///\relates MapFunctor
 		  template<typename M>
 		  inline MapFunctor<M> mapFunctor(const M &m) {
 		    return MapFunctor<M>(m);
+		  }
-		  ///Applies all map setting operations to two maps
+		  ///Just readable version of \ref ForkWriteMap
-		  ///This map has two \c concepts::ReadMap "readable map"
+		  ///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 the ForkWriteMap.
+		  ///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 M2 must be convertible from those of \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<typename  M1, typename M2>
 		  class ForkMap : public MapBase<typename M1::Key, typename M1::Value> {
 		    const M1& m1;
 		    const M2& m2;
 		  public:
 		    typedef MapBase<typename M1::Key, typename M1::Value> 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 \c concepts::WriteMap "writable map"
+		  ///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 \c concepts::ReadMap "readable",
+		  ///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 M2 must be convertible from those of \c M1.
+		  ///The \c Key and \c Value of \c 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;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
@@ -1111,49 +1167,49 @@
 		  ///\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
+		  ///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 Value is \c bool.
+		  ///Its \c Key is inherited from \c M, its \c 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;
 		    typedef typename Parent::Value Value;
 		    /// Constructor
 		    NotMap(const M &_m) : m(_m) {};
 		    ///\e
 		    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
+		  ///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 Value is \c bool.
+		  ///Its \c Key is inherited from \c M, its \c 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;
 		    typedef typename Parent::Value Value;
 		    /// Constructor
 		    NotWriteMap(M &_m) : m(_m) {};
@@ -1200,33 +1256,33 @@
 		    template <typename _Iterator>
 		    struct IteratorTraits<_Iterator,
 		      typename exists<typename _Iterator::container_type>::type>
+		    {
 		      typedef typename _Iterator::container_type::value_type Value;
 		    };
+		  }
 		  /// \brief Writable bool map for logging each \c true assigned element
 		  ///
 		  /// 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.
 		  /// 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
 		  /// for each element.
 		  ///
 		  /// The following example shows how you can write the edges found by the Prim
 		  /// algorithm directly
-		  /// to the standard output.
+		  /// The following example shows how you can write the edges found by
 		  /// the \ref Prim algorithm directly to the standard output.
 		  ///\code
 		  /// typedef IdMap<Graph, Edge> EdgeIdMap;
 		  /// EdgeIdMap edgeId(graph);
 		  ///
 		  /// typedef MapFunctor<EdgeIdMap> EdgeIdFunctor;
 		  /// EdgeIdFunctor edgeIdFunctor(edgeId);
 		  ///
 		  /// StoreBoolMap<ostream_iterator<int>, EdgeIdFunctor>
 		  ///   writerMap(ostream_iterator<int>(cout, " "), edgeIdFunctor);
 		  ///
 		  /// prim(graph, cost, writerMap);
 		  ///\endcode

0 comments (0 inline)

RhodeCode

Login to your account