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_BITS_GRAPH_EXTENDER_H

#define LEMON_BITS_GRAPH_EXTENDER_H

#include <lemon/bits/invalid.h>

#include <lemon/bits/utility.h>

#include <lemon/bits/map_extender.h>

#include <lemon/bits/default_map.h>

#include <lemon/concept_check.h>

#include <lemon/concepts/maps.h>

///\ingroup graphbits

///\file

///\brief Extenders for the digraph types

namespace lemon {

  /// \ingroup graphbits

  ///

  /// \brief Extender for the Digraphs

  template <typename Base>

  class DigraphExtender : public Base {

  public:

    typedef Base Parent;

    typedef DigraphExtender Digraph;

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

    }

      else

	return INVALID;

    }

    // Alterable extension

    typedef AlterationNotifier<DigraphExtender, Node> NodeNotifier;

    typedef AlterationNotifier<DigraphExtender, Arc> ArcNotifier;

  protected:

    mutable NodeNotifier node_notifier;

    mutable ArcNotifier arc_notifier;

  public:

    NodeNotifier& notifier(Node) const {

      return node_notifier;

    }

    ArcNotifier& notifier(Arc) const {

      return arc_notifier;

    }

    class NodeIt : public Node { 

    public:

      NodeIt() {}

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

      }

      NodeIt& operator++() { 

	return *this; 

      }

    };

    class ArcIt : public Arc { 

    public:

      ArcIt() { }

      ArcIt(Invalid i) : Arc(i) { }

      }

      ArcIt& operator++() { 

	return *this; 

      }

    };

    class OutArcIt : public Arc { 

    public:

      OutArcIt() { }

      OutArcIt(Invalid i) : Arc(i) { }

      }

      OutArcIt& operator++() { 

	return *this; 

      }

    };

    class InArcIt : public Arc { 

    public:

      InArcIt() { }

      InArcIt(Invalid i) : Arc(i) { }

      }

      InArcIt& operator++() { 

	return *this; 

      }

    };

    /// \brief Base node of the iterator

    ///

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

    }

    /// \brief Running node of the iterator

    ///

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

    /// iterator

    }

    /// \brief Base node of the iterator

    ///

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

    }

    /// \brief Running node of the iterator

    ///

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

    /// iterator

    }

    template <typename _Value>

    class NodeMap 

      : public MapExtender<DefaultMap<Digraph, Node, _Value> > {

    public:

      typedef DigraphExtender Digraph;

      typedef MapExtender<DefaultMap<Digraph, Node, _Value> > Parent;

      explicit NodeMap(const Digraph& digraph) 

	: Parent(digraph) {}

      NodeMap(const Digraph& digraph, const _Value& value) 

	: Parent(digraph, value) {}

      NodeMap& operator=(const NodeMap& cmap) {

	return operator=<NodeMap>(cmap);

      }

      template <typename CMap>

      NodeMap& operator=(const CMap& cmap) {

        Parent::operator=(cmap);

	return *this;

      }

    };

    template <typename _Value>

    class ArcMap 

      : public MapExtender<DefaultMap<Digraph, Arc, _Value> > {

    public:

      typedef DigraphExtender Digraph;

      typedef MapExtender<DefaultMap<Digraph, Arc, _Value> > Parent;

      explicit ArcMap(const Digraph& digraph) 

	: Parent(digraph) {}

      ArcMap(const Digraph& digraph, const _Value& value) 

	: Parent(digraph, value) {}

      ArcMap& operator=(const ArcMap& cmap) {

	return operator=<ArcMap>(cmap);

      }

      template <typename CMap>

      ArcMap& operator=(const CMap& cmap) {

        Parent::operator=(cmap);

	return *this;

      }

    };

    Node addNode() {

      Node node = Parent::addNode();

      notifier(Node()).add(node);

      return node;

    }

    Arc addArc(const Node& from, const Node& to) {

      Arc arc = Parent::addArc(from, to);

      notifier(Arc()).add(arc);

      return arc;

    }

    void clear() {

      notifier(Arc()).clear();

      notifier(Node()).clear();

      Parent::clear();

    }

    template <typename Digraph, typename NodeRefMap, typename ArcRefMap>

    void build(const Digraph& digraph, NodeRefMap& nodeRef, ArcRefMap& arcRef) {

      Parent::build(digraph, nodeRef, arcRef);

      notifier(Node()).build();

      notifier(Arc()).build();

    }

    void erase(const Node& node) {

      Arc arc;

      Parent::firstOut(arc, node);

      while (arc != INVALID ) {

	erase(arc);

	Parent::firstOut(arc, node);

      } 

      Parent::firstIn(arc, node);

      while (arc != INVALID ) {

	erase(arc);

	Parent::firstIn(arc, node);

      }

      notifier(Node()).erase(node);

      Parent::erase(node);

    }

    void erase(const Arc& arc) {

      notifier(Arc()).erase(arc);

      Parent::erase(arc);

    }

    DigraphExtender() {

      node_notifier.setContainer(*this);

      arc_notifier.setContainer(*this);

    } 

    ~DigraphExtender() {

      arc_notifier.clear();

      node_notifier.clear();

    }

  };

  ///

  /// \brief Extender for the Graphs

  template <typename Base> 

  class GraphExtender : public Base {

  public:

    typedef Base Parent;

    typedef True UndirectedTag;

    typedef typename Parent::Node Node;

    typedef typename Parent::Arc Arc;

    typedef typename Parent::Edge Edge;

    // Graph extension    

    int maxId(Node) const {

      return Parent::maxNodeId();

    }

    int maxId(Arc) const {

      return Parent::maxArcId();

    }

    int maxId(Edge) const {

      return Parent::maxEdgeId();

    }

    Node fromId(int id, Node) const {

      return Parent::nodeFromId(id);

    }

    Arc fromId(int id, Arc) const {

      return Parent::arcFromId(id);

    }

    Edge fromId(int id, Edge) const {

      return Parent::edgeFromId(id);

    }

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

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

	return Parent::target(e);

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

	return Parent::source(e);

      else

	return INVALID;

    }

    }

    using Parent::direct;

    }

    // Alterable extension

    typedef AlterationNotifier<GraphExtender, Node> NodeNotifier;

    typedef AlterationNotifier<GraphExtender, Arc> ArcNotifier;

    typedef AlterationNotifier<GraphExtender, Edge> EdgeNotifier;

  protected:

    mutable NodeNotifier node_notifier;

    mutable ArcNotifier arc_notifier;

    mutable EdgeNotifier edge_notifier;

  public:

    NodeNotifier& notifier(Node) const {

      return node_notifier;

    }

    ArcNotifier& notifier(Arc) const {

      return arc_notifier;

    }

    EdgeNotifier& notifier(Edge) const {

      return edge_notifier;

    }

    class NodeIt : public Node { 

    public:

      NodeIt() {}

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

      }

      NodeIt& operator++() { 

	return *this; 

      }

    };

    class ArcIt : public Arc { 

    public:

      ArcIt() { }

      ArcIt(Invalid i) : Arc(i) { }

      }

      ArcIt& operator++() { 

	return *this; 

      }

    };

    class OutArcIt : public Arc { 

    public:

      OutArcIt() { }

      OutArcIt(Invalid i) : Arc(i) { }

      }

      OutArcIt& operator++() { 

	return *this; 

      }

    };

    class InArcIt : public Arc { 

    public:

      InArcIt() { }

      InArcIt(Invalid i) : Arc(i) { }

      }

      InArcIt& operator++() { 

	return *this; 

      }

    };

    class EdgeIt : public Parent::Edge { 

    public:

      EdgeIt() { }

      EdgeIt(Invalid i) : Edge(i) { }

      }

      EdgeIt& operator++() { 

	return *this; 

      }

    };

      friend class GraphExtender;

    public:

      }

      }

	return *this; 

      }

    };

    /// \brief Base node of the iterator

    ///

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

    }

    /// \brief Running node of the iterator

    ///

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

    /// iterator

    }

    /// \brief Base node of the iterator

    ///

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

    }

    /// \brief Running node of the iterator

    ///

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

    /// iterator

    }

    /// Base node of the iterator

    ///

    /// Returns the base node of the iterator

    }

    /// Running node of the iterator

    ///

    /// Returns the running node of the iterator

    }

    // Mappable extension

    template <typename _Value>

    class NodeMap 

    public:

      NodeMap& operator=(const NodeMap& cmap) {

	return operator=<NodeMap>(cmap);

      }

      template <typename CMap>

      NodeMap& operator=(const CMap& cmap) {

        Parent::operator=(cmap);

	return *this;

      }

    };

    template <typename _Value>

    class ArcMap 

    public:

      ArcMap& operator=(const ArcMap& cmap) {

	return operator=<ArcMap>(cmap);

      }

      template <typename CMap>

      ArcMap& operator=(const CMap& cmap) {

        Parent::operator=(cmap);

	return *this;

      }

    };

    template <typename _Value>

    class EdgeMap 

    public:

      EdgeMap& operator=(const EdgeMap& cmap) {

	return operator=<EdgeMap>(cmap);

      }

      template <typename CMap>

      EdgeMap& operator=(const CMap& cmap) {

        Parent::operator=(cmap);

	return *this;

      }

    };

    // Alteration extension

    Node addNode() {

      Node node = Parent::addNode();

      notifier(Node()).add(node);

      return node;

    }

    Edge addEdge(const Node& from, const Node& to) {

      Edge edge = Parent::addEdge(from, to);

      notifier(Edge()).add(edge);

      std::vector<Arc> ev;

      ev.push_back(Parent::direct(edge, true));

      ev.push_back(Parent::direct(edge, false));      

      notifier(Arc()).add(ev);

      return edge;

    }

    void clear() {

      notifier(Arc()).clear();

      notifier(Edge()).clear();

      notifier(Node()).clear();

      Parent::clear();

    }

               EdgeRefMap& edgeRef) {

      notifier(Node()).build();

      notifier(Edge()).build();

      notifier(Arc()).build();

    }

    void erase(const Node& node) {

      Arc arc;

      Parent::firstOut(arc, node);

      while (arc != INVALID ) {

	erase(arc);

	Parent::firstOut(arc, node);

      } 

      Parent::firstIn(arc, node);

      while (arc != INVALID ) {

	erase(arc);

	Parent::firstIn(arc, node);

      }

      notifier(Node()).erase(node);

      Parent::erase(node);

    }

    void erase(const Edge& edge) {

      notifier(Edge()).erase(edge);

      Parent::erase(edge);

    }

    GraphExtender() {

      node_notifier.setContainer(*this); 

      arc_notifier.setContainer(*this);

      edge_notifier.setContainer(*this);

    } 

    ~GraphExtender() {

      edge_notifier.clear();

      arc_notifier.clear();

      node_notifier.clear(); 

    } 

  };

}

