BpGraphCopy

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

template< typename From , typename To >
class BpGraphCopy

Class to copy a bipartite graph.

Class to copy a bipartite graph to another graph (duplicate a graph). The simplest way of using it is through the bpGraphCopy() function.

This class not only make a copy of a bipartite 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 BpGraphCopy 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:

BpGraphCopy< OrigBpGraph , NewBpGraph > cg( orig_graph , new_graph );
// Create references for the nodes
OrigBpGraph::NodeMap< NewBpGraph::Node > nr( orig_graph );
cg.nodeRef( nr );
// Create cross references (inverse) for the edges
NewBpGraph::EdgeMap< OrigBpGraph::Edge > ecr( new_graph );
cg.edgeCrossRef( ecr );
// Copy a red node map
OrigBpGraph::RedNodeMap< double > ormap( orig_graph );
NewBpGraph::RedNodeMap< double > nrmap( new_graph );
cg.redNodeMap( ormap , nrmap );
// Copy a node
OrigBpGraph::Node on;
NewBpGraph::Node nn;
cg.node( on , nn );
// Execute copying
cg.run();

Public Functions

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

Constructor of BpGraphCopy.

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

inline BpGraphCopy( BpGraphCopy && copy )

Move constructor of BpGraphCopy.

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

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

Destructor of BpGraphCopy.

template< typename NodeRef >
inline BpGraphCopy & 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 BpGraphCopy & 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 BpGraphCopy & 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 BpGraphCopy & node( const Node & node , TNode & tnode )

Make a copy of the given node.

This function makes a copy of the given node.

template< typename RedRef >
inline BpGraphCopy & redRef( RedRef & map )

Copy the red node references into the given map.

This function copies the red node references into the given map. The parameter should be a map, whose key type is the Node type of the source graph with the red item set, while the value type is the Node type of the destination graph.

template< typename RedCrossRef >
inline BpGraphCopy & redCrossRef( RedCrossRef & map )

Copy the red node cross references into the given map.

This function copies the red 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 with the red item set, while the value type is the Node type of the source graph.

template< typename FromMap , typename ToMap >
inline BpGraphCopy & redNodeMap(
const FromMap & map,
ToMap & tmap
)

Make a copy of the given red node map.

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

inline BpGraphCopy & redNode( const RedNode & node , TRedNode & tnode )

Make a copy of the given red node.

This function makes a copy of the given red node.

template< typename BlueRef >
inline BpGraphCopy & blueRef( BlueRef & map )

Copy the blue node references into the given map.

This function copies the blue node references into the given map. The parameter should be a map, whose key type is the Node type of the source graph with the blue item set, while the value type is the Node type of the destination graph.

template< typename BlueCrossRef >
inline BpGraphCopy & blueCrossRef( BlueCrossRef & map )

Copy the blue node cross references into the given map.

This function copies the blue 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 with the blue item set, while the value type is the Node type of the source graph.

template< typename FromMap , typename ToMap >
inline BpGraphCopy & blueNodeMap(
const FromMap & map,
ToMap & tmap
)

Make a copy of the given blue node map.

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

inline BpGraphCopy & blueNode( const BlueNode & node , TBlueNode & tnode )

Make a copy of the given blue node.

This function makes a copy of the given blue node.

template< typename ArcRef >
inline BpGraphCopy & 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 BpGraphCopy & 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 BpGraphCopy & 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 BpGraphCopy & 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 BpGraphCopy & 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 BpGraphCopy & 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 BpGraphCopy & 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 BpGraphCopy & 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.