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_BITS_GRAPH_ADAPTOR_EXTENDER_H

#define LEMON_BITS_GRAPH_ADAPTOR_EXTENDER_H

#include <lemon/core.h>

#include <lemon/error.h>

namespace lemon {

  template <typename _Digraph>

  class DigraphAdaptorExtender : public _Digraph {

  public:

    typedef _Digraph Parent;

    typedef _Digraph Digraph;

    typedef DigraphAdaptorExtender Adaptor;

    // Base extensions

    typedef typename Parent::Node Node;

    typedef typename Parent::Arc Arc;

    int maxId(Node) const {

      return Parent::maxNodeId();

    }

    int maxId(Arc) const {

      return Parent::maxArcId();

    }

    Node fromId(int id, Node) const {

      return Parent::nodeFromId(id);

    }

    Arc fromId(int id, Arc) const {

      return Parent::arcFromId(id);

    }

    Node oppositeNode(const Node &n, const Arc &e) const {

      if (n == Parent::source(e))

        return Parent::target(e);

      else if(n==Parent::target(e))

        return Parent::source(e);

      else

        return INVALID;

    }

    class NodeIt : public Node {

      const Adaptor* _adaptor;

    public:

      NodeIt() {}

      NodeIt(Invalid i) : Node(i) { }

 *

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

#define LEMON_BITS_MAP_EXTENDER_H

#include <iterator>

#include <lemon/bits/traits.h>

#include <lemon/concept_check.h>

#include <lemon/concepts/maps.h>

//\file

//\brief Extenders for iterable maps.

namespace lemon {

  // \ingroup graphbits

  //

  // \brief Extender for maps

  template <typename _Map>

  class MapExtender : public _Map {

  public:

    typedef _Map Parent;

    typedef MapExtender Map;

    typedef typename Parent::Graph Graph;

    typedef typename Parent::Key Item;

    typedef typename Parent::Key Key;

    typedef typename Parent::Value Value;

    class MapIt;

    class ConstMapIt;

    friend class MapIt;

    friend class ConstMapIt;

  public:

    MapExtender(const Graph& graph)

      : Parent(graph) {}

    MapExtender(const Graph& graph, const Value& value)

      : Parent(graph, value) {}

  private:

    MapExtender& operator=(const MapExtender& cmap) {

      return operator=<MapExtender>(cmap);

    }

    template <typename CMap>

    MapExtender& operator=(const CMap& cmap) {

      Parent::operator=(cmap);

      return *this;

    }

  public:

    class MapIt : public Item {

    public:

      typedef Item Parent;

      typedef typename Map::Value Value;

      MapIt() {}

      MapIt(Invalid i) : Parent(i) { }

      explicit MapIt(Map& _map) : map(_map) {

        map.notifier()->first(*this);

      }

      MapIt(const Map& _map, const Item& item)

        : Parent(item), map(_map) {}

      MapIt& operator++() {

        map.notifier()->next(*this);

        return *this;

      }

    protected:

      const Map& map;

    };

    class ItemIt : public Item {

    public:

      typedef Item Parent;

      ItemIt() {}

      ItemIt(Invalid i) : Parent(i) { }

      explicit ItemIt(Map& _map) : map(_map) {

        map.notifier()->first(*this);

      }

      ItemIt(const Map& _map, const Item& item)

        : Parent(item), map(_map) {}

      ItemIt& operator++() {

        map.notifier()->next(*this);

        return *this;

      }

    protected:

      const Map& map;

    };

  };

  // \ingroup graphbits

  //

  // \brief Extender for maps which use a subset of the items.

  template <typename _Graph, typename _Map>

  class SubMapExtender : public _Map {

  public:

    typedef _Map Parent;

    typedef SubMapExtender Map;

    typedef _Graph Graph;

    typedef typename Parent::Key Item;

    typedef typename Parent::Key Key;

    typedef typename Parent::Value Value;

    class MapIt;

    class ConstMapIt;

    friend class MapIt;

    friend class ConstMapIt;

  public:

    SubMapExtender(const Graph& _graph)

      : Parent(_graph), graph(_graph) {}

    SubMapExtender(const Graph& _graph, const Value& _value)

      : Parent(_graph, _value), graph(_graph) {}

  private:

    SubMapExtender& operator=(const SubMapExtender& cmap) {

      return operator=<MapExtender>(cmap);

    }

    template <typename CMap>