#endif

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

 *

 */

///\ingroup graph_concepts

///\file

///\brief The concept of Undirected Graphs.

#ifndef LEMON_CONCEPT_GRAPH_H

#define LEMON_CONCEPT_GRAPH_H

#include <lemon/concepts/graph_components.h>

#include <lemon/concepts/graph.h>

#include <lemon/bits/utility.h>

namespace lemon {

  namespace concepts {

    /// \ingroup graph_concepts

    ///

    /// \brief Class describing the concept of Undirected Graphs.

    ///

    /// This class describes the common interface of all Undirected

    /// Graphs.

    ///

    /// As all concept describing classes it provides only interface

    /// without any sensible implementation. So any algorithm for

    /// undirected graph should compile with this class, but it will not

    /// run properly, of course.

    ///

    /// The LEMON undirected graphs also fulfill the concept of

    /// directed graphs (\ref lemon::concepts::Digraph "Digraph

    /// Concept"). Each edges can be seen as two opposite

    /// directed arc and consequently the undirected graph can be

    /// seen as the direceted graph of these directed arcs. The

    /// Graph has the Edge inner class for the edges and

    /// the Arc type for the directed arcs. The Arc type is

    /// convertible to Edge or inherited from it so from a directed

    /// arc we can get the represented edge.

