RhodeCode

  }

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

  ///

  /// Writable bool map for logging each \c true assigned element, i.e it

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

  ///

  /// \note The container of the iterator should contain space 

  /// for each element.

  ///

  /// The following example shows how you can write the edges found by the Prim

  /// algorithm directly

  /// to the standard output.

  ///\code

  /// typedef IdMap<Graph, Edge> EdgeIdMap;

  /// EdgeIdMap edgeId(graph);

  ///

  /// typedef MapFunctor<EdgeIdMap> EdgeIdFunctor;

  /// EdgeIdFunctor edgeIdFunctor(edgeId);

  ///

  /// StoreBoolMap<ostream_iterator<int>, EdgeIdFunctor> 

  ///   writerMap(ostream_iterator<int>(cout, " "), edgeIdFunctor);

  ///

  /// prim(graph, cost, writerMap);

  ///\endcode

  ///

  ///\sa BackInserterBoolMap 

  ///\sa FrontInserterBoolMap 

  ///\sa InserterBoolMap 

  ///

  ///\todo Revise the name of this class and the related ones.

  template <typename _Iterator, 

            typename _Functor =

            _maps_bits::Identity<typename _maps_bits::

                                 IteratorTraits<_Iterator>::Value> >

  class StoreBoolMap {

  public:

    typedef _Iterator Iterator;

    typedef typename _Functor::argument_type Key;

    typedef bool Value;

    typedef _Functor Functor;

    /// Constructor

    StoreBoolMap(Iterator it, const Functor& functor = Functor()) 

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

    /// 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 \c set function of the map

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

      if (value) {

	*_end++ = _functor(key);

      }

    }

  private:

    Iterator _begin;

    mutable Iterator _end;

    Functor _functor;

  };

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

  /// a back insertable container.

  ///

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

  /// them into a back insertable container.

  /// It can be used to retrieve the items into a standard

  /// container. The next example shows how you can store the

  /// edges found by the Prim algorithm in a vector.

  ///

  ///\code

  /// vector<Edge> span_tree_edges;

  /// BackInserterBoolMap<vector<Edge> > inserter_map(span_tree_edges);

  /// prim(graph, cost, inserter_map);

  ///\endcode

  ///

  ///\sa StoreBoolMap

  ///\sa FrontInserterBoolMap

  ///\sa InserterBoolMap

  template <typename Container,

            typename Functor =

            _maps_bits::Identity<typename Container::value_type> >

  class BackInserterBoolMap {

  public:

    typedef bool Value;

    /// Constructor

    BackInserterBoolMap(Container& _container, 

                        const Functor& _functor = Functor()) 

      : container(_container), functor(_functor) {}

    /// The \c set function of the map

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

      if (value) {

	container.push_back(functor(key));

      }

    }

  private:

    Container& container;

    Functor functor;

  };

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

  /// a front insertable container.

  ///

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

  /// them into a front insertable container.

  /// It can be used to retrieve the items into a standard

  /// container. For example see \ref BackInserterBoolMap.

  ///

  ///\sa BackInserterBoolMap

  ///\sa InserterBoolMap

  template <typename Container,

            typename Functor =

            _maps_bits::Identity<typename Container::value_type> >

  class FrontInserterBoolMap {

  public:

    typedef bool Value;

    /// Constructor

    FrontInserterBoolMap(Container& _container,

                         const Functor& _functor = Functor()) 

      : container(_container), functor(_functor) {}

    /// The \c set function of the map

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

      if (value) {

	container.push_front(functor(key));

      }

    }

  private:

    Container& container;    

    Functor functor;

  };

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

  /// an insertable container.

  ///

  /// Writable bool map for storing each \c true assigned element in an 

  /// insertable container. It will insert all the keys set to \c true into

  /// the container.

  ///

  /// For example, if you want to store the cut arcs of the strongly

  /// connected components in a set you can use the next code:

  ///

  ///\code

  /// set<Arc> cut_arcs;

  /// InserterBoolMap<set<Arc> > inserter_map(cut_arcs);

  /// stronglyConnectedCutArcs(digraph, cost, inserter_map);

  ///\endcode

  ///

  ///\sa BackInserterBoolMap

  ///\sa FrontInserterBoolMap

  template <typename Container,

            typename Functor =

            _maps_bits::Identity<typename Container::value_type> >

  class InserterBoolMap {

  public:

    typedef typename Container::value_type Key;

    typedef bool Value;

    /// Constructor with specified iterator

    /// Constructor with specified iterator.

    /// \param _container The container for storing the elements.

    /// \param _it The elements will be inserted before this iterator.

    /// \param _functor The functor that is used when an element is stored.

    InserterBoolMap(Container& _container, typename Container::iterator _it,

                    const Functor& _functor = Functor()) 

      : container(_container), it(_it), functor(_functor) {}

    /// Constructor

    /// Constructor without specified iterator.

    /// The elements will be inserted before <tt>_container.end()</tt>.

    /// \param _container The container for storing the elements.

    /// \param _functor The functor that is used when an element is stored.

    InserterBoolMap(Container& _container, const Functor& _functor = Functor())

      : container(_container), it(_container.end()), functor(_functor) {}

    /// The \c set function of the map

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

      if (value) {

	it = container.insert(it, functor(key));

        ++it;

      }

    }

  private:

    Container& container;

    typename Container::iterator it;

    Functor functor;

  };

  /// \brief Writable bool map for filling each \c true assigned element with a 

  /// given value.

  ///

  /// Writable bool map for filling each \c true assigned element with a 

  /// given value. The value can set the container.

  ///

  /// The following code finds the connected components of a graph

  /// and stores it in the \c comp map:

  ///\code

  /// typedef Graph::NodeMap<int> ComponentMap;

  /// ComponentMap comp(graph);

  /// typedef FillBoolMap<Graph::NodeMap<int> > ComponentFillerMap;

  /// ComponentFillerMap filler(comp, 0);

  ///

  /// Dfs<Graph>::DefProcessedMap<ComponentFillerMap>::Create dfs(graph);

  /// dfs.processedMap(filler);

  /// dfs.init();

  /// for (NodeIt it(graph); it != INVALID; ++it) {