    SubMapExtender& operator=(const CMap& cmap) {

      checkConcept<concepts::ReadMap<Key, Value>, CMap>();

      Item it;

      for (graph.first(it); it != INVALID; graph.next(it)) {

        Parent::set(it, cmap[it]);

      }

      return *this;

    }

  public:

    class MapIt : public Item {

    public:

      typedef Item Parent;

      typedef typename Map::Value Value;

      MapIt() {}

      MapIt(Invalid i) : Parent(i) { }

      explicit MapIt(Map& _map) : map(_map) {

        map.graph.first(*this);

      }

      MapIt(const Map& _map, const Item& item)

        : Parent(item), map(_map) {}

      void next(Arc&) const {}

      void firstIn(Arc&, const Node&) const {}

      void nextIn(Arc&) const {}

      void firstOut(Arc&, const Node&) const {}

      void nextOut(Arc&) const {}

      // The second parameter is dummy.

      Node fromId(int, Node) const { return INVALID; }

      // The second parameter is dummy.

      Arc fromId(int, Arc) const { return INVALID; }

      // Dummy parameter.

      int maxId(Node) const { return -1; }

      // Dummy parameter.

      int maxId(Arc) const { return -1; }

      /// \brief The base node of the iterator.

      ///

      /// Gives back the base node of the iterator.

      /// It is always the target of the pointed arc.

      Node baseNode(const InArcIt&) const { return INVALID; }

      /// \brief The running node of the iterator.

      ///

      /// Gives back the running node of the iterator.

      /// It is always the source of the pointed arc.

      Node runningNode(const InArcIt&) const { return INVALID; }

      /// \brief The base node of the iterator.

      ///

      /// Gives back the base node of the iterator.

      /// It is always the source of the pointed arc.

      Node baseNode(const OutArcIt&) const { return INVALID; }

      /// \brief The running node of the iterator.

      ///

      /// Gives back the running node of the iterator.

      /// It is always the target of the pointed arc.

      Node runningNode(const OutArcIt&) const { return INVALID; }

      /// \brief The opposite node on the given arc.

      ///

      /// Gives back the opposite node on the given arc.

      Node oppositeNode(const Node&, const Arc&) const { return INVALID; }

      ///

      template<class T>

      public:

        ///\e

        NodeMap(const Digraph&) { }

        ///\e

        NodeMap(const Digraph&, T) { }

      private:

        ///Copy constructor

        ///Assignment operator

        template <typename CMap>

        NodeMap& operator=(const CMap&) {

          checkConcept<ReadMap<Node, T>, CMap>();

          return *this;

        }

      };

      ///

      /// Reference map of the arcs to type \c T.

      template<class T>

      public:

        ///\e

        ArcMap(const Digraph&) { }

        ///\e

        ArcMap(const Digraph&, T) { }

      private:

        ///Copy constructor

        ///Assignment operator

        template <typename CMap>

        ArcMap& operator=(const CMap&) {

          checkConcept<ReadMap<Arc, T>, CMap>();

          return *this;

        }

      };

      template <typename _Digraph>

      struct Constraints {

        void constraints() {

          checkConcept<IterableDigraphComponent<>, _Digraph>();

          checkConcept<IDableDigraphComponent<>, _Digraph>();

          checkConcept<MappableDigraphComponent<>, _Digraph>();

        }

      };

    };

  } //namespace concepts

} //namespace lemon

#endif

      /// Its usage is quite simple, for example you can count the number

      /// of outgoing arcs of a node \c n

      /// in graph \c g of type \c Graph as follows.

      ///\code

      /// int count=0;

      /// for(Graph::InArcIt e(g, n); e!=INVALID; ++e) ++count;

      ///\endcode

      class InArcIt : public Arc {

      public:

        /// Default constructor

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        InArcIt() { }

        /// Copy constructor.

        /// Copy constructor.

        ///

        InArcIt(const InArcIt& e) : Arc(e) { }

        /// Initialize the iterator to be invalid.

        /// Initialize the iterator to be invalid.

        ///

        InArcIt(Invalid) { }

        /// This constructor sets the iterator to first incoming arc.

        /// This constructor set the iterator to the first incoming arc of

        /// the node.

        ///@param n the node

        ///@param g the graph

        InArcIt(const Graph& g, const Node& n) {

          ignore_unused_variable_warning(n);

          ignore_unused_variable_warning(g);

        }

        /// Arc -> InArcIt conversion

        /// Sets the iterator to the value of the trivial iterator \c e.

        /// This feature necessitates that each time we

        /// iterate the arc-set, the iteration order is the same.

