GraphCopy

Declared in lemon/core.h, in the group Basic Graph Utilities; the same class on the Doxygen site.

template< typename From , typename To >
class GraphCopy

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

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 run() member should be called.

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 );
cg.nodeRef( nr );
// Create cross references (inverse) for the edges
NewGraph::EdgeMap< OrigGraph::Edge > ecr( new_graph );
cg.edgeCrossRef( ecr );
// Copy an edge map
OrigGraph::EdgeMap< double > oemap( orig_graph );
NewGraph::EdgeMap< double > nemap( new_graph );
cg.edgeMap( oemap , nemap );
// Copy a node
OrigGraph::Node on;
NewGraph::Node nn;
cg.node( on , nn );
// Execute copying
cg.run();

Public Functions

inline GraphCopy( const From & from , To & to )

Constructor of GraphCopy.

Constructor of GraphCopy for copying the content of the from graph into the to graph.

inline GraphCopy( GraphCopy && copy )

Move constructor of GraphCopy.

Move constructor of GraphCopy, which takes over the maps to be copied, so that graphCopy() can be returned by value.

GraphCopy( const GraphCopy & ) = delete
GraphCopy & operator=( const GraphCopy & ) = delete
inline ~GraphCopy()

Destructor of GraphCopy.

template< typename NodeRef >
inline GraphCopy & nodeRef( NodeRef & map )

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 destination graph.

template< typename NodeCrossRef >
inline GraphCopy & nodeCrossRef( NodeCrossRef & map )

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 FromMap , typename ToMap >
inline GraphCopy & nodeMap(
const FromMap & map,
ToMap & tmap
)

Make a copy of the given node map.

This function makes a copy of the given node map for the newly created graph. The key type of the new map tmap should be the Node type of the destination graph, and the key type of the original map map should be the Node type of the source graph.

inline GraphCopy & node( const Node & node , TNode & tnode )

Make a copy of the given node.

This function makes a copy of the given node.

template< typename ArcRef >
inline GraphCopy & arcRef( ArcRef & map )

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 destination graph.

template< typename ArcCrossRef >
inline GraphCopy & arcCrossRef( ArcCrossRef & map )

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 FromMap , typename ToMap >
inline GraphCopy & arcMap(
const FromMap & map,
ToMap & tmap
)

Make a copy of the given arc map.

This function makes a copy of the given arc map for the newly created graph. The key type of the new map tmap should be the Arc type of the destination graph, and the key type of the original map map should be the Arc type of the source graph.

inline GraphCopy & arc( const Arc & arc , TArc & tarc )

Make a copy of the given arc.

This function makes a copy of the given arc.

template< typename EdgeRef >
inline GraphCopy & edgeRef( EdgeRef & map )

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 destination graph.

template< typename EdgeCrossRef >
inline GraphCopy & edgeCrossRef( EdgeCrossRef & map )

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 FromMap , typename ToMap >
inline GraphCopy & edgeMap(
const FromMap & map,
ToMap & tmap
)

Make a copy of the given edge map.

This function makes a copy of the given edge map for the newly created graph. The key type of the new map tmap should be the Edge type of the destination graph, and the key type of the original map map should be the Edge type of the source graph.

inline GraphCopy & edge( const Edge & edge , TEdge & tedge )

Make a copy of the given edge.

This function makes a copy of the given edge.

inline void run()

Execute copying.

This function executes the copying of the graph along with the copying of the assigned data.