RhodeCode

  }

  /// @}

  /// \addtogroup maps

  /// @{

  /// \brief Writable bool map for logging each \c true assigned element

  ///

  /// A \ref concepts::WriteMap "writable" bool map for logging

  /// each \c true assigned element, i.e it copies subsequently each

  /// keys set to \c true to the given iterator.

  /// The most important usage of it is storing certain nodes or arcs

  /// that were marked \c true by an algorithm.

  ///

  /// There are several algorithms that provide solutions through bool

  /// maps and most of them assign \c true at most once for each key.

  /// In these cases it is a natural request to store each \c true

  /// assigned elements (in order of the assignment), which can be

  /// easily done with LoggerBoolMap.

  ///

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

  /// function.

  ///

  /// \tparam IT The type of the iterator.

  /// \tparam KEY The key type of the map. The default value set

  /// according to the iterator type should work in most cases.

  ///

  /// \note The container of the iterator must contain enough space

  /// for the elements or the iterator should be an inserter iterator.

#ifdef DOXYGEN

  template <typename IT, typename KEY>

#else

  template <typename IT,

            typename KEY = typename _maps_bits::IteratorTraits<IT>::Value>

#endif

  class LoggerBoolMap : public MapBase<KEY, bool> {

  public:

    ///\e

    typedef KEY Key;

    ///\e

    typedef bool Value;

    ///\e

    typedef IT Iterator;

    /// Constructor

    LoggerBoolMap(Iterator it)

      : _begin(it), _end(it) {}

    /// Gives back the given iterator set for the first key

    Iterator begin() const {

      return _begin;

    }

    /// Gives back the the 'after the last' iterator

    Iterator end() const {

      return _end;

    }

    /// The set function of the map

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

      if (value) {

        *_end++ = key;

      }

    }

  private:

    Iterator _begin;

    Iterator _end;

  };

  /// Returns a \c LoggerBoolMap class

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

  ///

  /// The most important usage of it is storing certain nodes or arcs

  /// that were marked \c true by an algorithm.

  /// For example it makes easier to store the nodes in the processing

  /// order of Dfs algorithm, as the following examples show.

  /// \code

  ///   std::vector<Node> v;

  ///   dfs(g,s).processedMap(loggerBoolMap(std::back_inserter(v))).run();

  /// \endcode

  /// \code

  ///   std::vector<Node> v(countNodes(g));

  ///   dfs(g,s).processedMap(loggerBoolMap(v.begin())).run();

  /// \endcode

  ///

  /// \note The container of the iterator must contain enough space

  /// for the elements or the iterator should be an inserter iterator.

  ///

  /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so

  /// it cannot be used when a readable map is needed, for example as

  /// \c ReachedMap for \c Bfs, \c Dfs and \c Dijkstra algorithms.

  ///

  /// \relates LoggerBoolMap

  template<typename Iterator>

  inline LoggerBoolMap<Iterator> loggerBoolMap(Iterator it) {

    return LoggerBoolMap<Iterator>(it);

  }

  /// @}

  /// \addtogroup graph_maps

  /// @{

  /// \brief Provides an immutable and unique id for each item in a graph.

  ///

  /// IdMap provides a unique and immutable id for each item of the

  /// same type (\c Node, \c Arc or \c Edge) in a graph. This id is

  ///  - \b unique: different items get different ids,

  ///  - \b immutable: the id of an item does not change (even if you

  ///    delete other nodes).

  ///

  /// Using this map you get access (i.e. can read) the inner id values of

  /// the items stored in the graph, which is returned by the \c id()

  /// function of the graph. This map can be inverted with its member

  /// class \c InverseMap or with the \c operator()() member.

  ///

  /// \tparam GR The graph type.

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

  /// \c GR::Edge).

  ///

  /// \see RangeIdMap

  template <typename GR, typename K>

  class IdMap : public MapBase<K, int> {

  public:

    /// The graph type of IdMap.

    typedef GR Graph;

    typedef GR Digraph;

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

    typedef K Item;

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

    typedef K Key;

    /// The value type of IdMap.

    typedef int Value;

    /// \brief Constructor.

    ///

    /// Constructor of the map.

    explicit IdMap(const Graph& graph) : _graph(&graph) {}

    /// \brief Gives back the \e id of the item.

    ///

    /// Gives back the immutable and unique \e id of the item.

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

    /// \brief Gives back the \e item by its id.

    ///

    /// Gives back the \e item by its id.

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

  private:

    const Graph* _graph;

  public:

    /// \brief The inverse map type of IdMap.

    ///

    /// The inverse map type of IdMap. The subscript operator gives back

    /// an item by its id.

    /// This type conforms to the \ref concepts::ReadMap "ReadMap" concept.

    /// \see inverse()

    class InverseMap {

    public:

      /// \brief Constructor.

      ///

      /// Constructor for creating an id-to-item map.

      explicit InverseMap(const Graph& graph) : _graph(&graph) {}

      /// \brief Constructor.

      ///

      /// Constructor for creating an id-to-item map.

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

      /// \brief Gives back an item by its id.

      ///

      /// Gives back an item by 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 a standard graph map (\c NodeMap, \c ArcMap or \c EdgeMap)

  /// and if a key is set to a new value, then stores it in the inverse map.

  /// The graph items can be accessed by their values either using

  /// \c InverseMap or \c operator()(), and the values of the map can be

  /// accessed with an STL compatible forward iterator (\c ValueIt).

  /// 

  /// This map is intended to be used when all associated values are

  /// different (the map is actually invertable) or there are only a few

  /// items with the same value.

  /// Otherwise consider to use \c IterableValueMap, which is more 

  /// suitable and more efficient for such cases. It provides iterators

  /// to traverse the items with the same associated value, however

  /// it does not have \c InverseMap.

  ///

  /// This type is not reference map, so it cannot be modified with

  /// the subscript operator.

  ///

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

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

    typedef K Key;

    /// The value type of CrossRefMap.

    typedef V Value;

    /// \brief Constructor.

    ///

    /// Construct a new CrossRefMap for the given graph.

    explicit CrossRefMap(const Graph& graph) : Map(graph) {}

    /// \brief Forward iterator for values.

    ///

    /// This iterator is an STL compatible forward

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

    /// be accessed in the <tt>[beginValue, endValue)</tt> range.

    /// They are considered with multiplicity, so each value is

    /// traversed for each item it is assigned to.

    class ValueIt

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

      friend class CrossRefMap;

    private:

      ValueIt(typename Container::const_iterator _it)

        : it(_it) {}

    public:

      /// Constructor

      ValueIt() {}

      /// \e

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

      /// \e

      ValueIt operator++(int) {

        ValueIt tmp(*this);

        operator++();

        return tmp;

      }

      /// \e

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

      /// \e

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

      /// \e

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

      /// \e

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

    private:

      typename Container::const_iterator it;

    };

    /// Alias for \c ValueIt

    typedef ValueIt ValueIterator;

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

    ///

    /// Returns an STL compatible iterator to the

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

    /// map can be accessed in the <tt>[beginValue, endValue)</tt>

    /// range.

    ValueIt beginValue() const {

      return ValueIt(_inv_map.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

    /// map can be accessed in the <tt>[beginValue, endValue)</tt>

    /// range.

    ValueIt endValue() const {

      return ValueIt(_inv_map.end());

    }

    /// \brief Sets the value associated with the given key.

    ///

    /// Sets the value associated with the given key.

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

      Value oldval = Map::operator[](key);

      typename Container::iterator it;

      for (it = _inv_map.equal_range(oldval).first;

           it != _inv_map.equal_range(oldval).second; ++it) {

        if (it->second == key) {

          _inv_map.erase(it);

          break;

        }

      }

      _inv_map.insert(std::make_pair(val, key));

      Map::set(key, val);

    }

    /// \brief Returns the value associated with the given key.

    ///

    /// Returns the value associated with the given key.

    typename MapTraits<Map>::ConstReturnValue

    operator[](const Key& key) const {

      return Map::operator[](key);

    }

    /// \brief Gives back an item by its value.

    ///

    /// This function gives back an item that is assigned to

    /// the given value or \c INVALID if no such item exists.

    /// If there are more items with the same associated value,

    /// only one of them is returned.

    Key operator()(const Value& val) const {

      typename Container::const_iterator it = _inv_map.find(val);

      return it != _inv_map.end() ? it->second : INVALID;

    }

    /// \brief Returns the number of items with the given value.

    ///

    /// This function returns the number of items with the given value

    /// associated with it.

    int count(const Value &val) const {

      return _inv_map.count(val);

    }

  protected:

    /// \brief Erase the key from the map and the inverse map.

    ///

    /// Erase the key from the map and the inverse map. It is called by the

    /// \c AlterationNotifier.

    virtual void erase(const Key& key) {

      Value val = Map::operator[](key);

      typename Container::iterator it;

      for (it = _inv_map.equal_range(val).first;

           it != _inv_map.equal_range(val).second; ++it) {

        if (it->second == key) {

          _inv_map.erase(it);

          break;

        }

      }

      Map::erase(key);

    }

    /// \brief Erase more keys from the map and the inverse map.

    ///

    /// Erase more keys from the map and the inverse map. It is called by the

    /// \c AlterationNotifier.

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

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

        Value val = Map::operator[](keys[i]);

        typename Container::iterator it;

        for (it = _inv_map.equal_range(val).first;

             it != _inv_map.equal_range(val).second; ++it) {

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

  /// \c GR::Edge).

  ///

  /// \see IdMap

  template <typename GR, typename K>

  class RangeIdMap

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

    typedef typename ItemSetTraits<GR, K>::template Map<int>::Type Map;

  public:

    /// The graph type of RangeIdMap.

    typedef GR Graph;

    typedef GR Digraph;

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

    typedef K Item;

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

    typedef K Key;

    /// The value type of RangeIdMap.

    typedef int Value;

    /// \brief Constructor.

    ///

    /// Constructor.

    explicit RangeIdMap(const Graph& gr) : Map(gr) {

      Item it;

      const typename Map::Notifier* nf = Map::notifier();

      for (nf->first(it); it != INVALID; nf->next(it)) {

        Map::set(it, _inv_map.size());

        _inv_map.push_back(it);

      }

    }

  protected:

    /// \brief Adds a new key to the map.

    ///

    /// Add a new key to the map. It is called by the

    /// \c AlterationNotifier.

    virtual void add(const Item& item) {

      Map::add(item);

      Map::set(item, _inv_map.size());

      _inv_map.push_back(item);

    }

    /// \brief Add more new keys to the map.

    ///

    /// Add more new keys to the map. It is called by the

    /// \c AlterationNotifier.

    virtual void add(const std::vector<Item>& items) {

      Map::add(items);

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

        Map::set(items[i], _inv_map.size());

        _inv_map.push_back(items[i]);

      }

    }

    /// \brief Erase the key from the map.

    ///

    /// Erase the key from the map. It is called by the

    /// \c AlterationNotifier.

    virtual void erase(const Item& item) {

      Map::set(_inv_map.back(), Map::operator[](item));

      _inv_map[Map::operator[](item)] = _inv_map.back();

      _inv_map.pop_back();

      Map::erase(item);

    }

    /// \brief Erase more keys from the map.

    ///

    /// Erase more keys from the map. It is called by the

    /// \c AlterationNotifier.

    virtual void erase(const std::vector<Item>& items) {

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

        Map::set(_inv_map.back(), Map::operator[](items[i]));

        _inv_map[Map::operator[](items[i])] = _inv_map.back();

        _inv_map.pop_back();

      }

      Map::erase(items);

    }

    /// \brief Build the unique map.

    ///

    /// Build the unique map. It is called by the

    /// \c AlterationNotifier.

    virtual void build() {

      Map::build();

      Item it;

      const typename Map::Notifier* nf = Map::notifier();

      for (nf->first(it); it != INVALID; nf->next(it)) {

        Map::set(it, _inv_map.size());

        _inv_map.push_back(it);

      }

    }

    /// \brief Clear the keys from the map.

    ///

    /// Clear the keys from the map. It is called by the

    /// \c AlterationNotifier.

    virtual void clear() {

      _inv_map.clear();

      Map::clear();

    }

  public:

    /// \brief Returns the maximal value plus one.

    ///

    /// Returns the maximal value plus one in the map.

    unsigned int size() const {

      return _inv_map.size();

    }

    /// \brief Swaps the position of the two items in the map.

    ///

    /// Swaps the position of the two items in the map.

    void swap(const Item& p, const Item& q) {

      int pi = Map::operator[](p);

      int qi = Map::operator[](q);

      Map::set(p, qi);

      _inv_map[qi] = p;

      Map::set(q, pi);

      _inv_map[pi] = q;

    }

    /// \brief Gives back the \e range \e id of the item

    ///

    /// Gives back the \e range \e id of the item.

    int operator[](const Item& item) const {

      return Map::operator[](item);

    }

    /// \brief Gives back the item belonging to a \e range \e id

    ///

    /// Gives back the item belonging to the given \e range \e id.

    Item operator()(int id) const {

      return _inv_map[id];

    }

  private:

    typedef std::vector<Item> Container;

    Container _inv_map;

  public:

    /// \brief The inverse map type of RangeIdMap.

    ///

    /// The inverse map type of RangeIdMap. The subscript operator gives

    /// back an item by its \e range \e id.

    /// This type conforms to the \ref concepts::ReadMap "ReadMap" concept.

    class InverseMap {

    public:

      /// \brief Constructor

      ///

      /// Constructor of the InverseMap.

      explicit InverseMap(const RangeIdMap& inverted)

        : _inverted(inverted) {}

      /// The value type of the InverseMap.

      typedef typename RangeIdMap::Key Value;

      /// The key type of the InverseMap.

      typedef typename RangeIdMap::Value Key;

      /// \brief Subscript operator.

      ///

      /// Subscript operator. It gives back the item

      /// that the given \e range \e id 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 RangeIdMap.

    const InverseMap inverse() const {

      return InverseMap(*this);

    }

  };

  /// \brief Dynamic iterable \c bool map.

  ///

  /// This class provides a special graph map type which can store a

  /// \c bool value for graph items (\c Node, \c Arc or \c Edge).

  /// For both \c true and \c false values it is possible to iterate on

  /// the keys mapped to the value.

  ///

  /// This type is a reference map, so it can be modified with the

  /// subscript operator.

  ///

  /// \tparam GR The graph type.

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

  /// \c GR::Edge).

  ///

  /// \see IterableIntMap, IterableValueMap

  /// \see CrossRefMap

  template <typename GR, typename K>

  class IterableBoolMap

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

  private:

    typedef GR Graph;

    typedef typename ItemSetTraits<GR, K>::ItemIt KeyIt;

    typedef typename ItemSetTraits<GR, K>::template Map<int>::Type Parent;

    std::vector<K> _array;

    int _sep;

  public:

    /// Indicates that the map is reference map.

    typedef True ReferenceMapTag;

    /// The key type

    typedef K Key;

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

    /// \brief Reference to the value of the map.

    ///

    /// This class is similar to the \c bool type. It can be converted to

    /// \c bool and it provides the same operators.

    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;

      }

      Reference& operator|=(bool value) {

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

        return *this;

      }

      Reference& operator^=(bool value) {

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

        return *this;

      }

    private:

      Key _key;

      IterableBoolMap& _map;

    };

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

    ///

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

    explicit IterableBoolMap(const Graph& graph, bool def = false)

      : Parent(graph) {

      typename Parent::Notifier* nf = Parent::notifier();

      Key it;

      for (nf->first(it); it != INVALID; nf->next(it)) {

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

        _array.push_back(it);

      }

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

    }

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

    ///

    /// Const subscript operator of the map.

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

      return position(key) < _sep;

    }

    /// \brief Subscript operator of the map.

    ///

    /// Subscript operator of the map.

    Reference operator[](const Key& key) {

      return Reference(*this, key);

    }

    /// \brief Set operation of the map.

    ///

    /// Set operation of the map.

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

      int pos = position(key);

      if (value) {

        if (pos < _sep) return;

        Key tmp = _array[_sep];

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

    }

    /// \brief Returns the number of the keys mapped to \c true.

    ///

    /// Returns the number of the keys mapped to \c true.

    int trueNum() const {

      return _sep;

    }

    /// \brief Returns the number of the keys mapped to \c false.

    ///

    /// Returns the number of the keys mapped to \c false.

    int falseNum() const {

      return _array.size() - _sep;

    }

    /// \brief Iterator for the keys mapped to \c true.

    ///

    /// Iterator for the keys mapped to \c true. It works

    /// like a graph item iterator, it can be converted to

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

    /// if the iterator leaves the last valid key, it will be equal to

    /// \c INVALID.

    class TrueIt : public Key {

    public:

      typedef Key Parent;

      /// \brief Creates an iterator.

      ///

      /// Creates an iterator. It iterates on the

      /// keys mapped to \c true.

      /// \param map The IterableBoolMap.

      explicit TrueIt(const IterableBoolMap& map)

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

          _map(&map) {}

      /// \brief Invalid constructor \& conversion.

      ///

      /// This constructor initializes the iterator to be invalid.

      /// \sa Invalid for more details.

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

      /// \brief Increment operator.

      ///

      /// Increment operator.