LEMON/LEMON-official Changeset - r82:bce6c8f93d10

Repositories » LEMON » LEMON-official

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

Changeset - r82:bce6c8f93d10

« 81:7ff1c3

83:365432 »

r82:bce6c8f93d10

Sat, 15 Mar 2008 23:39:41

[Not Reviewed]

0 comments (0 inline)

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

Add basic logical maps and doc improvements - Add the following new logical maps and map adaptors: * TrueMap, FalseMap * AndMap, OrMap * EqualMap, LessMap - Improve the documentation for other classes.

0 2 0

default

2 files changed with 325 insertions and 25 deletions:

lemon/maps.h

298

test/maps_test.cc

↑ Collapse diff ↑

lemon/maps.h

Show inline comments

@@ -83,14 +83,14 @@
 		    return NullMap<K, V>();
+		  }
 		  /// Constant map.
 		  /// This is a \ref concepts::ReadMap "readable" map which assigns a
 		  /// specified value to each key.
 		  /// This \ref concepts::ReadMap "readable map" assigns a specified
 		  /// value to each key.
 		  ///
 		  /// 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()
@@ -146,14 +146,14 @@
 		  template<typename T, T v>
 		  struct Const {};
 		  /// Constant map with inlined constant value.
 		  /// This is a \ref concepts::ReadMap "readable" map which assigns a
 		  /// specified value to each key.
 		  /// This \ref concepts::ReadMap "readable map" assigns a specified
 		  /// value to each key.
 		  ///
 		  /// 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()
@@ -186,28 +186,28 @@
 		  template<typename K, typename V, V v>
 		  inline ConstMap<K, Const<V, v> > constMap() {
 		    return ConstMap<K, Const<V, v> >();
+		  }
 		  /// \brief Identity map.
 		  ///
 		  /// This map gives back the given key as value without any
 		  /// modification.
 		  /// Identity map.
 		  /// This \ref concepts::ReadMap "read-only map" gives back the given
 		  /// key as value without any modification.
 		  ///
 		  /// \sa ConstMap
 		  template <typename T>
 		  class IdentityMap : public MapBase<T, T> {
 		  public:
 		    typedef MapBase<T, T> 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;
 		    Value operator[](const Key &k) const {
 		      return k;
+		    }
 		  };
 		  /// Returns an \ref IdentityMap class
 		  /// This function just returns an \ref IdentityMap class.
@@ -461,13 +461,13 @@
 		  /// \addtogroup map_adaptors
 		  /// @{
 		  /// Composition of two maps
-		  /// This \ref concepts::ReadMap "read only map" returns the
+		  /// 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>.
@@ -513,13 +513,13 @@
 		    return ComposeMap<M1, M2>(m1, m2);
+		  }
 		  /// Combination of two maps using an STL (binary) functor.
-		  /// This \ref 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 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<M1,M2,F,V> cm(m1,m2,f);
@@ -592,13 +592,13 @@
 		    return combineMap<M1, M2, V (*)(K1, K2), V>(m1,m2,f);
+		  }
 		  /// Converts an STL style (unary) functor to a map
-		  /// This \ref concepts::ReadMap "read only map" returns the value
+		  /// 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.
 		  ///
 		  /// 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
@@ -772,13 +772,13 @@
 		    return ForkMap<M1,M2>(m1,m2);
+		  }
 		  /// Sum of two maps
-		  /// This \ref concepts::ReadMap "read only map" returns the sum
+		  /// 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
@@ -821,13 +821,13 @@
 		    return AddMap<M1, M2>(m1,m2);
+		  }
 		  /// Difference of two maps
-		  /// This \ref 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 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
@@ -869,13 +869,13 @@
 		    return SubMap<M1, M2>(m1,m2);
+		  }
 		  /// Product of two maps
-		  /// This \ref concepts::ReadMap "read only map" returns the product
+		  /// 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
@@ -918,13 +918,13 @@
 		    return MulMap<M1, M2>(m1,m2);
+		  }
 		  /// Quotient of two maps
-		  /// This \ref concepts::ReadMap "read only map" returns the quotient
+		  /// 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
@@ -966,13 +966,13 @@
 		    return DivMap<M1, M2>(m1,m2);
+		  }
 		  /// Shifts a map with a constant.
-		  /// This \ref concepts::ReadMap "read only map" returns the sum of
+		  /// 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<M> sh(m,v);
@@ -1067,13 +1067,13 @@
 		    return ShiftWriteMap<M, C>(m,v);