        InArcIt(const Graph&, const Arc&) { }

        /// Next incoming arc

        /// Assign the iterator to the next inarc of the corresponding node.

        ///

        InArcIt& operator++() { return *this; }

      };

      ///

      template<class T>

      {

      public:

        ///\e

        NodeMap(const Graph&) { }

        ///\e

        NodeMap(const Graph&, T) { }

      private:

        ///Copy constructor

        ///Assignment operator

        template <typename CMap>

        NodeMap& operator=(const CMap&) {

          checkConcept<ReadMap<Node, T>, CMap>();

          return *this;

        }

      };

      ///

      template<class T>

      {

      public:

        ///\e

        ArcMap(const Graph&) { }

        ///\e

        ArcMap(const Graph&, T) { }

      private:

        ///Copy constructor

        ///Assignment operator

        template <typename CMap>

        ArcMap& operator=(const CMap&) {

          checkConcept<ReadMap<Arc, T>, CMap>();

          return *this;

        }

      };

      template<class T>

      {

      public:

        ///\e

        EdgeMap(const Graph&) { }

        ///\e

        EdgeMap(const Graph&, T) { }

      private:

        ///Copy constructor

        ///Assignment operator

        template <typename CMap>

        EdgeMap& operator=(const CMap&) {

          checkConcept<ReadMap<Edge, T>, CMap>();

          return *this;

        }

      };

      /// \brief Direct the given edge.

      ///

      /// Direct the given edge. The returned arc source

      /// will be the given node.

      Arc direct(const Edge&, const Node&) const {

        return INVALID;

      }

      /// \brief Direct the given edge.

      ///

      /// Direct the given edge. The returned arc

      /// represents the given edge and the direction comes

      /// from the bool parameter. The source of the edge and

      /// the directed arc is the same when the given bool is true.

      Arc direct(const Edge&, bool) const {

        return INVALID;

      }

      /// \brief Returns true if the arc has default orientation.

      ///

      /// Returns whether the given directed arc is same orientation as

      /// the corresponding edge's default orientation.

      bool direction(Arc) const { return true; }

      /// \brief Returns the opposite directed arc.

      ///

      /// Returns the opposite directed arc.

      Arc oppositeArc(Arc) const { return INVALID; }

      /// \brief Opposite node on an arc

      ///

      /// \return The opposite of the given node on the given edge.

      Node oppositeNode(Node, Edge) const { return INVALID; }

      /// \brief First node of the edge.

      ///

      /// \return The first node of the given edge.

      ///

      /// Naturally edges don't have direction and thus

      /// don't have source and target node. However we use \c u() and \c v()

      // Dummy parameter.

      int maxId(Arc) const { return -1; }

      /// \brief Base node of the iterator

      ///

      /// Returns the base node (the source in this case) of the iterator

      Node baseNode(OutArcIt e) const {

        return source(e);

      }

      /// \brief Running node of the iterator

      ///

      /// Returns the running node (the target in this case) of the

      /// iterator

      Node runningNode(OutArcIt e) const {

        return target(e);

      }

      /// \brief Base node of the iterator

      ///

      /// Returns the base node (the target in this case) of the iterator

      Node baseNode(InArcIt e) const {

        return target(e);

      }

      /// \brief Running node of the iterator

      ///

      /// Returns the running node (the source in this case) of the

      /// iterator

      Node runningNode(InArcIt e) const {

        return source(e);

      }

      /// \brief Base node of the iterator

      ///

      /// Returns the base node of the iterator

      Node baseNode(IncEdgeIt) const {

        return INVALID;

      }

      /// \brief Running node of the iterator

      ///

      /// Returns the running node of the iterator

      Node runningNode(IncEdgeIt) const {

        return INVALID;

      }

      template <typename _Graph>

      struct Constraints {

        void constraints() {

          checkConcept<IterableGraphComponent<>, _Graph>();

          checkConcept<IDableGraphComponent<>, _Graph>();

          checkConcept<MappableGraphComponent<>, _Graph>();

        }

      };

    };

  }

}

