/* -*- mode: C++; indent-tabs-mode: nil; -*-
* This file is a part of LEMON, a generic C++ optimization library.
* Copyright (C) 2003-2008
* 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
#include <lemon/bits/enable_if.h>
#include <lemon/bits/traits.h>
///\brief LEMON core utilities.
///This header file contains core utilities for LEMON.
///It is automatically included by all graph types, therefore it usually
///do not have to be included directly.
/// \brief Dummy type to make it easier to create invalid iterators.
/// Dummy type to make it easier to create invalid iterators.
/// See \ref INVALID for the usage.
bool operator==(Invalid) { return true; }
bool operator!=(Invalid) { return false; }
bool operator< (Invalid) { return false; }
/// \brief Invalid iterators.
/// \ref Invalid is a global type that converts to each iterator
/// in such a way that the value of the target iterator will be invalid.
#ifdef LEMON_ONLY_TEMPLATES
const Invalid INVALID = Invalid();
extern const Invalid INVALID;
///Create convenience typedefs for the digraph types and iterators
///This \c \#define creates convenient type definitions for the following
///types of \c Digraph: \c Node, \c NodeIt, \c Arc, \c ArcIt, \c InArcIt,
///\c OutArcIt, \c BoolNodeMap, \c IntNodeMap, \c DoubleNodeMap,
///\c BoolArcMap, \c IntArcMap, \c DoubleArcMap.
///\note If the graph type is a dependent type, ie. the graph type depend
///on a template parameter, then use \c TEMPLATE_DIGRAPH_TYPEDEFS()
#define DIGRAPH_TYPEDEFS(Digraph) \
typedef Digraph::Node Node; \
typedef Digraph::NodeIt NodeIt; \
typedef Digraph::Arc Arc; \
typedef Digraph::ArcIt ArcIt; \
typedef Digraph::InArcIt InArcIt; \
typedef Digraph::OutArcIt OutArcIt; \
typedef Digraph::NodeMap<bool> BoolNodeMap; \
typedef Digraph::NodeMap<int> IntNodeMap; \
typedef Digraph::NodeMap<double> DoubleNodeMap; \
typedef Digraph::ArcMap<bool> BoolArcMap; \
typedef Digraph::ArcMap<int> IntArcMap; \
typedef Digraph::ArcMap<double> DoubleArcMap
///Create convenience typedefs for the digraph types and iterators
///\note Use this macro, if the graph type is a dependent type,
///ie. the graph type depend on a template parameter.
#define TEMPLATE_DIGRAPH_TYPEDEFS(Digraph) \
typedef typename Digraph::Node Node; \
typedef typename Digraph::NodeIt NodeIt; \
typedef typename Digraph::Arc Arc; \
typedef typename Digraph::ArcIt ArcIt; \
typedef typename Digraph::InArcIt InArcIt; \
typedef typename Digraph::OutArcIt OutArcIt; \
typedef typename Digraph::template NodeMap<bool> BoolNodeMap; \
typedef typename Digraph::template NodeMap<int> IntNodeMap; \
typedef typename Digraph::template NodeMap<double> DoubleNodeMap; \
typedef typename Digraph::template ArcMap<bool> BoolArcMap; \
typedef typename Digraph::template ArcMap<int> IntArcMap; \
typedef typename Digraph::template ArcMap<double> DoubleArcMap
///Create convenience typedefs for the graph types and iterators
///This \c \#define creates the same convenient type definitions as defined
///by \ref DIGRAPH_TYPEDEFS(Graph) and six more, namely it creates
///\c Edge, \c EdgeIt, \c IncEdgeIt, \c BoolEdgeMap, \c IntEdgeMap,
///\note If the graph type is a dependent type, ie. the graph type depend
///on a template parameter, then use \c TEMPLATE_GRAPH_TYPEDEFS()
#define GRAPH_TYPEDEFS(Graph) \
DIGRAPH_TYPEDEFS(Graph); \
typedef Graph::Edge Edge; \
typedef Graph::EdgeIt EdgeIt; \
typedef Graph::IncEdgeIt IncEdgeIt; \
typedef Graph::EdgeMap<bool> BoolEdgeMap; \
typedef Graph::EdgeMap<int> IntEdgeMap; \
typedef Graph::EdgeMap<double> DoubleEdgeMap
///Create convenience typedefs for the graph types and iterators
///\note Use this macro, if the graph type is a dependent type,
///ie. the graph type depend on a template parameter.
#define TEMPLATE_GRAPH_TYPEDEFS(Graph) \
TEMPLATE_DIGRAPH_TYPEDEFS(Graph); \
typedef typename Graph::Edge Edge; \
typedef typename Graph::EdgeIt EdgeIt; \
typedef typename Graph::IncEdgeIt IncEdgeIt; \
typedef typename Graph::template EdgeMap<bool> BoolEdgeMap; \
typedef typename Graph::template EdgeMap<int> IntEdgeMap; \
typedef typename Graph::template EdgeMap<double> DoubleEdgeMap
/// \brief Function to count the items in a graph.
/// This function counts the items (nodes, arcs etc.) in a graph.
/// The complexity of the function is linear because
/// it iterates on all of the items.
template <typename Graph, typename Item>
inline int countItems(const Graph& g) {
typedef typename ItemSetTraits<Graph, Item>::ItemIt ItemIt;
for (ItemIt it(g); it != INVALID; ++it) {
template <typename Graph, typename Enable = void>
struct CountNodesSelector {
static int count(const Graph &g) {
return countItems<Graph, typename Graph::Node>(g);
template <typename Graph>
struct CountNodesSelector<
enable_if<typename Graph::NodeNumTag, void>::type>
static int count(const Graph &g) {
/// \brief Function to count the nodes in the graph.
/// This function counts the nodes in the graph.
/// The complexity of the function is <em>O</em>(<em>n</em>), but for some
/// graph structures it is specialized to run in <em>O</em>(1).
/// \note If the graph contains a \c nodeNum() member function and a
/// \c NodeNumTag tag then this function calls directly the member
/// function to query the cardinality of the node set.
template <typename Graph>
inline int countNodes(const Graph& g) {
return _core_bits::CountNodesSelector<Graph>::count(g);
template <typename Graph, typename Enable = void>
struct CountArcsSelector {
static int count(const Graph &g) {
return countItems<Graph, typename Graph::Arc>(g);
template <typename Graph>
struct CountArcsSelector<
typename enable_if<typename Graph::ArcNumTag, void>::type>
static int count(const Graph &g) {
/// \brief Function to count the arcs in the graph.
/// This function counts the arcs in the graph.
/// The complexity of the function is <em>O</em>(<em>m</em>), but for some
/// graph structures it is specialized to run in <em>O</em>(1).
/// \note If the graph contains a \c arcNum() member function and a
/// \c ArcNumTag tag then this function calls directly the member
/// function to query the cardinality of the arc set.
template <typename Graph>
inline int countArcs(const Graph& g) {
return _core_bits::CountArcsSelector<Graph>::count(g);
template <typename Graph, typename Enable = void>
struct CountEdgesSelector {
static int count(const Graph &g) {
return countItems<Graph, typename Graph::Edge>(g);
template <typename Graph>
struct CountEdgesSelector<
typename enable_if<typename Graph::EdgeNumTag, void>::type>
static int count(const Graph &g) {
/// \brief Function to count the edges in the graph.
/// This function counts the edges in the graph.
/// The complexity of the function is <em>O</em>(<em>m</em>), but for some
/// graph structures it is specialized to run in <em>O</em>(1).
/// \note If the graph contains a \c edgeNum() member function and a
/// \c EdgeNumTag tag then this function calls directly the member
/// function to query the cardinality of the edge set.
template <typename Graph>
inline int countEdges(const Graph& g) {
return _core_bits::CountEdgesSelector<Graph>::count(g);
template <typename Graph, typename DegIt>
inline int countNodeDegree(const Graph& _g, const typename Graph::Node& _n) {
for (DegIt it(_g, _n); it != INVALID; ++it) {
/// \brief Function to count the number of the out-arcs from node \c n.
/// This function counts the number of the out-arcs from node \c n
template <typename Graph>
inline int countOutArcs(const Graph& g, const typename Graph::Node& n) {
return countNodeDegree<Graph, typename Graph::OutArcIt>(g, n);
/// \brief Function to count the number of the in-arcs to node \c n.
/// This function counts the number of the in-arcs to node \c n
template <typename Graph>
inline int countInArcs(const Graph& g, const typename Graph::Node& n) {
return countNodeDegree<Graph, typename Graph::InArcIt>(g, n);
/// \brief Function to count the number of the inc-edges to node \c n.
/// This function counts the number of the inc-edges to node \c n
/// in the undirected graph \c g.
template <typename Graph>
inline int countIncEdges(const Graph& g, const typename Graph::Node& n) {
return countNodeDegree<Graph, typename Graph::IncEdgeIt>(g, n);
template <typename Digraph, typename Item, typename RefMap>
virtual void copy(const Digraph& from, const RefMap& refMap) = 0;
virtual ~MapCopyBase() {}
template <typename Digraph, typename Item, typename RefMap,
typename FromMap, typename ToMap>
class MapCopy : public MapCopyBase<Digraph, Item, RefMap> {
MapCopy(const FromMap& map, ToMap& tmap)
: _map(map), _tmap(tmap) {}
virtual void copy(const Digraph& digraph, const RefMap& refMap) {
typedef typename ItemSetTraits<Digraph, Item>::ItemIt ItemIt;
for (ItemIt it(digraph); it != INVALID; ++it) {
_tmap.set(refMap[it], _map[it]);
template <typename Digraph, typename Item, typename RefMap, typename It>
class ItemCopy : public MapCopyBase<Digraph, Item, RefMap> {
ItemCopy(const Item& item, It& it) : _item(item), _it(it) {}
virtual void copy(const Digraph&, const RefMap& refMap) {
template <typename Digraph, typename Item, typename RefMap, typename Ref>
class RefCopy : public MapCopyBase<Digraph, Item, RefMap> {
RefCopy(Ref& map) : _map(map) {}
virtual void copy(const Digraph& digraph, const RefMap& refMap) {
typedef typename ItemSetTraits<Digraph, Item>::ItemIt ItemIt;
for (ItemIt it(digraph); it != INVALID; ++it) {
_map.set(it, refMap[it]);
template <typename Digraph, typename Item, typename RefMap,
class CrossRefCopy : public MapCopyBase<Digraph, Item, RefMap> {
CrossRefCopy(CrossRef& cmap) : _cmap(cmap) {}
virtual void copy(const Digraph& digraph, const RefMap& refMap) {
typedef typename ItemSetTraits<Digraph, Item>::ItemIt ItemIt;
for (ItemIt it(digraph); it != INVALID; ++it) {
_cmap.set(refMap[it], it);
template <typename Digraph, typename Enable = void>
struct DigraphCopySelector {
template <typename From, typename NodeRefMap, typename ArcRefMap>
static void copy(const From& from, Digraph &to,
NodeRefMap& nodeRefMap, ArcRefMap& arcRefMap) {
for (typename From::NodeIt it(from); it != INVALID; ++it) {
nodeRefMap[it] = to.addNode();
for (typename From::ArcIt it(from); it != INVALID; ++it) {
arcRefMap[it] = to.addArc(nodeRefMap[from.source(it)],
nodeRefMap[from.target(it)]);
template <typename Digraph>
struct DigraphCopySelector<
typename enable_if<typename Digraph::BuildTag, void>::type>
template <typename From, typename NodeRefMap, typename ArcRefMap>
static void copy(const From& from, Digraph &to,
NodeRefMap& nodeRefMap, ArcRefMap& arcRefMap) {
to.build(from, nodeRefMap, arcRefMap);
template <typename Graph, typename Enable = void>
struct GraphCopySelector {
template <typename From, typename NodeRefMap, typename EdgeRefMap>
static void copy(const From& from, Graph &to,
NodeRefMap& nodeRefMap, EdgeRefMap& edgeRefMap) {
for (typename From::NodeIt it(from); it != INVALID; ++it) {
nodeRefMap[it] = to.addNode();
for (typename From::EdgeIt it(from); it != INVALID; ++it) {
edgeRefMap[it] = to.addEdge(nodeRefMap[from.u(it)],
template <typename Graph>
struct GraphCopySelector<
typename enable_if<typename Graph::BuildTag, void>::type>
template <typename From, typename NodeRefMap, typename EdgeRefMap>
static void copy(const From& from, Graph &to,
NodeRefMap& nodeRefMap, EdgeRefMap& edgeRefMap) {
to.build(from, nodeRefMap, edgeRefMap);
/// \brief Class to copy a digraph.
/// Class to copy a digraph to another digraph (duplicate a digraph). The
/// simplest way of using it is through the \c digraphCopy() function.
/// This class not only make a copy of a digraph, but it can create
/// references and cross references between the nodes and arcs of
/// the two digraphs, and it can copy maps to use with the newly created
/// To make a copy from a digraph, first an instance of DigraphCopy
/// should be created, then the data belongs to the digraph should
/// assigned to copy. In the end, the \c run() member should be
/// The next code copies a digraph with several data:
/// DigraphCopy<OrigGraph, NewGraph> cg(orig_graph, new_graph);
/// // Create references for the nodes
/// OrigGraph::NodeMap<NewGraph::Node> nr(orig_graph);
/// // Create cross references (inverse) for the arcs
/// NewGraph::ArcMap<OrigGraph::Arc> acr(new_graph);
/// OrigGraph::ArcMap<double> oamap(orig_graph);
/// NewGraph::ArcMap<double> namap(new_graph);
/// cg.arcMap(oamap, namap);
template <typename From, typename To>
typedef typename From::Node Node;
typedef typename From::NodeIt NodeIt;
typedef typename From::Arc Arc;
typedef typename From::ArcIt ArcIt;
typedef typename To::Node TNode;
typedef typename To::Arc TArc;
typedef typename From::template NodeMap<TNode> NodeRefMap;
typedef typename From::template ArcMap<TArc> ArcRefMap;
/// \brief Constructor of DigraphCopy.
/// Constructor of DigraphCopy for copying the content of the
/// \c from digraph into the \c to digraph.
DigraphCopy(const From& from, To& to)
: _from(from), _to(to) {}
/// \brief Destructor of DigraphCopy
/// Destructor of DigraphCopy.
for (int i = 0; i < int(_node_maps.size()); ++i) {
for (int i = 0; i < int(_arc_maps.size()); ++i) {
/// \brief Copy the node references into the given map.
/// This function copies the node references into the given map.
/// The parameter should be a map, whose key type is the Node type of
/// the source digraph, while the value type is the Node type of the
template <typename NodeRef>
DigraphCopy& nodeRef(NodeRef& map) {
_node_maps.push_back(new _core_bits::RefCopy<From, Node,
NodeRefMap, NodeRef>(map));
/// \brief Copy the node cross references into the given map.
/// This function copies the node cross references (reverse references)
/// into the given map. The parameter should be a map, whose key type
/// is the Node type of the destination digraph, while the value type is
/// the Node type of the source digraph.
template <typename NodeCrossRef>
DigraphCopy& nodeCrossRef(NodeCrossRef& map) {
_node_maps.push_back(new _core_bits::CrossRefCopy<From, Node,
NodeRefMap, NodeCrossRef>(map));
/// \brief Make a copy of the given node map.
/// This function makes a copy of the given node map for the newly
/// The key type of the new map \c tmap should be the Node type of the
/// destination digraph, and the key type of the original map \c map
/// should be the Node type of the source digraph.
template <typename FromMap, typename ToMap>
DigraphCopy& nodeMap(const FromMap& map, ToMap& tmap) {
_node_maps.push_back(new _core_bits::MapCopy<From, Node,
NodeRefMap, FromMap, ToMap>(map, tmap));
/// \brief Make a copy of the given node.
/// This function makes a copy of the given node.
DigraphCopy& node(const Node& node, TNode& tnode) {
_node_maps.push_back(new _core_bits::ItemCopy<From, Node,
NodeRefMap, TNode>(node, tnode));
/// \brief Copy the arc references into the given map.
/// This function copies the arc references into the given map.
/// The parameter should be a map, whose key type is the Arc type of
/// the source digraph, while the value type is the Arc type of the
template <typename ArcRef>
DigraphCopy& arcRef(ArcRef& map) {
_arc_maps.push_back(new _core_bits::RefCopy<From, Arc,
ArcRefMap, ArcRef>(map));
/// \brief Copy the arc cross references into the given map.
/// This function copies the arc cross references (reverse references)
/// into the given map. The parameter should be a map, whose key type
/// is the Arc type of the destination digraph, while the value type is
/// the Arc type of the source digraph.
template <typename ArcCrossRef>
DigraphCopy& arcCrossRef(ArcCrossRef& map) {
_arc_maps.push_back(new _core_bits::CrossRefCopy<From, Arc,
ArcRefMap, ArcCrossRef>(map));
/// \brief Make a copy of the given arc map.
/// This function makes a copy of the given arc map for the newly
/// The key type of the new map \c tmap should be the Arc type of the
/// destination digraph, and the key type of the original map \c map
/// should be the Arc type of the source digraph.
template <typename FromMap, typename ToMap>
DigraphCopy& arcMap(const FromMap& map, ToMap& tmap) {
_arc_maps.push_back(new _core_bits::MapCopy<From, Arc,
ArcRefMap, FromMap, ToMap>(map, tmap));
/// \brief Make a copy of the given arc.
/// This function makes a copy of the given arc.
DigraphCopy& arc(const Arc& arc, TArc& tarc) {
_arc_maps.push_back(new _core_bits::ItemCopy<From, Arc,
ArcRefMap, TArc>(arc, tarc));
/// \brief Execute copying.
/// This function executes the copying of the digraph along with the
/// copying of the assigned data.
NodeRefMap nodeRefMap(_from);
ArcRefMap arcRefMap(_from);
_core_bits::DigraphCopySelector<To>::
copy(_from, _to, nodeRefMap, arcRefMap);
for (int i = 0; i < int(_node_maps.size()); ++i) {
_node_maps[i]->copy(_from, nodeRefMap);
for (int i = 0; i < int(_arc_maps.size()); ++i) {
_arc_maps[i]->copy(_from, arcRefMap);
std::vector<_core_bits::MapCopyBase<From, Node, NodeRefMap>* >
std::vector<_core_bits::MapCopyBase<From, Arc, ArcRefMap>* >
/// \brief Copy a digraph to another digraph.
/// This function copies a digraph to another digraph.
/// The complete usage of it is detailed in the DigraphCopy class, but
/// a short example shows a basic work:
/// digraphCopy(src, trg).nodeRef(nr).arcCrossRef(acr).run();
/// After the copy the \c nr map will contain the mapping from the
/// nodes of the \c from digraph to the nodes of the \c to digraph and
/// \c acr will contain the mapping from the arcs of the \c to digraph
/// to the arcs of the \c from digraph.
template <typename From, typename To>
DigraphCopy<From, To> digraphCopy(const From& from, To& to) {
return DigraphCopy<From, To>(from, to);
/// \brief Class to copy a graph.
/// Class to copy a graph to another graph (duplicate a graph). The
/// simplest way of using it is through the \c graphCopy() function.
/// This class not only make a copy of a graph, but it can create
/// references and cross references between the nodes, edges and arcs of
/// the two graphs, and it can copy maps for using with the newly created
/// To make a copy from a graph, first an instance of GraphCopy
/// should be created, then the data belongs to the graph should
/// assigned to copy. In the end, the \c run() member should be
/// The next code copies a graph with several data:
/// GraphCopy<OrigGraph, NewGraph> cg(orig_graph, new_graph);
/// // Create references for the nodes
/// OrigGraph::NodeMap<NewGraph::Node> nr(orig_graph);
/// // Create cross references (inverse) for the edges
/// NewGraph::EdgeMap<OrigGraph::Edge> ecr(new_graph);
/// cg.edgeCrossRef(ecr);
/// OrigGraph::EdgeMap<double> oemap(orig_graph);
/// NewGraph::EdgeMap<double> nemap(new_graph);
/// cg.edgeMap(oemap, nemap);
template <typename From, typename To>
typedef typename From::Node Node;
typedef typename From::NodeIt NodeIt;
typedef typename From::Arc Arc;
typedef typename From::ArcIt ArcIt;
typedef typename From::Edge Edge;
typedef typename From::EdgeIt EdgeIt;
typedef typename To::Node TNode;
typedef typename To::Arc TArc;
typedef typename To::Edge TEdge;
typedef typename From::template NodeMap<TNode> NodeRefMap;
typedef typename From::template EdgeMap<TEdge> EdgeRefMap;
ArcRefMap(const From& from, const To& to,
const EdgeRefMap& edge_ref, const NodeRefMap& node_ref)
_edge_ref(edge_ref), _node_ref(node_ref) {}
typedef typename From::Arc Key;
typedef typename To::Arc Value;
Value operator[](const Key& key) const {
bool forward = _from.u(key) != _from.v(key) ?
_node_ref[_from.source(key)] ==
_to.source(_to.direct(_edge_ref[key], true)) :
return _to.direct(_edge_ref[key], forward);
const EdgeRefMap& _edge_ref;
const NodeRefMap& _node_ref;
/// \brief Constructor of GraphCopy.
/// Constructor of GraphCopy for copying the content of the
/// \c from graph into the \c to graph.
GraphCopy(const From& from, To& to)
: _from(from), _to(to) {}
/// \brief Destructor of GraphCopy
/// Destructor of GraphCopy.
for (int i = 0; i < int(_node_maps.size()); ++i) {
for (int i = 0; i < int(_arc_maps.size()); ++i) {
for (int i = 0; i < int(_edge_maps.size()); ++i) {
/// \brief Copy the node references into the given map.
/// This function copies the node references into the given map.
/// The parameter should be a map, whose key type is the Node type of
/// the source graph, while the value type is the Node type of the
template <typename NodeRef>
GraphCopy& nodeRef(NodeRef& map) {
_node_maps.push_back(new _core_bits::RefCopy<From, Node,
NodeRefMap, NodeRef>(map));
/// \brief Copy the node cross references into the given map.
/// This function copies the node cross references (reverse references)
/// into the given map. The parameter should be a map, whose key type
/// is the Node type of the destination graph, while the value type is
/// the Node type of the source graph.
template <typename NodeCrossRef>
GraphCopy& nodeCrossRef(NodeCrossRef& map) {
_node_maps.push_back(new _core_bits::CrossRefCopy<From, Node,
NodeRefMap, NodeCrossRef>(map));
/// \brief Make a copy of the given node map.
/// This function makes a copy of the given node map for the newly
/// The key type of the new map \c tmap should be the Node type of the
/// destination graph, and the key type of the original map \c map
/// should be the Node type of the source graph.
template <typename FromMap, typename ToMap>
GraphCopy& nodeMap(const FromMap& map, ToMap& tmap) {
_node_maps.push_back(new _core_bits::MapCopy<From, Node,
NodeRefMap, FromMap, ToMap>(map, tmap));
/// \brief Make a copy of the given node.
/// This function makes a copy of the given node.
GraphCopy& node(const Node& node, TNode& tnode) {
_node_maps.push_back(new _core_bits::ItemCopy<From, Node,
NodeRefMap, TNode>(node, tnode));
/// \brief Copy the arc references into the given map.
/// This function copies the arc references into the given map.
/// The parameter should be a map, whose key type is the Arc type of
/// the source graph, while the value type is the Arc type of the
template <typename ArcRef>
GraphCopy& arcRef(ArcRef& map) {
_arc_maps.push_back(new _core_bits::RefCopy<From, Arc,
ArcRefMap, ArcRef>(map));
/// \brief Copy the arc cross references into the given map.
/// This function copies the arc cross references (reverse references)
/// into the given map. The parameter should be a map, whose key type
/// is the Arc type of the destination graph, while the value type is
/// the Arc type of the source graph.
template <typename ArcCrossRef>
GraphCopy& arcCrossRef(ArcCrossRef& map) {
_arc_maps.push_back(new _core_bits::CrossRefCopy<From, Arc,
ArcRefMap, ArcCrossRef>(map));
/// \brief Make a copy of the given arc map.
/// This function makes a copy of the given arc map for the newly
/// The key type of the new map \c tmap should be the Arc type of the
/// destination graph, and the key type of the original map \c map
/// should be the Arc type of the source graph.
template <typename FromMap, typename ToMap>
GraphCopy& arcMap(const FromMap& map, ToMap& tmap) {
_arc_maps.push_back(new _core_bits::MapCopy<From, Arc,
ArcRefMap, FromMap, ToMap>(map, tmap));
/// \brief Make a copy of the given arc.
/// This function makes a copy of the given arc.
GraphCopy& arc(const Arc& arc, TArc& tarc) {
_arc_maps.push_back(new _core_bits::ItemCopy<From, Arc,
ArcRefMap, TArc>(arc, tarc));
/// \brief Copy the edge references into the given map.
/// This function copies the edge references into the given map.
/// The parameter should be a map, whose key type is the Edge type of
/// the source graph, while the value type is the Edge type of the
template <typename EdgeRef>
GraphCopy& edgeRef(EdgeRef& map) {
_edge_maps.push_back(new _core_bits::RefCopy<From, Edge,
EdgeRefMap, EdgeRef>(map));
/// \brief Copy the edge cross references into the given map.
/// This function copies the edge cross references (reverse references)
/// into the given map. The parameter should be a map, whose key type
/// is the Edge type of the destination graph, while the value type is
/// the Edge type of the source graph.
template <typename EdgeCrossRef>
GraphCopy& edgeCrossRef(EdgeCrossRef& map) {
_edge_maps.push_back(new _core_bits::CrossRefCopy<From,
Edge, EdgeRefMap, EdgeCrossRef>(map));
/// \brief Make a copy of the given edge map.
/// This function makes a copy of the given edge map for the newly
/// The key type of the new map \c tmap should be the Edge type of the
/// destination graph, and the key type of the original map \c map
/// should be the Edge type of the source graph.
template <typename FromMap, typename ToMap>
GraphCopy& edgeMap(const FromMap& map, ToMap& tmap) {
_edge_maps.push_back(new _core_bits::MapCopy<From, Edge,
EdgeRefMap, FromMap, ToMap>(map, tmap));
/// \brief Make a copy of the given edge.
/// This function makes a copy of the given edge.
GraphCopy& edge(const Edge& edge, TEdge& tedge) {
_edge_maps.push_back(new _core_bits::ItemCopy<From, Edge,
EdgeRefMap, TEdge>(edge, tedge));
/// \brief Execute copying.
/// This function executes the copying of the graph along with the
/// copying of the assigned data.
NodeRefMap nodeRefMap(_from);
EdgeRefMap edgeRefMap(_from);
ArcRefMap arcRefMap(_from, _to, edgeRefMap, nodeRefMap);
_core_bits::GraphCopySelector<To>::
copy(_from, _to, nodeRefMap, edgeRefMap);
for (int i = 0; i < int(_node_maps.size()); ++i) {
_node_maps[i]->copy(_from, nodeRefMap);
for (int i = 0; i < int(_edge_maps.size()); ++i) {
_edge_maps[i]->copy(_from, edgeRefMap);
for (int i = 0; i < int(_arc_maps.size()); ++i) {
_arc_maps[i]->copy(_from, arcRefMap);
std::vector<_core_bits::MapCopyBase<From, Node, NodeRefMap>* >
std::vector<_core_bits::MapCopyBase<From, Arc, ArcRefMap>* >
std::vector<_core_bits::MapCopyBase<From, Edge, EdgeRefMap>* >
/// \brief Copy a graph to another graph.
/// This function copies a graph to another graph.
/// The complete usage of it is detailed in the GraphCopy class,
/// but a short example shows a basic work:
/// graphCopy(src, trg).nodeRef(nr).edgeCrossRef(ecr).run();
/// After the copy the \c nr map will contain the mapping from the
/// nodes of the \c from graph to the nodes of the \c to graph and
/// \c ecr will contain the mapping from the edges of the \c to graph
/// to the edges of the \c from graph.
template <typename From, typename To>
graphCopy(const From& from, To& to) {
return GraphCopy<From, To>(from, to);
template <typename Graph, typename Enable = void>
typedef typename Graph::Node Node;
typedef typename Graph::Arc Arc;
static Arc find(const Graph &g, Node u, Node v, Arc e) {
while (e != INVALID && g.target(e) != v) {
template <typename Graph>
typename enable_if<typename Graph::FindArcTag, void>::type>
typedef typename Graph::Node Node;
typedef typename Graph::Arc Arc;
static Arc find(const Graph &g, Node u, Node v, Arc prev) {
return g.findArc(u, v, prev);
/// \brief Find an arc between two nodes of a digraph.
/// This function finds an arc from node \c u to node \c v in the
/// If \c prev is \ref INVALID (this is the default value), then
/// it finds the first arc from \c u to \c v. Otherwise it looks for
/// the next arc from \c u to \c v after \c prev.
/// \return The found arc or \ref INVALID if there is no such an arc.
/// Thus you can iterate through each arc from \c u to \c v as it follows.
/// for(Arc e = findArc(g,u,v); e != INVALID; e = findArc(g,u,v,e)) {
/// \note \ref ConArcIt provides iterator interface for the same
///\sa ArcLookUp, AllArcLookUp, DynArcLookUp
template <typename Graph>
inline typename Graph::Arc
findArc(const Graph &g, typename Graph::Node u, typename Graph::Node v,
typename Graph::Arc prev = INVALID) {
return _core_bits::FindArcSelector<Graph>::find(g, u, v, prev);
/// \brief Iterator for iterating on parallel arcs connecting the same nodes.
/// Iterator for iterating on parallel arcs connecting the same nodes. It is
/// a higher level interface for the \ref findArc() function. You can
/// use it the following way:
/// for (ConArcIt<Graph> it(g, src, trg); it != INVALID; ++it) {
///\sa ArcLookUp, AllArcLookUp, DynArcLookUp
template <typename _Graph>
class ConArcIt : public _Graph::Arc {
typedef typename Graph::Arc Parent;
typedef typename Graph::Arc Arc;
typedef typename Graph::Node Node;
/// Construct a new ConArcIt iterating on the arcs that
/// connects nodes \c u and \c v.
ConArcIt(const Graph& g, Node u, Node v) : _graph(g) {
Parent::operator=(findArc(_graph, u, v));
/// Construct a new ConArcIt that continues the iterating from arc \c a.
ConArcIt(const Graph& g, Arc a) : Parent(a), _graph(g) {}
/// \brief Increment operator.
/// It increments the iterator and gives back the next arc.
Parent::operator=(findArc(_graph, _graph.source(*this),
_graph.target(*this), *this));
template <typename Graph, typename Enable = void>
struct FindEdgeSelector {
typedef typename Graph::Node Node;
typedef typename Graph::Edge Edge;
static Edge find(const Graph &g, Node u, Node v, Edge e) {
while (e != INVALID && (b ? g.v(e) : g.u(e)) != v) {
while (e != INVALID && (!b || g.v(e) != v)) {
template <typename Graph>
typename enable_if<typename Graph::FindEdgeTag, void>::type>
typedef typename Graph::Node Node;
typedef typename Graph::Edge Edge;
static Edge find(const Graph &g, Node u, Node v, Edge prev) {
return g.findEdge(u, v, prev);
/// \brief Find an edge between two nodes of a graph.
/// This function finds an edge from node \c u to node \c v in graph \c g.
/// If node \c u and node \c v is equal then each loop edge
/// will be enumerated once.
/// If \c prev is \ref INVALID (this is the default value), then
/// it finds the first edge from \c u to \c v. Otherwise it looks for
/// the next edge from \c u to \c v after \c prev.
/// \return The found edge or \ref INVALID if there is no such an edge.
/// Thus you can iterate through each edge between \c u and \c v
/// for(Edge e = findEdge(g,u,v); e != INVALID; e = findEdge(g,u,v,e)) {
/// \note \ref ConEdgeIt provides iterator interface for the same
template <typename Graph>
inline typename Graph::Edge
findEdge(const Graph &g, typename Graph::Node u, typename Graph::Node v,
typename Graph::Edge p = INVALID) {
return _core_bits::FindEdgeSelector<Graph>::find(g, u, v, p);
/// \brief Iterator for iterating on parallel edges connecting the same nodes.
/// Iterator for iterating on parallel edges connecting the same nodes.
/// It is a higher level interface for the findEdge() function. You can
/// use it the following way:
/// for (ConEdgeIt<Graph> it(g, u, v); it != INVALID; ++it) {
template <typename _Graph>
class ConEdgeIt : public _Graph::Edge {
typedef typename Graph::Edge Parent;
typedef typename Graph::Edge Edge;
typedef typename Graph::Node Node;
/// Construct a new ConEdgeIt iterating on the edges that
/// connects nodes \c u and \c v.
ConEdgeIt(const Graph& g, Node u, Node v) : _graph(g) {
Parent::operator=(findEdge(_graph, u, v));
/// Construct a new ConEdgeIt that continues iterating from edge \c e.
ConEdgeIt(const Graph& g, Edge e) : Parent(e), _graph(g) {}
/// \brief Increment operator.
/// It increments the iterator and gives back the next edge.
ConEdgeIt& operator++() {
Parent::operator=(findEdge(_graph, _graph.u(*this),
_graph.v(*this), *this));
///Dynamic arc look-up between given endpoints.
///Using this class, you can find an arc in a digraph from a given
///source to a given target in amortized time <em>O</em>(log<em>d</em>),
///where <em>d</em> is the out-degree of the source node.
///It is possible to find \e all parallel arcs between two nodes with
///the \c operator() member.
///This is a dynamic data structure. Consider to use \ref ArcLookUp or
///\ref AllArcLookUp if your digraph is not changed so frequently.
///This class uses a self-adjusting binary search tree, the Splay tree
///of Sleator and Tarjan to guarantee the logarithmic amortized
///time bound for arc look-ups. This class also guarantees the
///optimal time bound in a constant factor for any distribution of
///\tparam G The type of the underlying digraph.
: protected ItemSetTraits<G, typename G::Arc>::ItemNotifier::ObserverBase
typedef typename ItemSetTraits<G, typename G::Arc>
::ItemNotifier::ObserverBase Parent;
TEMPLATE_DIGRAPH_TYPEDEFS(G);
class AutoNodeMap : public ItemSetTraits<G, Node>::template Map<Arc>::Type {
typedef typename ItemSetTraits<G, Node>::template Map<Arc>::Type Parent;
AutoNodeMap(const G& digraph) : Parent(digraph, INVALID) {}
virtual void add(const Node& node) {
Parent::set(node, INVALID);
virtual void add(const std::vector<Node>& nodes) {
for (int i = 0; i < int(nodes.size()); ++i) {
Parent::set(nodes[i], INVALID);
typename Parent::Notifier* nf = Parent::notifier();
for (nf->first(it); it != INVALID; nf->next(it)) {
Parent::set(it, INVALID);
typename Digraph::template ArcMap<Arc> _parent;
typename Digraph::template ArcMap<Arc> _left;
typename Digraph::template ArcMap<Arc> _right;
ArcLess(const Digraph &_g) : g(_g) {}
bool operator()(Arc a,Arc b) const
return g.target(a)<g.target(b);
///It builds up the search database.
DynArcLookUp(const Digraph &g)
: _g(g),_head(g),_parent(g),_left(g),_right(g)
Parent::attach(_g.notifier(typename Digraph::Arc()));
virtual void add(const Arc& arc) {
virtual void add(const std::vector<Arc>& arcs) {
for (int i = 0; i < int(arcs.size()); ++i) {
virtual void erase(const Arc& arc) {
virtual void erase(const std::vector<Arc>& arcs) {
for (int i = 0; i < int(arcs.size()); ++i) {
for(NodeIt n(_g);n!=INVALID;++n) {
_right.set(arc, INVALID);
_parent.set(arc, INVALID);
if (_left[e] == INVALID) {
if (_right[e] == INVALID) {
if (_left[arc] == INVALID) {
if (_right[arc] != INVALID) {
_parent.set(_right[arc], _parent[arc]);
if (_parent[arc] != INVALID) {
if (_left[_parent[arc]] == arc) {
_left.set(_parent[arc], _right[arc]);
_right.set(_parent[arc], _right[arc]);
_head.set(_g.source(arc), _right[arc]);
} else if (_right[arc] == INVALID) {
_parent.set(_left[arc], _parent[arc]);
if (_parent[arc] != INVALID) {
if (_left[_parent[arc]] == arc) {
_left.set(_parent[arc], _left[arc]);
_right.set(_parent[arc], _left[arc]);
_head.set(_g.source(arc), _left[arc]);
if (_right[e] != INVALID) {
while (_right[e] != INVALID) {
_right.set(_parent[e], _left[e]);
if (_left[e] != INVALID) {
_parent.set(_left[e], _parent[e]);
_left.set(e, _left[arc]);
_parent.set(_left[arc], e);
_right.set(e, _right[arc]);
_parent.set(_right[arc], e);
_parent.set(e, _parent[arc]);
if (_parent[arc] != INVALID) {
if (_left[_parent[arc]] == arc) {
_left.set(_parent[arc], e);
_right.set(_parent[arc], e);
_right.set(e, _right[arc]);
_parent.set(_right[arc], e);
_parent.set(e, _parent[arc]);
if (_parent[arc] != INVALID) {
if (_left[_parent[arc]] == arc) {
_left.set(_parent[arc], e);
_right.set(_parent[arc], e);
_head.set(_g.source(arc), e);
Arc refreshRec(std::vector<Arc> &v,int a,int b)
Arc left = refreshRec(v,a,m-1);
Arc right = refreshRec(v,m+1,b);
for(NodeIt n(_g);n!=INVALID;++n) {
for(OutArcIt a(_g,n);a!=INVALID;++a) v.push_back(a);
std::sort(v.begin(),v.end(),ArcLess(_g));
Arc head = refreshRec(v,0,v.size()-1);
_parent.set(head, INVALID);
else _head.set(n, INVALID);
_parent.set(v, _parent[w]);
if (_parent[v] != INVALID) {
if (_right[_parent[v]] == w) {
_right.set(_parent[v], v);
_left.set(_parent[v], v);
if (_left[w] != INVALID){
_parent.set(_left[w], w);
_parent.set(v, _parent[w]);
if (_parent[v] != INVALID){
if (_left[_parent[v]] == w) {
_left.set(_parent[v], v);
_right.set(_parent[v], v);
if (_right[w] != INVALID){
_parent.set(_right[w], w);
while (_parent[v] != INVALID) {
if (v == _left[_parent[v]]) {
if (_parent[_parent[v]] == INVALID) {
if (_parent[v] == _left[_parent[_parent[v]]]) {
if (_parent[_parent[v]] == INVALID) {
if (_parent[v] == _left[_parent[_parent[v]]]) {
///Find an arc between two nodes.
///Find an arc between two nodes.
///\param s The source node.
///\param t The target node.
///\param p The previous arc between \c s and \c t. It it is INVALID or
///not given, the operator finds the first appropriate arc.
///\return An arc from \c s to \c t after \c p or
///\ref INVALID if there is no more.
///For example, you can count the number of arcs from \c u to \c v in the
///DynArcLookUp<ListDigraph> ae(g);
///for(Arc a = ae(u,v); a != INVALID; a = ae(u,v,a)) n++;
///Finding the arcs take at most <em>O</em>(log<em>d</em>)
///amortized time, specifically, the time complexity of the lookups
///is equal to the optimal search tree implementation for the
///current query distribution in a constant factor.
///\note This is a dynamic data structure, therefore the data
///structure is updated after each graph alteration. Thus although
///this data structure is theoretically faster than \ref ArcLookUp
///and \ref AllArcLookup, it often provides worse performance than
Arc operator()(Node s, Node t, Arc p = INVALID) const {
if (a == INVALID) return INVALID;
if (_right[a] == INVALID) {
const_cast<DynArcLookUp&>(*this).splay(a);
if (_left[a] == INVALID) {
const_cast<DynArcLookUp&>(*this).splay(a);
if (_right[a] != INVALID) {
while (_left[a] != INVALID) {
const_cast<DynArcLookUp&>(*this).splay(a);
while (_parent[a] != INVALID && _right[_parent[a]] == a) {
if (_parent[a] == INVALID) {
const_cast<DynArcLookUp&>(*this).splay(a);
if (_g.target(a) == t) return a;
///Fast arc look-up between given endpoints.
///Using this class, you can find an arc in a digraph from a given
///source to a given target in time <em>O</em>(log<em>d</em>),
///where <em>d</em> is the out-degree of the source node.
///It is not possible to find \e all parallel arcs between two nodes.
///Use \ref AllArcLookUp for this purpose.
///\warning This class is static, so you should call refresh() (or at
///least refresh(Node)) to refresh this data structure whenever the
///digraph changes. This is a time consuming (superlinearly proportional
///(<em>O</em>(<em>m</em> log<em>m</em>)) to the number of arcs).
///\tparam G The type of the underlying digraph.
TEMPLATE_DIGRAPH_TYPEDEFS(G);
typename Digraph::template NodeMap<Arc> _head;
typename Digraph::template ArcMap<Arc> _left;
typename Digraph::template ArcMap<Arc> _right;
ArcLess(const Digraph &_g) : g(_g) {}
bool operator()(Arc a,Arc b) const
return g.target(a)<g.target(b);
///It builds up the search database, which remains valid until the digraph
ArcLookUp(const Digraph &g) :_g(g),_head(g),_left(g),_right(g) {refresh();}
Arc refreshRec(std::vector<Arc> &v,int a,int b)
_left[me] = a<m?refreshRec(v,a,m-1):INVALID;
_right[me] = m<b?refreshRec(v,m+1,b):INVALID;
///Refresh the search data structure at a node.
///Build up the search database of node \c n.
///It runs in time <em>O</em>(<em>d</em> log<em>d</em>), where <em>d</em>
///is the number of the outgoing arcs of \c n.
for(OutArcIt e(_g,n);e!=INVALID;++e) v.push_back(e);
std::sort(v.begin(),v.end(),ArcLess(_g));
_head[n]=refreshRec(v,0,v.size()-1);
///Refresh the full data structure.
///Build up the full search database. In fact, it simply calls
///\ref refresh(Node) "refresh(n)" for each node \c n.
///It runs in time <em>O</em>(<em>m</em> log<em>D</em>), where <em>m</em> is
///the number of the arcs in the digraph and <em>D</em> is the maximum
///out-degree of the digraph.
for(NodeIt n(_g);n!=INVALID;++n) refresh(n);
///Find an arc between two nodes.
///Find an arc between two nodes in time <em>O</em>(log<em>d</em>), where
///<em>d</em> is the number of outgoing arcs of \c s.
///\param s The source node.
///\param t The target node.
///\return An arc from \c s to \c t if there exists,
///\ref INVALID otherwise.
///\warning If you change the digraph, refresh() must be called before using
///this operator. If you change the outgoing arcs of
///a single node \c n, then \ref refresh(Node) "refresh(n)" is enough.
Arc operator()(Node s, Node t) const
e!=INVALID&&_g.target(e)!=t;
e = t < _g.target(e)?_left[e]:_right[e]) ;
///Fast look-up of all arcs between given endpoints.
///This class is the same as \ref ArcLookUp, with the addition
///that it makes it possible to find all parallel arcs between given
///\warning This class is static, so you should call refresh() (or at
///least refresh(Node)) to refresh this data structure whenever the
///digraph changes. This is a time consuming (superlinearly proportional
///(<em>O</em>(<em>m</em> log<em>m</em>)) to the number of arcs).
///\tparam G The type of the underlying digraph.
class AllArcLookUp : public ArcLookUp<G>
using ArcLookUp<G>::_right;
using ArcLookUp<G>::_left;
using ArcLookUp<G>::_head;
TEMPLATE_DIGRAPH_TYPEDEFS(G);
typename Digraph::template ArcMap<Arc> _next;
Arc refreshNext(Arc head,Arc next=INVALID)
if(head==INVALID) return next;
next=refreshNext(_right[head],next);
_next[head]=( next!=INVALID && _g.target(next)==_g.target(head))
return refreshNext(_left[head],head);
for(NodeIt n(_g);n!=INVALID;++n) refreshNext(_head[n]);
///It builds up the search database, which remains valid until the digraph
AllArcLookUp(const Digraph &g) : ArcLookUp<G>(g), _next(g) {refreshNext();}
///Refresh the data structure at a node.
///Build up the search database of node \c n.
///It runs in time <em>O</em>(<em>d</em> log<em>d</em>), where <em>d</em> is
///the number of the outgoing arcs of \c n.
ArcLookUp<G>::refresh(n);
///Refresh the full data structure.
///Build up the full search database. In fact, it simply calls
///\ref refresh(Node) "refresh(n)" for each node \c n.
///It runs in time <em>O</em>(<em>m</em> log<em>D</em>), where <em>m</em> is
///the number of the arcs in the digraph and <em>D</em> is the maximum
///out-degree of the digraph.
for(NodeIt n(_g);n!=INVALID;++n) refresh(_head[n]);
///Find an arc between two nodes.
///Find an arc between two nodes.
///\param s The source node.
///\param t The target node.
///\param prev The previous arc between \c s and \c t. It it is INVALID or
///not given, the operator finds the first appropriate arc.
///\return An arc from \c s to \c t after \c prev or
///\ref INVALID if there is no more.
///For example, you can count the number of arcs from \c u to \c v in the
///AllArcLookUp<ListDigraph> ae(g);
///for(Arc a = ae(u,v); a != INVALID; a=ae(u,v,a)) n++;
///Finding the first arc take <em>O</em>(log<em>d</em>) time, where
///<em>d</em> is the number of outgoing arcs of \c s. Then, the
///consecutive arcs are found in constant time.
///\warning If you change the digraph, refresh() must be called before using
///this operator. If you change the outgoing arcs of
///a single node \c n, then \ref refresh(Node) "refresh(n)" is enough.
Arc operator()(Node s, Node t, Arc prev=INVALID) const {}
using ArcLookUp<G>::operator() ;
Arc operator()(Node s, Node t, Arc prev) const
return prev==INVALID?(*this)(s,t):_next[prev];