+		  }
 		  /// Scales a map with a constant.
-		  /// This \ref concepts::ReadMap "read only map" returns the value of
+		  /// 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<M> sc(m,v);
@@ -1169,13 +1169,13 @@
 		    return ScaleWriteMap<M, C>(m,v);
+		  }
 		  /// Negative of a map
-		  /// This \ref concepts::ReadMap "read only map" returns the negative
+		  /// 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.
 		  ///
 		  /// If M::Value is \c int, \c double etc., then
 		  /// \code
 		  ///   NegMap<M> neg(m);
@@ -1267,13 +1267,13 @@
 		    return NegWriteMap<M>(m);
+		  }
 		  /// Absolute value of a map
-		  /// This \ref concepts::ReadMap "read only map" returns the absolute
+		  /// 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()
@@ -1308,16 +1308,196 @@
 		  /// \relates AbsMap
 		  template<typename M>
 		  inline AbsMap<M> absMap(const M &m) {
 		    return AbsMap<M>(m);
+		  }
 		  /// @}
 		  // Logical maps and map adaptors:
 		  /// \addtogroup maps
 		  /// @{
 		  /// Constant \c true map.
 		  /// This \ref concepts::ReadMap "read-only map" assigns \c true to
 		  /// each key.
 		  ///
 		  /// Note that
 		  /// \code
 		  ///   TrueMap<K> tm;
 		  /// \endcode
 		  /// is equivalent to
 		  /// \code
 		  ///   ConstMap<K,bool> tm(true);
 		  /// \endcode
 		  ///
 		  /// \sa FalseMap
 		  /// \sa ConstMap
 		  template <typename K>
 		  class TrueMap : public MapBase<K, bool> {
 		  public:
 		    typedef MapBase<K, bool> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    /// Gives back \c true.
 		    Value operator[](const Key&) const { return true; }
 		  };
 		  /// Returns a \ref TrueMap class
 		  /// This function just returns a \ref TrueMap class.
 		  /// \relates TrueMap
 		  template<typename K>
 		  inline TrueMap<K> trueMap() {
 		    return TrueMap<K>();
+		  }
 		  /// Constant \c false map.
 		  /// This \ref concepts::ReadMap "read-only map" assigns \c false to
 		  /// each key.
 		  ///
 		  /// Note that
 		  /// \code
 		  ///   FalseMap<K> fm;
 		  /// \endcode
 		  /// is equivalent to
 		  /// \code
 		  ///   ConstMap<K,bool> fm(false);
 		  /// \endcode
 		  ///
 		  /// \sa TrueMap
 		  /// \sa ConstMap
 		  template <typename K>
 		  class FalseMap : public MapBase<K, bool> {
 		  public:
 		    typedef MapBase<K, bool> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    /// Gives back \c false.
 		    Value operator[](const Key&) const { return false; }
 		  };
 		  /// Returns a \ref FalseMap class
 		  /// This function just returns a \ref FalseMap class.
 		  /// \relates FalseMap
 		  template<typename K>
 		  inline FalseMap<K> falseMap() {
 		    return FalseMap<K>();
+		  }
 		  /// @}
 		  /// \addtogroup map_adaptors
 		  /// @{
 		  /// Logical 'and' of two maps
 		  /// This \ref concepts::ReadMap "read-only map" returns the logical
 		  /// 'and' of the values of the two given maps.
 		  /// Its \c Key type is inherited from \c M1 and its \c Value type is
 		  /// \c bool. \c M2::Key must be convertible to \c M1::Key.
 		  ///
 		  /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for
 		  /// \code
 		  ///   AndMap<M1,M2> am(m1,m2);
 		  /// \endcode
 		  /// <tt>am[x]</tt> will be equal to <tt>m1[x]&&m2[x]</tt>.
 		  ///
 		  /// The simplest way of using this map is through the andMap()
 		  /// function.
 		  ///
 		  /// \sa OrMap
 		  /// \sa NotMap, NotWriteMap
 		  template<typename M1, typename M2>
 		  class AndMap : public MapBase<typename M1::Key, bool> {
 		    const M1 &_m1;
 		    const M2 &_m2;
 		  public:
 		    typedef MapBase<typename M1::Key, bool> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    /// Constructor
 		    AndMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {}
 		    /// \e
 		    Value operator[](const Key &k) const { return _m1[k]&&_m2[k]; }
 		  };
 		  /// Returns an \ref AndMap class
 		  /// This function just returns an \ref AndMap class.
 		  ///
 		  /// For example, if \c m1 and \c m2 are both maps with \c bool values,
 		  /// then <tt>andMap(m1,m2)[x]</tt> will be equal to
 		  /// <tt>m1[x]&&m2[x]</tt>.
 		  ///
 		  /// \relates AndMap
 		  template<typename M1, typename M2>
 		  inline AndMap<M1, M2> andMap(const M1 &m1, const M2 &m2) {
 		    return AndMap<M1, M2>(m1,m2);
+		  }
 		  /// Logical 'or' of two maps
 		  /// This \ref concepts::ReadMap "read-only map" returns the logical
 		  /// 'or' of the values of the two given maps.
 		  /// Its \c Key type is inherited from \c M1 and its \c Value type is
 		  /// \c bool. \c M2::Key must be convertible to \c M1::Key.
 		  ///
 		  /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for
 		  /// \code
 		  ///   OrMap<M1,M2> om(m1,m2);
 		  /// \endcode
 		  /// <tt>om[x]</tt> will be equal to <tt>m1[x]||m2[x]</tt>.
 		  ///
 		  /// The simplest way of using this map is through the orMap()
 		  /// function.
 		  ///
 		  /// \sa AndMap
 		  /// \sa NotMap, NotWriteMap
 		  template<typename M1, typename M2>
 		  class OrMap : public MapBase<typename M1::Key, bool> {
 		    const M1 &_m1;
 		    const M2 &_m2;
 		  public:
 		    typedef MapBase<typename M1::Key, bool> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    /// Constructor
 		    OrMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {}
 		    /// \e
 		    Value operator[](const Key &k) const { return _m1[k]||_m2[k]; }
 		  };
 		  /// Returns an \ref OrMap class
 		  /// This function just returns an \ref OrMap class.
 		  ///
 		  /// For example, if \c m1 and \c m2 are both maps with \c bool values,
 		  /// then <tt>orMap(m1,m2)[x]</tt> will be equal to
 		  /// <tt>m1[x]||m2[x]</tt>.
 		  ///
 		  /// \relates OrMap
 		  template<typename M1, typename M2>
 		  inline OrMap<M1, M2> orMap(const M1 &m1, const M2 &m2) {
 		    return OrMap<M1, M2>(m1,m2);
+		  }
 		  /// Logical 'not' of a map
