RhodeCode

/* -*- mode: C++; indent-tabs-mode: nil; -*-

 *

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

 *

 * Copyright (C) 2003-2009

 * 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/core.h>

///\file

///\ingroup maps

///\brief Miscellaneous property maps

namespace lemon {

  /// \addtogroup maps

  /// @{

  /// Base class of maps.

  /// Base class of maps. It provides the necessary type definitions

  /// required by the map %concepts.

  template<typename K, typename V>

  class MapBase {

  public:

    /// \brief The key type of the map.

    typedef K Key;

    /// \brief The value type of the map.

    /// (The type of objects associated with the keys).

    typedef V 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,

      explicit InverseMap(const IdMap& map) : _graph(map._graph) {}

      /// \brief Gives back the given item from its id.

      ///

      /// Gives back the given item from its id.

      Item operator[](int id) const { return _graph->fromId(id, Item());}

    private:

      const Graph* _graph;

    };

    /// \brief Gives back the inverse of the map.

    ///

    /// Gives back the inverse of the IdMap.

    InverseMap inverse() const { return InverseMap(*_graph);}

  };

  /// \brief General cross reference graph map type.

  /// This class provides simple invertable graph maps.

  /// It wraps an arbitrary \ref concepts::ReadWriteMap "ReadWriteMap"

  /// and if a key is set to a new value then store it

  /// in the inverse map.

  /// The values of the map can be accessed

  /// with stl compatible forward iterator.

  ///

  /// \tparam GR The graph type.

  /// \tparam K The key type of the map (\c GR::Node, \c GR::Arc or

  /// \c GR::Edge).

  /// \tparam V The value type of the map.

  ///

  /// \see IterableValueMap

  template <typename GR, typename K, typename V>

  class CrossRefMap

    : protected ItemSetTraits<GR, K>::template Map<V>::Type {

  private:

    typedef typename ItemSetTraits<GR, K>::

      template Map<V>::Type Map;

    typedef std::map<V, K> Container;

    Container _inv_map;

  public:

    /// The graph type of CrossRefMap.

    typedef GR Graph;

    typedef GR Digraph;

    /// The key type of CrossRefMap (\c Node, \c Arc or \c Edge).

    typedef K Item;

      /// that the descriptor currently belongs to.

      Value operator[](const Key& key) const {

        return _inverted(key);

      }

      /// \brief Size of the map.

      ///

      /// Returns the size of the map.

      unsigned int size() const {

        return _inverted.size();

      }

    private:

      const RangeIdMap& _inverted;

    };

    /// \brief Gives back the inverse of the map.

    ///

    /// Gives back the inverse of the map.

    const InverseMap inverse() const {

      return InverseMap(*this);

    }

  };

  ///

  ///

  class IterableBoolMap

  private:

    typedef GR Graph;

    int _sep;

  public:

    typedef True ReferenceMapTag;

    /// The key type

    /// The value type

    typedef bool Value;

    /// The const reference type.

    typedef const Value& ConstReference;

  private:

    int position(const Key& key) const {

      return Parent::operator[](key);

    }

  public:

    ///

    class Reference {

      friend class IterableBoolMap;

    private:

      Reference(IterableBoolMap& map, const Key& key)

        : _key(key), _map(map) {}

    public:

      Reference& operator=(const Reference& value) {

        _map.set(_key, static_cast<bool>(value));

         return *this;

      }

      operator bool() const {

        return static_cast<const IterableBoolMap&>(_map)[_key];

      }

      Reference& operator=(bool value) {

        _map.set(_key, value);

        return *this;

      }

      Reference& operator&=(bool value) {

        _map.set(_key, _map[_key] & value);

        return *this;

      }

        _array[_sep] = key;

        Parent::set(key, _sep);

        _array[pos] = tmp;

        Parent::set(tmp, pos);

        ++_sep;

      } else {

        if (pos >= _sep) return;

        --_sep;

        Key tmp = _array[_sep];

        _array[_sep] = key;

        Parent::set(key, _sep);

        _array[pos] = tmp;

        Parent::set(tmp, pos);

      }

    }

    /// \brief Set all items.

    ///

    /// Set all items in the map.

    /// \note Constant time operation.

    void setAll(bool value) {

      _sep = (value ? _array.size() : 0);

    }

    ///

    int trueNum() const {

      return _sep;

    }

    ///

    int falseNum() const {

      return _array.size() - _sep;

    }

    ///

    /// the key type of the map, incremented with \c ++ operator, and

    /// \c INVALID.

    class TrueIt : public Key {

    public:

      typedef Key Parent;

      /// \brief Creates an iterator.

      ///

      /// Creates an iterator. It iterates on the

      explicit TrueIt(const IterableBoolMap& map)

        : Parent(map._sep > 0 ? map._array[map._sep - 1] : INVALID),

          _map(&map) {}

      /// \brief Invalid constructor \& conversion.

      ///

      /// \sa Invalid for more details.

      TrueIt(Invalid) : Parent(INVALID), _map(0) {}

      /// \brief Increment operator.

      ///

      TrueIt& operator++() {

        int pos = _map->position(*this);

        Parent::operator=(pos > 0 ? _map->_array[pos - 1] : INVALID);

        return *this;

      }

    private:

      const IterableBoolMap* _map;

    };

    ///

    /// the key type of the map, incremented with \c ++ operator, and

    /// \c INVALID.

    class FalseIt : public Key {

    public:

      typedef Key Parent;

      /// \brief Creates an iterator.

      ///

      /// Creates an iterator. It iterates on the

      explicit FalseIt(const IterableBoolMap& map)

        : Parent(map._sep < int(map._array.size()) ?

                 map._array.back() : INVALID), _map(&map) {}

      /// \brief Invalid constructor \& conversion.

      ///

      /// \sa Invalid for more details.

      FalseIt(Invalid) : Parent(INVALID), _map(0) {}

      /// \brief Increment operator.

      ///

      FalseIt& operator++() {

        int pos = _map->position(*this);

        Parent::operator=(pos > _map->_sep ? _map->_array[pos - 1] : INVALID);

        return *this;

      }

    private:

      const IterableBoolMap* _map;

    };

    /// \brief Iterator for the keys mapped to a given value.

    ///

    /// Iterator for the keys mapped to a given value. It works

    /// the key type of the map, incremented with \c ++ operator, and

    /// \c INVALID.

    class ItemIt : public Key {

    public:

      typedef Key Parent;

      ///

      ItemIt(const IterableBoolMap& map, bool value)

        : Parent(value ? 

                 (map._sep > 0 ?

                  map._array[map._sep - 1] : INVALID) :

                 (map._sep < int(map._array.size()) ?

                  map._array.back() : INVALID)), _map(&map) {}

      /// \brief Invalid constructor \& conversion.

      ///

      /// \sa Invalid for more details.

      ItemIt(Invalid) : Parent(INVALID), _map(0) {}

      /// \brief Increment operator.

      ///

      ItemIt& operator++() {

        int pos = _map->position(*this);

        int _sep = pos >= _map->_sep ? _map->_sep : 0;

        Parent::operator=(pos > _sep ? _map->_array[pos - 1] : INVALID);

        return *this;

      }

    private:

      const IterableBoolMap* _map;

    };

  protected:

    virtual void add(const Key& key) {

      Parent::add(key);

      Parent::set(key, _array.size());

      _array.push_back(key);

    }

    virtual void add(const std::vector<Key>& keys) {

      Parent::add(keys);

      for (int i = 0; i < int(keys.size()); ++i) {

        Parent::set(keys[i], _array.size());

        _array.push_back(keys[i]);

        _array.push_back(it);

      }

      _sep = 0;

    }

    virtual void clear() {

      _array.clear();

      _sep = 0;

      Parent::clear();

    }

  };

  namespace _maps_bits {

    template <typename Item>

    struct IterableIntMapNode {

      IterableIntMapNode() : value(-1) {}

      IterableIntMapNode(int _value) : value(_value) {}

      Item prev, next;

      int value;

    };

  }

  /// \brief Dynamic iterable integer map.

  ///

  ///

  /// value in the map.

  ///

  class IterableIntMap

  public:

    /// The key type

    /// The value type

    typedef int Value;

    /// The graph type

    typedef GR Graph;

    /// \brief Constructor of the map.

    ///

    explicit IterableIntMap(const Graph& graph)

      : Parent(graph) {}

    /// \brief Constructor of the map with a given value.

    ///

    /// Constructor of the map with a given value.

    explicit IterableIntMap(const Graph& graph, int value)

      if (value >= 0) {

        for (typename Parent::ItemIt it(*this); it != INVALID; ++it) {

          lace(it);

        }

      }

    }

  private:

    void unlace(const Key& key) {

      typename Parent::Value& node = Parent::operator[](key);

      if (node.value < 0) return;

      if (node.prev != INVALID) {

        Parent::operator[](node.prev).next = node.next;

      } else {

        _first[node.value] = node.next;

      }

      if (node.next != INVALID) {

        Parent::operator[](node.next).prev = node.prev;

      }

      while (!_first.empty() && _first.back() == INVALID) {

        _first.pop_back();

      }

    }

    void lace(const Key& key) {

      typename Parent::Value& node = Parent::operator[](key);

      if (node.value < 0) return;

      if (node.value >= int(_first.size())) {

        _first.resize(node.value + 1, INVALID);

      }

      node.prev = INVALID;

      node.next = _first[node.value];

      if (node.next != INVALID) {

        Parent::operator[](node.next).prev = key;

      }

      _first[node.value] = key;

    }

  public:

    typedef True ReferenceMapTag;

    ///

    class Reference {

      friend class IterableIntMap;

    private:

      Reference(IterableIntMap& map, const Key& key)

        : _key(key), _map(map) {}

    public:

      Reference& operator=(const Reference& value) {

        _map.set(_key, static_cast<const int&>(value));

         return *this;

      }

      operator const int&() const {

        return static_cast<const IterableIntMap&>(_map)[_key];

      }

      Reference& operator=(int value) {

        _map.set(_key, value);

        return *this;

      }

      Reference& operator++() {

        _map.set(_key, _map[_key] + 1);

        return *this;

      }

    /// Set operation of the map.

    void set(const Key& key, const Value& value) {

      unlace(key);

      Parent::operator[](key).value = value;

      lace(key);

    }

    /// \brief Const subscript operator of the map.

    ///

    /// Const subscript operator of the map.

    const Value& operator[](const Key& key) const {

      return Parent::operator[](key).value;

    }

    /// \brief Subscript operator of the map.

    ///

    /// Subscript operator of the map.

    Reference operator[](const Key& key) {

      return Reference(*this, key);

    }

    /// \brief Iterator for the keys with the same value.

    ///

    /// Iterator for the keys with the same value. It works

    /// the item type of the map, incremented with \c ++ operator, and

    /// \c INVALID.

    public:

      /// \brief Invalid constructor \& conversion.

      ///

      /// \sa Invalid for more details.

      ItemIt(Invalid) : Parent(INVALID), _map(0) {}

      /// \brief Creates an iterator with a value.

      ///

      /// Creates an iterator with a value. It iterates on the

      ItemIt(const IterableIntMap& map, int value) : _map(&map) {

        if (value < 0 || value >= int(_map->_first.size())) {

          Parent::operator=(INVALID);

        } else {

          Parent::operator=(_map->_first[value]);

        }

      }

      /// \brief Increment operator.

      ///

      ItemIt& operator++() {

        Parent::operator=(_map->IterableIntMap::Parent::

                          operator[](static_cast<Parent&>(*this)).next);

        return *this;

      }

    private:

      const IterableIntMap* _map;

    };

  protected:

    virtual void erase(const Key& key) {

      unlace(key);

      Parent::erase(key);

    }

    virtual void erase(const std::vector<Key>& keys) {

      for (int i = 0; i < int(keys.size()); ++i) {

        unlace(keys[i]);

      }

      Parent::erase(keys);

    }

    virtual void clear() {

      _first.clear();

      Parent::clear();

    }

  private:

  };

  namespace _maps_bits {

    template <typename Item, typename Value>

    struct IterableValueMapNode {

      IterableValueMapNode(Value _value = Value()) : value(_value) {}

      Item prev, next;

      Value value;

    };

  }

  /// \brief Dynamic iterable map for comparable values.

  ///

  /// the items which mapped to the value, and the values are stored

  /// in balanced binary tree. The values of the map can be accessed

  /// with stl compatible forward iterator.

  ///

  /// the subscription operator.

  ///

  ///

  class IterableValueMap

  public:

    /// The key type

    /// The value type

    /// The graph type

    typedef GR Graph;

  public:

    ///

    explicit IterableValueMap(const Graph& graph,

                              const Value& value = Value())

      for (typename Parent::ItemIt it(*this); it != INVALID; ++it) {

        lace(it);

      }

    }

  protected:

    void unlace(const Key& key) {

      typename Parent::Value& node = Parent::operator[](key);

      if (node.prev != INVALID) {

        Parent::operator[](node.prev).next = node.next;

      } else {

        if (node.next != INVALID) {

          _first[node.value] = node.next;

        } else {

          _first.erase(node.value);

        }

      }

      if (node.next != INVALID) {

        Parent::operator[](node.next).prev = node.prev;

      }

    }

    void lace(const Key& key) {

      typename Parent::Value& node = Parent::operator[](key);

      typename std::map<Value, Key>::iterator it = _first.find(node.value);

      if (it == _first.end()) {

        node.prev = node.next = INVALID;

        _first.insert(std::make_pair(node.value, key));

      } else {

        node.prev = INVALID;

        node.next = it->second;

        if (node.next != INVALID) {

          Parent::operator[](node.next).prev = key;

        }

        it->second = key;

      }

    }

  public:

    /// \brief Forward iterator for values.

    ///

    /// This iterator is an stl compatible forward

    /// iterator on the values of the map. The values can

    class ValueIterator

      : public std::iterator<std::forward_iterator_tag, Value> {

      friend class IterableValueMap;

    private:

      ValueIterator(typename std::map<Value, Key>::const_iterator _it)

        : it(_it) {}

    public:

      ValueIterator() {}

      ValueIterator& operator++() { ++it; return *this; }

      ValueIterator operator++(int) {

        ValueIterator tmp(*this);

        operator++();

        return tmp;

      }

      const Value& operator*() const { return it->first; }

      const Value* operator->() const { return &(it->first); }

      bool operator==(ValueIterator jt) const { return it == jt.it; }

      bool operator!=(ValueIterator jt) const { return it != jt.it; }

    private:

      typename std::map<Value, Key>::const_iterator it;

    };

    /// \brief Returns an iterator to the first value.

    ///

    /// Returns an stl compatible iterator to the

    /// first value of the map. The values of the

    /// range.

    ValueIterator beginValue() const {

      return ValueIterator(_first.begin());

    }

    /// \brief Returns an iterator after the last value.

    ///

    /// Returns an stl compatible iterator after the

    /// last value of the map. The values of the

    /// range.

    ValueIterator endValue() const {

      return ValueIterator(_first.end());

    }

    /// \brief Set operation of the map.

    ///

    /// Set operation of the map.

    void set(const Key& key, const Value& value) {

      unlace(key);

      Parent::operator[](key).value = value;

      lace(key);

    }

    /// \brief Const subscript operator of the map.

    ///

    /// Const subscript operator of the map.

    const Value& operator[](const Key& key) const {

      return Parent::operator[](key).value;

    }

    /// \brief Iterator for the keys with the same value.

    ///

    /// Iterator for the keys with the same value. It works

    /// the item type of the map, incremented with \c ++ operator, and

    /// \c INVALID.

    public:

      /// \brief Invalid constructor \& conversion.

      ///

      /// \sa Invalid for more details.

      ItemIt(Invalid) : Parent(INVALID), _map(0) {}

      /// \brief Creates an iterator with a value.

      ///

      /// Creates an iterator with a value. It iterates on the

      /// keys which have the given value.

      /// \param map The IterableValueMap

      /// \param value The value

      ItemIt(const IterableValueMap& map, const Value& value) : _map(&map) {

        typename std::map<Value, Key>::const_iterator it =

          map._first.find(value);

        if (it == map._first.end()) {

          Parent::operator=(INVALID);

        } else {

          Parent::operator=(it->second);

        }

      }

      /// \brief Increment operator.

      ///

      /// Increment Operator.

      ItemIt& operator++() {

        Parent::operator=(_map->IterableValueMap::Parent::

/* -*- mode: C++; indent-tabs-mode: nil; -*-

 *

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

 *

 * Copyright (C) 2003-2009

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

 *

 */

