RhodeCode

  /// Returns a \ref NullMap class

  /// This function just returns a \ref NullMap class.

  /// \relates NullMap

  template <typename K, typename V>

  NullMap<K, V> nullMap() {

    return NullMap<K, V>();

  }

  /// Constant map.

  ///

  /// In other aspects it is equivalent to \ref NullMap.

  /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap"

  /// concept, but it absorbs the data written to it.

  ///

  /// The simplest way of using this map is through the constMap()

  /// function.

  ///

  /// \sa NullMap

  /// \sa IdentityMap

  template<typename K, typename V>

  class ConstMap : public MapBase<K, V> {

  /// \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.

  ///

  /// In other aspects it is equivalent to \ref NullMap.

  /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap"

  /// concept, but it absorbs the data written to it.

  ///

  /// The simplest way of using this map is through the constMap()

  /// function.

  ///

  /// \sa NullMap

  /// \sa IdentityMap

  template<typename K, typename V, V v>

  class ConstMap<K, Const<V, v> > : public MapBase<K, V> {

  /// Returns a \ref ConstMap class with inlined constant value

  /// This function just returns a \ref ConstMap class with inlined

  /// constant value.

  /// \relates ConstMap

  template<typename K, typename V, V v>

  inline ConstMap<K, Const<V, v> > constMap() {

    return ConstMap<K, Const<V, v> >();

  }

  ///

  /// \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.

    }

  };

  /// Returns an \ref IdentityMap class

  /// This function just returns an \ref IdentityMap class.

  /// \relates IdentityMap

  template<typename T>

  inline IdentityMap<T> identityMap() {

    return IdentityMap<T>();

  }

    sparseMap(const std::map<K, V, Compare> &map, const V& value = V())

  {

    return SparseMap<K, V, Compare>(map, value);

  }

  /// @}

  /// \addtogroup map_adaptors

  /// @{

  /// Composition of two maps

  /// 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>.

  ///

  /// The \c Key type of the map is inherited from \c M2 and the

  /// \c Value type is from \c M1.

  /// \c M2::Value must be convertible to \c M1::Key.

  ///

  /// The simplest way of using this map is through the composeMap()

  /// convertible to the \c Key of \c m1, then <tt>composeMap(m1,m2)[x]</tt>

  /// will be equal to <tt>m1[m2[x]]</tt>.

  ///

  /// \relates ComposeMap

  template <typename M1, typename M2>

  inline ComposeMap<M1, M2> composeMap(const M1 &m1, const M2 &m2) {

    return ComposeMap<M1, M2>(m1, m2);

  }

  /// Combination of two maps using an STL (binary) functor.

  /// 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);

  /// \endcode

  /// <tt>cm[x]</tt> will be equal to <tt>f(m1[x],m2[x])</tt>.

  ///

  /// The \c Key type of the map is inherited from \c M1 (\c M1::Key

  /// must be convertible to \c M2::Key) and the \c Value type is \c V.

  /// \c M2::Value and \c M1::Value must be convertible to the

    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);

  }

  /// Converts an STL style (unary) functor to a map

  /// 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

  /// \c result_type typedefs.

  /// Parameter \c F is the type of the used functor.

  ///

  /// The simplest way of using this map is through the functorToMap()

  /// function.

  ///

  /// Returns a \ref ForkMap class

  /// This function just returns a \ref ForkMap class.

  /// \relates ForkMap

  template <typename M1, typename M2>

  inline ForkMap<M1,M2> forkMap(M1 &m1, M2 &m2) {

    return ForkMap<M1,M2>(m1,m2);

  }

  /// Sum of two maps

  /// of the values of the two given maps.

  /// Its \c Key and \c Value types are inherited from \c M1.

  /// The \c Key and \c Value of \c M2 must be convertible to those of

  /// \c M1.

  ///

  /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for

  /// \code

  ///   AddMap<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 addMap()

  /// values, then <tt>addMap(m1,m2)[x]</tt> will be equal to

  /// <tt>m1[x]+m2[x]</tt>.

  ///

  /// \relates AddMap

  template<typename M1, typename M2>

  inline AddMap<M1, M2> addMap(const M1 &m1, const M2 &m2) {

    return AddMap<M1, M2>(m1,m2);

  }

  /// Difference of two maps

  /// of the values of the two given maps.

  /// Its \c Key and \c Value types are inherited from \c M1.

  /// The \c Key and \c Value of \c M2 must be convertible to those of

  /// \c M1.

  ///

  /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for

  /// \code

  ///   SubMap<M1,M2> sm(m1,m2);

  /// \endcode

  /// <tt>sm[x]</tt> will be equal to <tt>m1[x]-m2[x]</tt>.

  ///

  /// The simplest way of using this map is through the subMap()

  /// values, then <tt>subMap(m1,m2)[x]</tt> will be equal to

  /// <tt>m1[x]-m2[x]</tt>.

  ///

  /// \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

  /// of the values of the two given maps.

  /// Its \c Key and \c Value types are inherited from \c M1.

  /// The \c Key and \c Value of \c M2 must be convertible to those of

  /// \c M1.

  ///

  /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for

  /// \code

  ///   MulMap<M1,M2> mm(m1,m2);

  /// \endcode

  /// <tt>mm[x]</tt> will be equal to <tt>m1[x]*m2[x]</tt>.

  ///

  /// The simplest way of using this map is through the mulMap()

  /// values, then <tt>mulMap(m1,m2)[x]</tt> will be equal to

  /// <tt>m1[x]*m2[x]</tt>.

  ///

  /// \relates MulMap

  template<typename M1, typename M2>

  inline MulMap<M1, M2> mulMap(const M1 &m1,const M2 &m2) {

    return MulMap<M1, M2>(m1,m2);

  }

  /// Quotient of two maps

  /// of the values of the two given maps.

  /// Its \c Key and \c Value types are inherited from \c M1.

  /// The \c Key and \c Value of \c M2 must be convertible to those of

  /// \c M1.

  ///

  /// If \c m1 is of type \c M1 and \c m2 is of \c M2, then for

  /// \code

  ///   DivMap<M1,M2> dm(m1,m2);

  /// \endcode

  /// <tt>dm[x]</tt> will be equal to <tt>m1[x]/m2[x]</tt>.

  ///

  /// The simplest way of using this map is through the divMap()

  /// values, then <tt>divMap(m1,m2)[x]</tt> will be equal to

  /// <tt>m1[x]/m2[x]</tt>.

  ///

  /// \relates DivMap

  template<typename M1, typename M2>

  inline DivMap<M1, M2> divMap(const M1 &m1,const M2 &m2) {

    return DivMap<M1, M2>(m1,m2);

  }

  /// Shifts a map with a constant.

  /// 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);

  /// \endcode

  /// is equivalent to

  /// \code

  ///   ConstMap<M::Key, M::Value> cm(v);

  ///   AddMap<M, ConstMap<M::Key, M::Value> > sh(m,cm);

  /// \endcode

  /// <tt>m[x]+v</tt>.

  /// Moreover it makes also possible to write the map.

  ///

  /// \relates ShiftWriteMap

  template<typename M, typename C>

  inline ShiftWriteMap<M, C> shiftWriteMap(M &m, const C &v) {

    return ShiftWriteMap<M, C>(m,v);

  }

  /// Scales a map with a constant.

  /// 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);

  /// \endcode

  /// is equivalent to

  /// \code

  ///   ConstMap<M::Key, M::Value> cm(v);

  ///   MulMap<ConstMap<M::Key, M::Value>, M> sc(cm,m);

  /// \endcode

  /// <tt>v*m[x]</tt>.

  /// Moreover it makes also possible to write the map.

  ///

  /// \relates ScaleWriteMap

  template<typename M, typename C>

  inline ScaleWriteMap<M, C> scaleWriteMap(M &m, const C &v) {

    return ScaleWriteMap<M, C>(m,v);

  }

  /// Negative of a map

  /// 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);

  /// \endcode

  /// is equivalent to

  /// \code

  ///   ScaleMap<M> neg(m,-1);

  /// \endcode

  ///

  /// <tt>negWriteMap(m)[x]</tt> will be equal to <tt>-m[x]</tt>.

  /// Moreover it makes also possible to write the map.

  ///

  /// \relates NegWriteMap

  template <typename M>

  inline NegWriteMap<M> negWriteMap(M &m) {

    return NegWriteMap<M>(m);

  }

  /// Absolute value of a map

  /// value of the values of the given map.

  /// Its \c Key and \c Value are inherited from \c M.

  /// \c Value must be comparable to \c 0 and the unary \c -

  /// operator must be defined for it, of course.

  ///

  /// The simplest way of using this map is through the absMap()

  /// function.

  template<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;

  ///

  /// For example, if \c m is a map with \c double values, then

  /// <tt>absMap(m)[x]</tt> will be equal to <tt>m[x]</tt> if

  /// it is positive or zero and <tt>-m[x]</tt> if <tt>m[x]</tt> is

  /// negative.

  ///

  /// \relates AbsMap

  template<typename M>

  inline AbsMap<M> absMap(const M &m) {

    return AbsMap<M>(m);

  }

  /// Logical 'not' of a map

  /// 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.

  ///

  /// \sa NotWriteMap

  template <typename M>

  class NotMap : public MapBase<typename M::Key, bool> {

    const M &_m;

  public:

    typedef MapBase<typename M::Key, bool> Parent;

  /// This function just returns a \ref NotWriteMap class.

  ///

  /// For example, if \c m is a map with \c bool values, then

  /// <tt>notWriteMap(m)[x]</tt> will be equal to <tt>!m[x]</tt>.

  /// Moreover it makes also possible to write the map.

  ///

  /// \relates NotWriteMap

  template <typename M>

  inline NotWriteMap<M> notWriteMap(M &m) {

    return NotWriteMap<M>(m);

  }

  /// @}

}