-		  /// This \ref concepts::ReadMap "read only map" returns the logical
+		  /// 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.
 		  ///
 		  /// The simplest way of using this map is through the notMap()
 		  /// function.
 		  ///
@@ -1388,10 +1568,106 @@
 		  /// \relates NotWriteMap
 		  template <typename M>
 		  inline NotWriteMap<M> notWriteMap(M &m) {
 		    return NotWriteMap<M>(m);
+		  }
 		  /// Combination of two maps using the \c == operator
 		  /// This \ref concepts::ReadMap "read-only map" assigns \c true to
 		  /// the keys for which the corresponding values of the two maps are
 		  /// equal.
 		  /// Its \c Key type is inherited from \c M1 and its \c Value type is
 		  /// \c bool. \c M2::Key must be convertible to \c M1::Key.
 		  ///
 		  /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for
 		  /// \code
 		  ///   EqualMap<M1,M2> em(m1,m2);
 		  /// \endcode
 		  /// <tt>em[x]</tt> will be equal to <tt>m1[x]==m2[x]</tt>.
 		  ///
 		  /// The simplest way of using this map is through the equalMap()
 		  /// function.
 		  ///
 		  /// \sa LessMap
 		  template<typename M1, typename M2>
 		  class EqualMap : public MapBase<typename M1::Key, bool> {
 		    const M1 &_m1;
 		    const M2 &_m2;
 		  public:
 		    typedef MapBase<typename M1::Key, bool> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    /// Constructor
 		    EqualMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {}
 		    /// \e
 		    Value operator[](const Key &k) const { return _m1[k]==_m2[k]; }
 		  };
 		  /// Returns an \ref EqualMap class
 		  /// This function just returns an \ref EqualMap class.
 		  ///
 		  /// For example, if \c m1 and \c m2 are maps with keys and values of
 		  /// the same type, then <tt>equalMap(m1,m2)[x]</tt> will be equal to
 		  /// <tt>m1[x]==m2[x]</tt>.
 		  ///
 		  /// \relates EqualMap
 		  template<typename M1, typename M2>
 		  inline EqualMap<M1, M2> equalMap(const M1 &m1, const M2 &m2) {
 		    return EqualMap<M1, M2>(m1,m2);
+		  }
 		  /// Combination of two maps using the \c < operator
 		  /// This \ref concepts::ReadMap "read-only map" assigns \c true to
 		  /// the keys for which the corresponding value of the first map is
 		  /// less then the value of the second map.
 		  /// Its \c Key type is inherited from \c M1 and its \c Value type is
 		  /// \c bool. \c M2::Key must be convertible to \c M1::Key.
 		  ///
 		  /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for
 		  /// \code
 		  ///   LessMap<M1,M2> lm(m1,m2);
 		  /// \endcode
 		  /// <tt>lm[x]</tt> will be equal to <tt>m1[x]<m2[x]</tt>.
 		  ///
 		  /// The simplest way of using this map is through the lessMap()
 		  /// function.
 		  ///
 		  /// \sa EqualMap
 		  template<typename M1, typename M2>
 		  class LessMap : public MapBase<typename M1::Key, bool> {
 		    const M1 &_m1;
 		    const M2 &_m2;
 		  public:
 		    typedef MapBase<typename M1::Key, bool> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    /// Constructor
 		    LessMap(const M1 &m1, const M2 &m2) : _m1(m1), _m2(m2) {}
 		    /// \e
 		    Value operator[](const Key &k) const { return _m1[k]<_m2[k]; }
 		  };
 		  /// Returns an \ref LessMap class
 		  /// This function just returns an \ref LessMap class.
 		  ///
 		  /// For example, if \c m1 and \c m2 are maps with keys and values of
 		  /// the same type, then <tt>lessMap(m1,m2)[x]</tt> will be equal to
 		  /// <tt>m1[x]<m2[x]</tt>.
 		  ///
 		  /// \relates LessMap
 		  template<typename M1, typename M2>
 		  inline LessMap<M1, M2> lessMap(const M1 &m1, const M2 &m2) {
 		    return LessMap<M1, M2>(m1,m2);
+		  }
 		  /// @}