#endif

    };

    /// \brief Skeleton class for alterable undirected graphs.

    ///

    /// This class describes the interface of alterable undirected

    /// graphs. It extends \ref AlterableDigraphComponent with the alteration

    /// notifier interface of undirected graphs. It implements

    /// an observer-notifier pattern for the edges. More

    /// obsevers can be registered into the notifier and whenever an

    /// alteration occured in the graph all the observers will be

    /// notified about it.

    template <typename BAS = BaseGraphComponent>

    class AlterableGraphComponent : public AlterableDigraphComponent<BAS> {

    public:

      typedef BAS Base;

      typedef typename Base::Edge Edge;

      /// Edge alteration notifier class.

      typedef AlterationNotifier<AlterableGraphComponent, Edge>

      EdgeNotifier;

      /// \brief Return the edge alteration notifier.

      ///

      /// This function gives back the edge alteration notifier.

      EdgeNotifier& notifier(Edge) const {

        return EdgeNotifier();

      }

      template <typename _Graph>

      struct Constraints {

        void constraints() {

          checkConcept<AlterableDigraphComponent<Base>, _Graph>();

          typename _Graph::EdgeNotifier& uen

            = graph.notifier(typename _Graph::Edge());

          ignore_unused_variable_warning(uen);

        }

        const _Graph& graph;

      };

    };

    /// \brief Concept class for standard graph maps.

    ///

    /// This class describes the concept of standard graph maps, i.e.

    /// the \c NodeMap, \c ArcMap and \c EdgeMap subtypes of digraph and 

    /// graph types, which can be used for associating data to graph items.

    template <typename GR, typename K, typename V>

    public:

      typedef ReadWriteMap<K, V> Parent;

      /// The graph type of the map.

      typedef GR Graph;

      /// The key type of the map.

      typedef K Key;

      /// The value type of the map.

      typedef V Value;

      /// \brief Construct a new map.

      ///

      /// Construct a new map for the graph.

      explicit GraphMap(const Graph&) {}

      /// \brief Construct a new map with default value.

      ///

      /// Construct a new map for the graph and initalize the values.

      GraphMap(const Graph&, const Value&) {}

    private:

      /// \brief Copy constructor.

      ///

      /// Copy Constructor.

      GraphMap(const GraphMap&) : Parent() {}

      /// \brief Assignment operator.

      ///

      /// Assignment operator. It does not mofify the underlying graph,

      /// it just iterates on the current item set and set the  map

      /// with the value returned by the assigned map.

      template <typename CMap>

      GraphMap& operator=(const CMap&) {

        checkConcept<ReadMap<Key, Value>, CMap>();

        return *this;

      }

    public:

      template<typename _Map>

      struct Constraints {

        void constraints() {

          _Map m1(g);

          _Map m2(g,t);

          // Copy constructor

          // _Map m3(m);

          // Assignment operator

          // ReadMap<Key, Value> cmap;

          // m3 = cmap;

          ignore_unused_variable_warning(m1);

          ignore_unused_variable_warning(m2);

          // ignore_unused_variable_warning(m3);

        }

        const _Map &m;

        const Graph &g;

        const typename GraphMap::Value &t;

      };

    };

    /// \brief Skeleton class for mappable directed graphs.

    ///

    /// This class describes the interface of mappable directed graphs.

    /// It extends \ref BaseDigraphComponent with the standard digraph 

    /// map classes, namely \c NodeMap and \c ArcMap.

    /// This concept is part of the Digraph concept.

    template <typename BAS = BaseDigraphComponent>

    class MappableDigraphComponent : public BAS  {

    public:

      typedef BAS Base;

      typedef typename Base::Node Node;

      typedef typename Base::Arc Arc;

      typedef MappableDigraphComponent Digraph;

      /// \brief Standard graph map for the nodes.

      ///

      /// Standard graph map for the nodes.

      template <typename V>

      class NodeMap : public GraphMap<MappableDigraphComponent, Node, V> {

      public:

        typedef GraphMap<MappableDigraphComponent, Node, V> Parent;

        /// \brief Construct a new map.

        ///

        /// Construct a new map for the digraph.

        explicit NodeMap(const MappableDigraphComponent& digraph)

          : Parent(digraph) {}

        /// \brief Construct a new map with default value.

        ///

        /// Construct a new map for the digraph and initalize the values.

        NodeMap(const MappableDigraphComponent& digraph, const V& value)

          : Parent(digraph, value) {}

      private:

        /// \brief Copy constructor.

        ///

        /// Copy Constructor.

        NodeMap(const NodeMap& nm) : Parent(nm) {}

        /// \brief Assignment operator.

        ///

        /// Assignment operator.

        template <typename CMap>

        NodeMap& operator=(const CMap&) {

          checkConcept<ReadMap<Node, V>, CMap>();

          return *this;

        }

      };

      /// \brief Standard graph map for the arcs.

      ///

      /// Standard graph map for the arcs.

      template <typename V>

      class ArcMap : public GraphMap<MappableDigraphComponent, Arc, V> {

      public:

        typedef GraphMap<MappableDigraphComponent, Arc, V> Parent;

        /// \brief Construct a new map.

        ///

        /// Construct a new map for the digraph.

        explicit ArcMap(const MappableDigraphComponent& digraph)

          : Parent(digraph) {}

        /// \brief Construct a new map with default value.

        ///

        /// Construct a new map for the digraph and initalize the values.

        ArcMap(const MappableDigraphComponent& digraph, const V& value)

          : Parent(digraph, value) {}

      private:

        /// \brief Copy constructor.

        ///

        /// Copy Constructor.

        ArcMap(const ArcMap& nm) : Parent(nm) {}

        /// \brief Assignment operator.

        ///

        /// Assignment operator.

        template <typename CMap>

        ArcMap& operator=(const CMap&) {

          checkConcept<ReadMap<Arc, V>, CMap>();

          return *this;

        }

      };

      template <typename _Digraph>

      struct Constraints {

        struct Dummy {

          int value;

          Dummy() : value(0) {}

          Dummy(int _v) : value(_v) {}

        };

        void constraints() {

          checkConcept<Base, _Digraph>();

          { // int map test

            typedef typename _Digraph::template NodeMap<int> IntNodeMap;

              IntNodeMap >();

          } { // bool map test

            typedef typename _Digraph::template NodeMap<bool> BoolNodeMap;

            checkConcept<GraphMap<_Digraph, typename _Digraph::Node, bool>,

              BoolNodeMap >();

          } { // Dummy map test

            typedef typename _Digraph::template NodeMap<Dummy> DummyNodeMap;

            checkConcept<GraphMap<_Digraph, typename _Digraph::Node, Dummy>,

              DummyNodeMap >();

          }

          { // int map test

            typedef typename _Digraph::template ArcMap<int> IntArcMap;

            checkConcept<GraphMap<_Digraph, typename _Digraph::Arc, int>,

              IntArcMap >();

          } { // bool map test

            typedef typename _Digraph::template ArcMap<bool> BoolArcMap;

            checkConcept<GraphMap<_Digraph, typename _Digraph::Arc, bool>,

              BoolArcMap >();

          } { // Dummy map test

            typedef typename _Digraph::template ArcMap<Dummy> DummyArcMap;

            checkConcept<GraphMap<_Digraph, typename _Digraph::Arc, Dummy>,

              DummyArcMap >();

          }

        }

        const _Digraph& digraph;

      };

    };

    /// \brief Skeleton class for mappable undirected graphs.

    ///

    /// This class describes the interface of mappable undirected graphs.

    /// It extends \ref MappableDigraphComponent with the standard graph 

    /// map class for edges (\c EdgeMap).

    /// This concept is part of the Graph concept.

    template <typename BAS = BaseGraphComponent>

    class MappableGraphComponent : public MappableDigraphComponent<BAS>  {

    public:

      typedef BAS Base;

      typedef typename Base::Edge Edge;

      typedef MappableGraphComponent Graph;

      /// \brief Standard graph map for the edges.

      ///

      /// Standard graph map for the edges.

      template <typename V>

      class EdgeMap : public GraphMap<MappableGraphComponent, Edge, V> {

      public:

        typedef GraphMap<MappableGraphComponent, Edge, V> Parent;

        /// \brief Construct a new map.

        ///

        /// Construct a new map for the graph.

        explicit EdgeMap(const MappableGraphComponent& graph)

          : Parent(graph) {}

        /// \brief Construct a new map with default value.

        ///

        /// Construct a new map for the graph and initalize the values.

        EdgeMap(const MappableGraphComponent& graph, const V& value)

          : Parent(graph, value) {}

      private:

        /// \brief Copy constructor.

        ///

        /// Copy Constructor.

        EdgeMap(const EdgeMap& nm) : Parent(nm) {}

        /// \brief Assignment operator.

        ///

        /// Assignment operator.

        template <typename CMap>

        EdgeMap& operator=(const CMap&) {

          checkConcept<ReadMap<Edge, V>, CMap>();

          return *this;

        }

      };

      template <typename _Graph>

      struct Constraints {

        struct Dummy {

          int value;

          Dummy() : value(0) {}

          Dummy(int _v) : value(_v) {}

        };

        void constraints() {

          checkConcept<MappableDigraphComponent<Base>, _Graph>();

          { // int map test