RhodeCode

/* -*- C++ -*-

 *

 * This file is a part of LEMON, a generic C++ optimization library

 *

 * Copyright (C) 2003-2007

 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport

 * (Egervary Research Group on Combinatorial Optimization, EGRES).

 *

 * Permission to use, modify and distribute this software is granted

 * provided that this copyright notice appears in all copies. For

 * precise terms see the accompanying LICENSE file.

 *

 * This software is provided "AS IS" with no warranty of any kind,

 * express or implied, and with no claim as to its suitability for any

 * purpose.

 *

 */

#ifndef LEMON_MAPS_H

#define LEMON_MAPS_H

#include <iterator>

#include <functional>

#include <vector>

#include <lemon/bits/utility.h>

// #include <lemon/bits/traits.h>

///\file

///\ingroup maps

///\brief Miscellaneous property maps

///

#include <map>

namespace lemon {

  /// \addtogroup maps

  /// @{

  /// Base class of maps.

  /// Base class of maps.

  /// It provides the necessary <tt>typedef</tt>s required by the map concept.

  template<typename K, typename T>

  class MapBase {

  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;

  };

  /// Null map. (a.k.a. DoNothingMap)

  /// This map can be used if you have to provide a map only for

  /// its type definitions, or if you have to provide a writable map, 

  /// but data written to it is not required (i.e. it will be sent to 

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

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

  }

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

  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

    /// Default constructor.

    /// The value of the map will be uninitialized. 

    /// (More exactly it will be default constructed.)

    ConstMap() {}

    /// Constructor with specified initial value

    /// Constructor with specified initial value.

    /// \param _v is the initial value of the map.

    ConstMap(const T &_v) : v(_v) {}

    ///\e

    T operator[](const K&) const { return v; }

    ///\e

    void setAll(const T &t) {

      v = t;

    }    

    template<typename T1>

    ConstMap(const ConstMap<K, T1> &, const T &_v) : v(_v) {}

  };

  ///Returns a \c ConstMap class

  ///This function just returns a \c ConstMap class.

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

  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

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

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

    template <typename K1, typename T1, typename C1>

    friend class StdMap;

  public:

    ///\e

    ///\e

    ///\e

    typedef T& Reference;

    ///\e

    typedef const T& ConstReference;

  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.

    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.

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

      typename Map::iterator it = _map.lower_bound(k);

      if (it != _map.end() && !_map.key_comp()(k, it->first))

	return it->second;

      else

	return _map.insert(it, std::make_pair(k, _value))->second;

    }

    /// \e 

    ConstReference operator[](const Key &k) const {

      typename Map::const_iterator it = _map.find(k);

      if (it != _map.end())

	return it->second;

      else

	return _value;

    }

    /// \e 

    void set(const Key &k, const T &t) {

      typename Map::iterator it = _map.lower_bound(k);

      if (it != _map.end() && !_map.key_comp()(k, it->first))

	it->second = t;

      else

	_map.insert(it, std::make_pair(k, t));

    }

    /// \e

    void setAll(const T &t) {

      _value = t;

      _map.clear();

    }    

  };

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

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

  ///

  /// \todo Revise its name

  template <typename T>

    template <typename T1>

    friend class IntegerMap;

  public:

    ///\e

    ///\e

    ///\e

    typedef T& Reference;

    ///\e

    typedef const T& ConstReference;

  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.

    template <typename T1>

    IntegerMap(const std::vector<T1>& vector) 

      : _vector(vector.begin(), vector.end()) {}

    /// \brief Constructs a map from an other 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&);

  public:

    ///\e

    Reference operator[](Key k) {

      return _vector[k];

    }

    /// \e 

    ConstReference operator[](Key k) const {

      return _vector[k];

    }

    /// \e 

    void set(const Key &k, const T& t) {

      _vector[k] = t;

    }

  };

  /// @}

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

    typedef MapBase<T, T> Parent;

    typedef typename Parent::Key Key;

    typedef typename Parent::Value Value;

    /// \e

    const T& operator[](const T& t) const {

      return t;

    }

  };

  ///Returns an \c IdentityMap class

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

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

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

  }

  ///Simple wrapping of a map

  ///This \ref concepts::ReadMap "read only map" returns the simple

  ///wrapping of the given map. Sometimes the reference maps cannot be

  ///combined with simple read maps. This map adaptor wraps the given

  ///map to simple read map.

  ///

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

    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];}

  };

  ///Simple writable wrapping of a map

  ///This \ref 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:

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

  };

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

    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?

  ///

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

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

  ///

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

    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

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

    ///Constructor

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

    typedef typename Parent::Value Value;

    ///Constructor

    SubMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};

    /// \e

    Value operator[](Key k) const {return m1[k]-m2[k];}

  };

  ///Returns a \c SubMap class

  ///This function just returns a \c SubMap class.

  ///

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

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

    ///Constructor

    MulMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};

    /// \e

    Value operator[](Key k) const {return m1[k]*m2[k];}

  };

  ///Returns a \c MulMap class

  ///This function just returns a \c MulMap class.

  ///\relates MulMap

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

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