+		}
 		#endif // LEMON_MAPS_H

test/maps_test.cc

Show inline comments

@@ -250,19 +250,43 @@
 		    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
+		  // Logical maps:
 		  // - TrueMap, FalseMap
 		  // - AndMap, OrMap
 		  // - NotMap, NotWriteMap
 		  // - EqualMap, LessMap
+		  {
 		    checkConcept<BoolMap, TrueMap<A> >();
 		    checkConcept<BoolMap, FalseMap<A> >();
 		    checkConcept<BoolMap, AndMap<BoolMap,BoolMap> >();
 		    checkConcept<BoolMap, OrMap<BoolMap,BoolMap> >();
 		    checkConcept<BoolMap, NotMap<BoolMap> >();
 		    checkConcept<BoolWriteMap, NotWriteMap<BoolWriteMap> >();
 		    checkConcept<BoolMap, EqualMap<DoubleMap,DoubleMap> >();
 		    checkConcept<BoolMap, LessMap<DoubleMap,DoubleMap> >();
 		    TrueMap<int> tm;
 		    FalseMap<int> fm;
 		    RangeMap<bool> 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");
 		    check(andMap(tm,rm)[0] && !andMap(tm,rm)[1] && !andMap(fm,rm)[0] && !andMap(fm,rm)[1],
 		          "Something is wrong with AndMap");
 		    check(orMap(tm,rm)[0] && orMap(tm,rm)[1] && orMap(fm,rm)[0] && !orMap(fm,rm)[1],
 		          "Something is wrong with OrMap");
 		    check(!notMap(rm)[0] && notMap(rm)[1], "Something is wrong with NotMap");
 		    check(!notWriteMap(rm)[0] && notWriteMap(rm)[1], "Something is wrong with NotWriteMap");
 		    ConstMap<int, double> cm(2.0);
 		    IdentityMap<int> im;
 		    ConvertMap<IdentityMap<int>, double> id(im);
 		    check(lessMap(id,cm)[1] && !lessMap(id,cm)[2] && !lessMap(id,cm)[3],
 		          "Something is wrong with LessMap");
 		    check(!equalMap(id,cm)[1] && equalMap(id,cm)[2] && !equalMap(id,cm)[3],
 		          "Something is wrong with EqualMap");
+		  }
 		  return 0;
+		}

0 comments (0 inline)

RhodeCode

Login to your account