    ///

    /// In the sense of the LEMON each edge has a default

    /// direction (it should be in every computer implementation,

    /// because the order of edge's nodes defines an

    /// orientation). With the default orientation we can define that

    /// the directed arc is forward or backward directed. With the \c

    /// direction() and \c direct() function we can get the direction

    /// of the directed arc and we can direct an edge.

    ///

    /// The EdgeIt is an iterator for the edges. We can use

    /// the EdgeMap to map values for the edges. The InArcIt and

    /// OutArcIt iterates on the same edges but with opposite

    /// as the OutArcIt and InArcIt but it is not convertible to Arc just

    /// to Edge.  

    class Graph {

    public:

      /// \brief The undirected graph should be tagged by the

      /// UndirectedTag.

      ///

      /// The undirected graph should be tagged by the UndirectedTag. This

      /// tag helps the enable_if technics to make compile time 

      /// specializations for undirected graphs.  

      typedef True UndirectedTag;

      /// \brief The base type of node iterators, 

      /// or in other words, the trivial node iterator.

      ///

      /// This is the base type of each node iterator,

      /// thus each kind of node iterator converts to this.

      /// More precisely each kind of node iterator should be inherited 

      /// from the trivial node iterator.

      class Node {

      public:

        /// Default constructor

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        Node() { }

