RhodeCode

    /// This class describes the \ref concept "concept" of the

    /// immutable directed digraphs.

    /// Note that actual digraph implementation like @ref ListDigraph or

    /// @ref SmartDigraph may have several additional functionality.

    /// \sa concept

      ///Digraphs are \e not copy constructible. Use DigraphCopy() instead.

      ///Digraphs are \e not copy constructible. Use DigraphCopy() instead.

      ///

      Digraph(const Digraph &) {};

      ///\brief Assignment of \ref Digraph "Digraph"s to another ones are

      ///\e not allowed. Use DigraphCopy() instead.

      ///Assignment of \ref Digraph "Digraph"s to another ones are

      ///\e not allowed.  Use DigraphCopy() instead.

      void operator=(const Digraph &) {}

    public:

      ///\e

      /// Defalult constructor.

      /// Defalult constructor.

      ///

      Digraph() { }

      /// Class for identifying a node of the digraph

      /// thus they will convert to this type.

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        /// Invalid constructor \& conversion.

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

        /// same object or both are invalid.

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

        ///

        /// To allow the use of digraph 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.

      /// This iterator goes through each node.

      /// This iterator goes through each node.

      /// of nodes in digraph \c g of type \c Digraph like this:

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        /// Invalid constructor \& conversion.

        /// Initialize the iterator to be invalid.

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

        NodeIt(const Digraph&) { }

        /// Node -> NodeIt conversion.

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

        /// the trivial iterator.

        /// This feature necessitates that each time we

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

      /// Class for identifying an arc of the digraph

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        /// Initialize the iterator to be invalid.

        /// Initialize the iterator to be invalid.

        ///

        /// same object or both are invalid.

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

        ///

        /// To allow the use of digraph 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.

      /// This iterator goes trough the outgoing arcs of a node.

      /// in digraph \c g of type \c Digraph as follows.

      /// for (Digraph::OutArcIt e(g, n); e!=INVALID; ++e) ++count;

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        /// Initialize the iterator to be invalid.

        /// Initialize the iterator to be invalid.

        OutArcIt(Invalid) { }

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

        /// This constructor sets the iterator to the first outgoing arc of

        /// the node.

        OutArcIt(const Digraph&, const Node&) { }

        /// Arc -> OutArcIt conversion

        /// Sets the iterator to the value of the trivial iterator.

        /// This feature necessitates that each time we

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

        ///Next outgoing arc

      /// This iterator goes trough the incoming arcs of a node.

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

      /// in digraph \c g of type \c Digraph as follows.

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

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

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

        InArcIt(const Digraph&, const Node&) { }

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

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

        ///

      /// This iterator goes through each arc.

      /// This iterator goes through each arc of a digraph.

      /// of arcs in a digraph \c g of type \c Digraph as follows:

      /// for(Digraph::ArcIt e(g); e!=INVALID; ++e) ++count;

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        /// Initialize the iterator to be invalid.

        /// Initialize the iterator to be invalid.

        ArcIt(Invalid) { }

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

        /// This constructor sets the iterator to the first arc of \c g.

        ///@param g the digraph

        ArcIt(const Digraph& g) { ignore_unused_variable_warning(g); }

        /// Arc -> ArcIt 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.

        ///Next arc

      ///Gives back the target node of an arc.

      ///Gives back the target node of an arc.

      Node target(Arc) const { return INVALID; }

      ///Gives back the source node of an arc.

      ///Gives back the source node of an arc.

      ///

      /// \brief Returns the ID of the node.

      /// \brief Returns the ID of the arc.

      /// \brief Returns the node with the given ID.

      /// \pre The argument should be a valid node ID in the graph.

      /// \brief Returns the arc with the given ID.

      /// \pre The argument should be a valid arc ID in the graph.

      /// \brief Returns an upper bound on the node IDs.

      /// \brief Returns an upper bound on the arc IDs.

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

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

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

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

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

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

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

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

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

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

      /// \brief Reference map of the nodes to type \c T.

      ///

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

        ///\e

        NodeMap(const Digraph&) { }

        ///\e

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

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

        ///\e

        ArcMap(const Digraph&) { }

        ///\e

///\brief The concept of Undirected Graphs.

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

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

    /// direction. The IncEdgeIt iterates also on the same edges

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

    /// to Edge.

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

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

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        /// Invalid constructor \& conversion.

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

        /// same object or both are invalid.

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

        ///

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

      /// This iterator goes through each node.

      /// This iterator goes through each node.

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

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        /// Invalid constructor \& conversion.

        /// Initialize the iterator to be invalid.

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

        /// This feature necessitates that each time we

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

      /// The base type of the edge iterators.

      /// The base type of the edge iterators.

      ///

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        /// Initialize the iterator to be invalid.

        /// Initialize the iterator to be invalid.

        ///

        /// same object or both are invalid.

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

        ///

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

      /// This iterator goes through each edge.

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

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

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        /// Initialize the iterator to be invalid.

        /// Initialize the iterator to be invalid.

        EdgeIt(Invalid) { }

        /// This constructor sets the iterator to the first edge.

        /// This constructor sets the iterator to the first edge.

        EdgeIt(const Graph&) { }

        /// Edge -> EdgeIt conversion

        /// Sets the iterator to the value of the trivial iterator.

        /// This feature necessitates that each time we

        /// iterate the edge-set, the iteration order is the

        /// same.

      /// \brief This iterator goes trough the incident undirected

      /// arcs of a node.

      ///

      /// This iterator goes trough the incident edges

      /// of a certain node of a graph. You should assume that the

      /// loop arcs will be iterated twice.

      ///

      /// degree (i.e. count the number of incident arcs of a node \c n

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

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        /// Initialize the iterator to be invalid.

        /// Initialize the iterator to be invalid.

        IncEdgeIt(Invalid) { }

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

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

        /// the node.

        IncEdgeIt(const Graph&, const Node&) { }

        /// Edge -> IncEdgeIt 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.

        IncEdgeIt(const Graph&, const Edge&) { }

        /// Next incident arc

        /// Assign the iterator to the next incident arc

      /// The directed arc type.

      /// The directed arc type. It can be converted to the

      /// edge or it should be inherited from the undirected

      /// edge.

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        /// Initialize the iterator to be invalid.

        /// Initialize the iterator to be invalid.

        ///

        /// same object or both are invalid.

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

        ///

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

        /// Converison to Edge

      /// This iterator goes through each directed arc.

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

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

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

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        /// Initialize the iterator to be invalid.

        /// Initialize the iterator to be invalid.

        ArcIt(Invalid) { }

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

        /// This constructor sets the iterator to the first arc of \c g.

        ///@param g the graph

        ArcIt(const Graph &g) { ignore_unused_variable_warning(g); }

        /// Arc -> ArcIt 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.

        ///Next arc

      /// This iterator goes trough the outgoing directed arcs of a node.

      /// This iterator goes trough the \e outgoing arcs of a certain node

      /// of a graph.

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

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

        /// @warning The default constructor sets the iterator

        /// to an undefined value.

        /// Initialize the iterator to be invalid.

        /// Initialize the iterator to be invalid.

        OutArcIt(Invalid) { }

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

        /// This constructor sets the iterator to the first outgoing arc of

        /// the node.

        ///@param n the node

        ///@param g the graph

        /// Arc -> OutArcIt conversion