#include <deque>

#include <set>

#include <lemon/concept_check.h>

#include <lemon/concepts/maps.h>

#include <lemon/maps.h>

#include "test_tools.h"

using namespace lemon;

using namespace lemon::concepts;

struct A {};

inline bool operator<(A, A) { return true; }

struct B {};

class C {

  int x;

public:

  C(int _x) : x(_x) {}

};

class F {

public:

  typedef A argument_type;

  typedef B result_type;

  B operator()(const A&) const { return B(); }

private:

  F& operator=(const F&);

      map1(std::back_inserter(v1));

    LoggerBoolMap<vec::iterator> map2(v2.begin());

    map1.set(10, false);

    map1.set(20, true);   map2.set(20, true);

    map1.set(30, false);  map2.set(40, false);

    map1.set(50, true);   map2.set(50, true);

    map1.set(60, true);   map2.set(60, true);

    check(v1.size() == 3 && v2.size() == 10 &&

          v1[0]==20 && v1[1]==50 && v1[2]==60 &&

          v2[0]==20 && v2[1]==50 && v2[2]==60,

          "Something is wrong with LoggerBoolMap");

    int i = 0;

    for ( LoggerBoolMap<vec::iterator>::Iterator it = map2.begin();

          it != map2.end(); ++it )

      check(v1[i++] == *it, "Something is wrong with LoggerBoolMap");

  }

  // Iterable bool map

  {

    typedef SmartGraph Graph;

    typedef SmartGraph::Node Item;

    typedef IterableBoolMap<SmartGraph, SmartGraph::Node> Ibm;

    const int num = 10;

    Graph g;

    std::vector<Item> items;

    for (int i = 0; i < num; ++i) {

      items.push_back(g.addNode());

    }

    Ibm map1(g, true);

    int n = 0;

    for (Ibm::TrueIt it(map1); it != INVALID; ++it) {

      check(map1[static_cast<Item>(it)], "Wrong TrueIt");

      ++n;

    }

    check(n == num, "Wrong number");

    n = 0;

    for (Ibm::ItemIt it(map1, true); it != INVALID; ++it) {

        check(map1[static_cast<Item>(it)], "Wrong ItemIt for true");

        ++n;

    }

    check(n == num, "Wrong number");

    check(Ibm::FalseIt(map1) == INVALID, "Wrong FalseIt");

    check(Ibm::ItemIt(map1, false) == INVALID, "Wrong ItemIt for false");

    n = 0;

    for (Ibm::TrueIt it(map1); it != INVALID; ++it) {

        check(map1[static_cast<Item>(it)], "Wrong TrueIt for true");

        ++n;

    }

    check(n == num - 3, "Wrong number");

    check(map1.trueNum() == num - 3, "Wrong number");

    n = 0;

    for (Ibm::FalseIt it(map1); it != INVALID; ++it) {

        check(!map1[static_cast<Item>(it)], "Wrong FalseIt for true");

        ++n;

    }

    check(n == 3, "Wrong number");

    check(map1.falseNum() == 3, "Wrong number");

  }

  // Iterable int map

  {

    typedef SmartGraph Graph;

    typedef SmartGraph::Node Item;

    typedef IterableIntMap<SmartGraph, SmartGraph::Node> Iim;

    const int num = 10;

    Graph g;

    std::vector<Item> items;

    for (int i = 0; i < num; ++i) {

      items.push_back(g.addNode());

    }

    Iim map1(g);

    check(map1.size() == 0, "Wrong size");

    for (int i = 0; i < num; ++i) {

      map1[items[i]] = i;

    }

    check(map1.size() == num, "Wrong size");

    for (int i = 0; i < num; ++i) {

      Iim::ItemIt it(map1, i);

      check(static_cast<Item>(it) == items[i], "Wrong value");

      ++it;

      check(static_cast<Item>(it) == INVALID, "Wrong value");

    }

    for (int i = 0; i < num; ++i) {

      map1[items[i]] = i % 2;

    }

    check(map1.size() == 2, "Wrong size");

    int n = 0;

    for (Iim::ItemIt it(map1, 0); it != INVALID; ++it) {