#endif // LEMON_MAPS_H

    NullMap<A,B> map2 = map1;

    map1 = nullMap<A,B>();

  }

  // ConstMap

  {

    checkConcept<ReadWriteMap<A,B>, ConstMap<A,B> >();

    ConstMap<A,B> map1;

    ConstMap<A,B> map2(B());

    ConstMap<A,B> map3 = map1;

    map1 = constMap<A>(B());

    map1.setAll(B());

    checkConcept<ReadWriteMap<A,int>, ConstMap<A,int> >();

    check(constMap<A>(10)[A()] == 10, "Something is wrong with ConstMap");

    checkConcept<ReadWriteMap<A,int>, ConstMap<A,Const<int,10> > >();

    ConstMap<A,Const<int,10> > map4;

    ConstMap<A,Const<int,10> > map5 = map4;

    map4 = map5;

    check(map4[A()] == 10 && map5[A()] == 10, "Something is wrong with ConstMap");

  }

  // IdentityMap

  {

    checkConcept<ReadMap<A,A>, IdentityMap<A> >();

    IdentityMap<A> map1;

    IdentityMap<A> map2 = map1;

    map1 = identityMap<A>();

    checkConcept<ReadMap<double,double>, IdentityMap<double> >();

    check(identityMap<double>()[1.0] == 1.0 && identityMap<double>()[3.14] == 3.14,

          "Something is wrong with IdentityMap");

  }

  // RangeMap

  {

    checkConcept<ReferenceMap<int,B,B&,const B&>, RangeMap<B> >();

    RangeMap<B> map1;

    RangeMap<B> map2(10);

    RangeMap<B> map3(10,B());

    RangeMap<B> map4 = map1;

          "Something is wrong with SparseMap");

    map5[1.0] = map6[3.14] = 100;

    check(map5[1.0] == 100 && map5[3.14] == 0 && map6[1.0] == 10 && map6[3.14] == 100,

          "Something is wrong with SparseMap");

  }

  // ComposeMap

  {

    typedef ComposeMap<DoubleMap, ReadMap<B,A> > CompMap;

    checkConcept<ReadMap<B,double>, CompMap>();

    CompMap map1(DoubleMap(),ReadMap<B,A>());

    CompMap map2 = composeMap(DoubleMap(), ReadMap<B,A>());

    SparseMap<double, bool> m1(false); m1[3.14] = true;

    RangeMap<double> m2(2); m2[0] = 3.0; m2[1] = 3.14;

    check(!composeMap(m1,m2)[0] && composeMap(m1,m2)[1], "Something is wrong with ComposeMap")

  }

  // CombineMap

  {

    typedef CombineMap<DoubleMap, DoubleMap, std::plus<double> > CombMap;

    checkConcept<ReadMap<A,double>, CombMap>();

    CombMap map1(DoubleMap(), DoubleMap());

    CombMap map2 = combineMap(DoubleMap(), DoubleMap(), std::plus<double>());

  }

  // ConvertMap

  {

    checkConcept<ReadMap<double,double>, ConvertMap<ReadMap<double, int>, double> >();

    ConvertMap<RangeMap<bool>, int> map1(rangeMap(1, true));

    ConvertMap<RangeMap<bool>, int> map2 = convertMap<int>(rangeMap(2, false));

  }

  // ForkMap

  {

    checkConcept<DoubleWriteMap, ForkMap<DoubleWriteMap, DoubleWriteMap> >();

    typedef RangeMap<double> RM;

    typedef SparseMap<int, double> SM;

    RM m1(10, -1);

    SM m2(-1);

    checkConcept<ReadWriteMap<int, double>, ForkMap<RM, SM> >();

    checkConcept<ReadWriteMap<int, double>, ForkMap<SM, RM> >();

    ForkMap<RM, SM> map1(m1,m2);

    ForkMap<SM, RM> map2 = forkMap(m2,m1);

    map2.set(5, 10);

    check(m1[1] == -1 && m1[5] == 10 && m2[1] == -1 && m2[5] == 10 && map2[1] == -1 && map2[5] == 10,

          "Something is wrong with ForkMap");

  }

  // Arithmetic maps:

  // - AddMap, SubMap, MulMap, DivMap

  // - ShiftMap, ShiftWriteMap, ScaleMap, ScaleWriteMap

  // - NegMap, NegWriteMap, AbsMap

  {

    checkConcept<DoubleMap, AddMap<DoubleMap,DoubleMap> >();

    checkConcept<DoubleMap, SubMap<DoubleMap,DoubleMap> >();

    checkConcept<DoubleMap, MulMap<DoubleMap,DoubleMap> >();

    checkConcept<DoubleMap, DivMap<DoubleMap,DoubleMap> >();

    ConstMap<int, double> c1(1.0), c2(3.14);

    IdentityMap<int> im;

    ConvertMap<IdentityMap<int>, double> id(im);

    check(addMap(c1,id)[0] == 1.0  && addMap(c1,id)[10] == 11.0, "Something is wrong with AddMap");

    check(subMap(id,c1)[0] == -1.0 && subMap(id,c1)[10] == 9.0,  "Something is wrong with SubMap");

    check(mulMap(id,c2)[0] == 0    && mulMap(id,c2)[2]  == 6.28, "Something is wrong with MulMap");

    check(divMap(c2,id)[1] == 3.14 && divMap(c2,id)[2]  == 1.57, "Something is wrong with DivMap");

    checkConcept<DoubleMap, ShiftMap<DoubleMap> >();

    checkConcept<DoubleWriteMap, ShiftWriteMap<DoubleWriteMap> >();

    checkConcept<DoubleMap, ScaleMap<DoubleMap> >();

    checkConcept<DoubleWriteMap, ScaleWriteMap<DoubleWriteMap> >();

    checkConcept<DoubleMap, NegMap<DoubleMap> >();

    checkConcept<DoubleWriteMap, NegWriteMap<DoubleWriteMap> >();

    checkConcept<DoubleMap, AbsMap<DoubleMap> >();

    check(shiftMap(id, 2.0)[1] == 3.0 && shiftMap(id, 2.0)[10] == 12.0,

          "Something is wrong with ShiftMap");

    check(shiftWriteMap(id, 2.0)[1] == 3.0 && shiftWriteMap(id, 2.0)[10] == 12.0,

          "Something is wrong with ShiftWriteMap");

    check(scaleMap(id, 2.0)[1] == 2.0 && scaleMap(id, 2.0)[10] == 20.0,

          "Something is wrong with ScaleMap");

    check(scaleWriteMap(id, 2.0)[1] == 2.0 && scaleWriteMap(id, 2.0)[10] == 20.0,

          "Something is wrong with ScaleWriteMap");

    check(negMap(id)[1] == -1.0 && negMap(id)[-10] == 10.0,

          "Something is wrong with NegMap");

    check(negWriteMap(id)[1] == -1.0 && negWriteMap(id)[-10] == 10.0,

          "Something is wrong with NegWriteMap");

    check(absMap(id)[1] == 1.0 && absMap(id)[-10] == 10.0,

          "Something is wrong with AbsMap");

  }

  {

    checkConcept<BoolMap, NotMap<BoolMap> >();

    checkConcept<BoolWriteMap, NotWriteMap<BoolWriteMap> >();

    RangeMap<bool> rm(2);

    rm[0] = true; rm[1] = false;

  }

  return 0;

}