        /// Copy constructor.

        /// Copy constructor.

        ///

        Node(const Node&) { }

        /// Invalid constructor \& conversion.

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

        /// \sa Invalid for more details.

        Node(Invalid) { }

        /// Equality operator

        /// Two iterators are equal if and only if they point to the

        /// same object or both are invalid.

        bool operator==(Node) const { return true; }

        /// Inequality operator

        /// \sa operator==(Node n)

        ///

        bool operator!=(Node) const { return true; }

	/// Artificial ordering operator.

	/// To allow the use of graph descriptors as key type in std::map or

	/// similar associative container we require this.

	///

	/// \note This operator only have to define some strict ordering of

	/// the items; this order has nothing to do with the iteration

	/// ordering of the items.

	bool operator<(Node) const { return false; }

      };

      /// This iterator goes through each node.

      /// This iterator goes through each node.

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

      /// of nodes in graph \c g of type \c Graph like this:

      ///\code

      /// int count=0;

      /// for (Graph::NodeIt n(g); n!=INVALID; ++n) ++count;

      ///\endcode

      class NodeIt : public Node {

      public:

        /// Default constructor

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        NodeIt() { }

        /// Copy constructor.

        /// Copy constructor.

        ///

        NodeIt(const NodeIt& n) : Node(n) { }

        /// Invalid constructor \& conversion.

        /// Initialize the iterator to be invalid.

        /// \sa Invalid for more details.

        NodeIt(Invalid) { }

        /// Sets the iterator to the first node.

        /// Sets the iterator to the first node of \c g.

        ///

        NodeIt(const Graph&) { }

        /// Node -> NodeIt conversion.

        /// Sets the iterator to the node of \c the graph pointed by 

	/// the trivial iterator.

      ///

      class Edge {

      public:

        /// Default constructor

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        Edge() { }

        /// Copy constructor.

        /// Copy constructor.

        ///

        Edge(const Edge&) { }

        /// Initialize the iterator to be invalid.

        /// Initialize the iterator to be invalid.

        ///

        Edge(Invalid) { }

        /// Equality operator

        /// Two iterators are equal if and only if they point to the

        /// same object or both are invalid.

        bool operator==(Edge) const { return true; }

        /// Inequality operator

        /// \sa operator==(Edge n)

        ///

        bool operator!=(Edge) const { return true; }

	/// Artificial ordering operator.

	/// To allow the use of graph descriptors as key type in std::map or

	/// similar associative container we require this.

	///

	/// \note This operator only have to define some strict ordering of

	/// the items; this order has nothing to do with the iteration

	/// ordering of the items.

	bool operator<(Edge) const { return false; }

      };

      /// This iterator goes through each edge.

      /// This iterator goes through each edge of a graph.

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

      /// of edges in a graph \c g of type \c Graph as follows:

      ///\code

      /// int count=0;

      /// for(Graph::EdgeIt e(g); e!=INVALID; ++e) ++count;

      ///\endcode

      class EdgeIt : public Edge {

      public:

        /// Default constructor