ogdf::GraphCopy Class Reference

Copies of graphs supporting edge splitting. More...

#include <ogdf/basic/GraphCopy.h>

Inheritance diagram for ogdf::GraphCopy:

Public Member Functions
	GraphCopy ()
	Default constructor (does nothing!).
	GraphCopy (const Graph &G)
	Creates a graph copy of G.
	GraphCopy (const GraphCopy &GC)
	Copy constructor.
virtual	~GraphCopy ()
Mapping between original graph and copy
const Graph &	original () const
	Returns a reference to the original graph.
node	original (node v) const
	Returns the node in the original graph corresponding to v.
edge	original (edge e) const
	Returns the edge in the original graph corresponding to e.
adjEntry	original (adjEntry adj) const
	Returns the adjacency entry in the original graph corresponding to adj.
node	copy (node v) const
	Returns the node in the graph copy corresponding to v.
const List< edge > &	chain (edge e) const
	Returns the list of edges coresponding to edge e.
edge	copy (edge e) const
	Returns the first edge in the list of edges coresponding to edge e.
adjEntry	copy (adjEntry adj) const
	Returns the adjacency entry in the copy graph corresponding to adj.
bool	isDummy (node v) const
	Returns true iff v has no corresponding node in the original graph.
bool	isDummy (edge e) const
	Returns true iff e has no corresponding edge in the original graph.
bool	isReversed (edge e) const
	Returns true iff edge e has been reversed.
bool	isReversedCopyEdge (edge e) const
	Returns true iff e is reversed w.r.t.
Creation and deletion of nodes and edges
node	newNode (node vOrig)
	Creates a new node in the graph copy with original node vOrig.
virtual void	delNode (node v) override
	Removes node v and all its adjacent edges cleaning-up their corresponding lists of original edges.
virtual void	delEdge (edge e) override
	Removes edge e and clears the list of edges corresponding to e's original edge.
virtual void	clear () override
	Removes all nodes and all edges from the graph.
virtual edge	split (edge e) override
	Splits edge e.
void	unsplit (edge eIn, edge eOut) override
	Undoes a previous split operation.
edge	newEdge (edge eOrig)
	Creates a new edge (v,w) with original edge eOrig.
void	setEdge (edge eOrig, edge eCopy)
	sets eOrig to be the corresponding original edge of eCopy and vice versa
bool	embed ()
	Embeds the graph copy.
void	removePseudoCrossings ()
	Removes all crossing nodes which are actually only two "touching" edges.
bool	hasSameEdgesCrossings () const
	Returns whether there are two edges in the GraphCopy that cross each other multiple times.
bool	hasAdjacentEdgesCrossings () const
	Returns whether the GraphCopy contains at least one crossing of two adjacent edges.
bool	hasNonSimpleCrossings () const
	Returns whether the GraphCopy contains crossings that will result in a non-simple drawing.
void	removeNonSimpleCrossings (SListPure< edge > &edgesToCheck, DynamicDualGraph *dualGraph=nullptr)
	Removes all non-simple cossings involving edges from edgesToCheck (see hasNonSimpleCrossings() for a definition of non-simple crossings).
void	removeNonSimpleCrossings (DynamicDualGraph *dualGraph=nullptr)
	Removes all non-simple cossings (see hasNonSimpleCrossings() for a definition of non-simple crossings).
void	removeNonSimpleCrossings (node origNode, DynamicDualGraph *dualGraph=nullptr)
	Removes all non-simple cossings involving edges incident to origNode (see hasNonSimpleCrossings() for a definition of non-simple crossings).
void	insertEdgePath (edge eOrig, const SList< adjEntry > &crossedEdges)
	Re-inserts edge eOrig by "crossing" the edges in crossedEdges.
void	insertEdgePath (node srcOrig, node tgtOrig, const SList< adjEntry > &crossedEdges)
	Special version (for FixedEmbeddingUpwardEdgeInserter only).
void	removeEdgePath (edge eOrig)
	Removes the complete edge path for edge eOrig.
edge	insertCrossing (edge &crossingEdge, edge crossedEdge, bool rightToLeft)
	Inserts crossings between two copy edges.
node	newNode ()
	Creates a new node and returns it.
node	newNode (int index)
	Creates a new node with predefined index and returns it.
edge	newEdge (node v, node w)
	Creates a new edge (v,w) and returns it.
edge	newEdge (node v, node w, int index)
	Creates a new edge (v,w) with predefined index and returns it.
edge	newEdge (adjEntry adjSrc, adjEntry adjTgt, Direction dir=Direction::after)
	Creates a new edge at predefined positions in the adjacency lists.
edge	newEdge (node v, adjEntry adjTgt)
	Creates a new edge at predefined positions in the adjacency lists.
edge	newEdge (adjEntry adjSrc, node w)
	Creates a new edge at predefined positions in the adjacency lists.
Combinatorial Embeddings
edge	newEdge (node v, adjEntry adj, edge eOrig, CombinatorialEmbedding &E)
	Creates a new edge with original edge eOrig in an embedding E.
void	setOriginalEmbedding ()
	Sets the embedding of the graph copy to the embedding of the original graph.
void	insertEdgePathEmbedded (edge eOrig, CombinatorialEmbedding &E, const SList< adjEntry > &crossedEdges)
	Re-inserts edge eOrig by "crossing" the edges in crossedEdges in embedding E.
void	insertEdgePathEmbedded (edge eOrig, CombinatorialEmbedding &E, DynamicDualGraph &dual, const SList< adjEntry > &crossedEdges)
void	removeEdgePathEmbedded (CombinatorialEmbedding &E, edge eOrig, FaceSet< false > &newFaces)
	Removes the complete edge path for edge eOrig while preserving the embedding.
void	removeEdgePathEmbedded (CombinatorialEmbedding &E, DynamicDualGraph &dual, edge eOrig)
Miscellaneous
void	init (const Graph &G)
	Re-initializes the copy using the graph G.
void	createEmpty (const Graph &G)
	Associates the graph copy with G, but does not create any nodes or edges.
void	initByCC (const CCsInfo &info, int cc, EdgeArray< edge > &eCopy)
	Initializes the graph copy for the nodes in component cc.
void	initByNodes (const List< node > &origNodes, EdgeArray< edge > &eCopy)
	Initializes the graph copy for the nodes in a component.
void	initByActiveNodes (const List< node > &nodeList, const NodeArray< bool > &activeNodes, EdgeArray< edge > &eCopy)
	Initializes the graph copy for the nodes in nodeList.
Operators
GraphCopy &	operator= (const GraphCopy &GC)
	Assignment operator.
Public Member Functions inherited from ogdf::Graph
	Graph ()
	Constructs an empty graph.
	Graph (const Graph &G)
	Constructs a graph that is a copy of G.
virtual	~Graph ()
	Destructor.
bool	empty () const
	Returns true iff the graph is empty, i.e., contains no nodes.
int	numberOfNodes () const
	Returns the number of nodes in the graph.
int	numberOfEdges () const
	Returns the number of edges in the graph.
int	maxNodeIndex () const
	Returns the largest used node index.
int	maxEdgeIndex () const
	Returns the largest used edge index.
int	maxAdjEntryIndex () const
	Returns the largest used adjEntry index.
int	nodeArrayTableSize () const
	Returns the table size of node arrays associated with this graph.
int	edgeArrayTableSize () const
	Returns the table size of edge arrays associated with this graph.
int	adjEntryArrayTableSize () const
	Returns the table size of adjEntry arrays associated with this graph.
node	firstNode () const
	Returns the first node in the list of all nodes.
node	lastNode () const
	Returns the last node in the list of all nodes.
edge	firstEdge () const
	Returns the first edge in the list of all edges.
edge	lastEdge () const
	Returns the last edge in the list of all edges.
node	chooseNode (std::function< bool(node)> includeNode=[](node) { return true;}, bool isFastTest=true) const
	Returns a random node.
edge	chooseEdge (std::function< bool(edge)> includeEdge=[](edge) { return true;}, bool isFastTest=true) const
	Returns a random edge.
template<class CONTAINER >
void	allNodes (CONTAINER &nodeContainer) const
	Returns a container with all nodes of the graph.
template<class CONTAINER >
void	allEdges (CONTAINER &edgeContainer) const
	Returns a container with all edges of the graph.
node	newNode ()
	Creates a new node and returns it.
node	newNode (int index)
	Creates a new node with predefined index and returns it.
edge	newEdge (node v, node w)
	Creates a new edge (v,w) and returns it.
edge	newEdge (node v, node w, int index)
	Creates a new edge (v,w) with predefined index and returns it.
edge	newEdge (adjEntry adjSrc, adjEntry adjTgt, Direction dir=Direction::after)
	Creates a new edge at predefined positions in the adjacency lists.
edge	newEdge (node v, adjEntry adjTgt)
	Creates a new edge at predefined positions in the adjacency lists.
edge	newEdge (adjEntry adjSrc, node w)
	Creates a new edge at predefined positions in the adjacency lists.
void	insert (const Graph &G, NodeArray< node > &nodeMap)
	Inserts Graph G as a subgraph into this Graph.
void	insert (const Graph &G)
	Inserts Graph G as a subgraph into this Graph.
void	unsplit (node u)
	Undoes a split operation.
node	splitNode (adjEntry adjStartLeft, adjEntry adjStartRight)
	Splits a node while preserving the order of adjacency entries.
node	contract (edge e, bool keepSelfLoops=false)
	Contracts edge e while preserving the order of adjacency entries.
void	move (edge e, adjEntry adjSrc, Direction dirSrc, adjEntry adjTgt, Direction dirTgt)
	Moves edge e to a different adjacency list.
void	moveTarget (edge e, node w)
	Moves the target node of edge e to node w.
void	moveTarget (edge e, adjEntry adjTgt, Direction dir)
	Moves the target node of edge e to a specific position in an adjacency list.
void	moveSource (edge e, node w)
	Moves the source node of edge e to node w.
void	moveSource (edge e, adjEntry adjSrc, Direction dir)
	Moves the source node of edge e to a specific position in an adjacency list.
edge	searchEdge (node v, node w, bool directed=false) const
	Searches and returns an edge connecting nodes v and w in time O( min(deg(v ), deg(w ))).
void	reverseEdge (edge e)
	Reverses the edge e, i.e., exchanges source and target node.
void	reverseAllEdges ()
	Reverses all edges in the graph.
template<class NODELIST >
void	collapse (NODELIST &nodesToCollapse)
	Collapses all nodes in the list nodesToCollapse to the first node in the list.
template<class ADJ_ENTRY_LIST >
void	sort (node v, const ADJ_ENTRY_LIST &newOrder)
	Sorts the adjacency list of node v according to newOrder.
void	reverseAdjEdges (node v)
	Reverses the adjacency list of v.
void	moveAdj (adjEntry adjMove, Direction dir, adjEntry adjPos)
	Moves adjacency entry adjMove before or after adjPos.
void	moveAdjAfter (adjEntry adjMove, adjEntry adjAfter)
	Moves adjacency entry adjMove after adjAfter.
void	moveAdjBefore (adjEntry adjMove, adjEntry adjBefore)
	Moves adjacency entry adjMove before adjBefore.
void	reverseAdjEdges ()
	Reverses all adjacency lists.
void	swapAdjEdges (adjEntry adj1, adjEntry adj2)
	Exchanges two entries in an adjacency list.
int	genus () const
	Returns the genus of the graph's embedding.
bool	representsCombEmbedding () const
	Returns true iff the graph represents a combinatorial embedding.
ListIterator< NodeArrayBase * >	registerArray (NodeArrayBase *pNodeArray) const
	Registers a node array.
ListIterator< EdgeArrayBase * >	registerArray (EdgeArrayBase *pEdgeArray) const
	Registers an edge array.
ListIterator< AdjEntryArrayBase * >	registerArray (AdjEntryArrayBase *pAdjArray) const
	Registers an adjEntry array.
ListIterator< GraphObserver * >	registerStructure (GraphObserver *pStructure) const
	Registers a graph observer (e.g. a ClusterGraph).
void	unregisterArray (ListIterator< NodeArrayBase * > it) const
	Unregisters a node array.
void	unregisterArray (ListIterator< EdgeArrayBase * > it) const
	Unregisters an edge array.
void	unregisterArray (ListIterator< AdjEntryArrayBase * > it) const
	Unregisters an adjEntry array.
void	unregisterStructure (ListIterator< GraphObserver * > it) const
	Unregisters a graph observer.
template<class ArrayBase >
void	moveRegisterArray (ListIterator< ArrayBase * > it, ArrayBase *pArray) const
	Move the registration it of an graph element array to pArray (used with move semantics for graph element arrays).
void	resetEdgeIdCount (int maxId)
	Resets the edge id count to maxId.
Graph &	operator= (const Graph &G)
	Assignment operator.

Protected Member Functions
void	removeAdjacentEdgesCrossing (adjEntry adj1, adjEntry adj2, DynamicDualGraph *dualGraph)
	Removes the crossing of the two adjacent edges adj1->theEdge() and adj2->theEdge().
void	removeSameEdgesCrossing (adjEntry adjFirstCrossing1, adjEntry adjFirstCrossing2, adjEntry adjSecondCrossing1, adjEntry adjSecondCrossing2, DynamicDualGraph *dualGraph)
	Removes the two crossings given by the adjEntries, assuming that both crossings stem from the same two edges.
void	removeUnnecessaryCrossing (adjEntry adj, DynamicDualGraph *dualGraph)
	Removes the pseudo crossing that adj belongs to.
void	removeUnnecessaryCrossing (adjEntry adjA1, adjEntry adjA2, adjEntry adjB1, adjEntry adjB2)
void	setOriginalEdgeAlongCrossings (adjEntry adjCopy1, adjEntry adjCopy2, node vCopy, edge eOrig1, edge eOrig2)
	Sets the original edges from adjCopy1 up to vCopy to eOrig2, and the original edges from adjCopy2 up to vCopy to eOrig1.
void	swapOriginalEdgesAtCrossing (adjEntry adjCopy1, adjEntry adjCopy2, DynamicDualGraph *dual=nullptr)
	Swaps the original edges from adjCopy1 up to the common node of {adjCopy1, adjCopy2} with the original edges from adjCopy2 up to the same common node.
void	swapOriginalEdgesBetweenCrossings (adjEntry adjFirstCrossing1, adjEntry adjFirstCrossing2, adjEntry adjSecondCrossing1, adjEntry adjSecondCrossing2, DynamicDualGraph *dual=nullptr)
	Swaps the original edges from adjFirstCrossing1 up to adjSecondCrossing1->theNode() with the original edges from adjFirstCrossing2 up to adjSecondCrossing2->theNode().
Protected Member Functions inherited from ogdf::Graph
void	assign (const Graph &G, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
void	construct (const Graph &G, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
void	constructInitByActiveNodes (const List< node > &nodeList, const NodeArray< bool > &activeNodes, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
void	constructInitByCC (const CCsInfo &info, int cc, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
	Constructs a copy of connected component cc in info.
void	constructInitByNodes (const Graph &G, const List< node > &nodeList, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
	Constructs a copy of the subgraph of G induced by nodeList.

Protected Attributes
EdgeArray< List< edge > >	m_eCopy
	The corresponding list of edges in the graph copy.
EdgeArray< ListIterator< edge > >	m_eIterator
	The position of copy edge in the list.
EdgeArray< edge >	m_eOrig
	The corresponding edge in the original graph.
const Graph *	m_pGraph
	The original graph.
NodeArray< node >	m_vCopy
	The corresponding node in the graph copy.
NodeArray< node >	m_vOrig
	The corresponding node in the original graph.

Private Member Functions
void	initGC (const GraphCopy &GC, NodeArray< node > &vCopy, EdgeArray< edge > &eCopy)

Additional Inherited Members
Public Types inherited from ogdf::Graph
enum class	EdgeType { association = 0 , generalization = 1 , dependency = 2 }
	The type of edges (only used in derived classes). More...
enum class	NodeType { vertex = 0 , dummy = 1 , generalizationMerger = 2 , generalizationExpander = 3 , highDegreeExpander = 4 , lowDegreeExpander = 5 , associationClass = 6 }
	The type of nodes. More...
using	node_iterator = internal::GraphIterator< node >
	Provides a bidirectional iterator to a node in a graph.
using	edge_iterator = internal::GraphIterator< edge >
	Provides a bidirectional iterator to an edge in a graph.
using	adjEntry_iterator = internal::GraphIterator< adjEntry >
	Provides a bidirectional iterator to an entry in an adjacency list.
Public Attributes inherited from ogdf::Graph
internal::GraphObjectContainer< NodeElement >	nodes
	The container containing all node objects.
internal::GraphObjectContainer< EdgeElement >	edges
	The container containing all edge objects.

Detailed Description

Copies of graphs supporting edge splitting.

The class GraphCopy represents a copy of a graph and maintains a mapping between the nodes and edges of the original graph to the copy and vice versa.

New nodes and edges can be added to the copy; the counterpart of those nodes and edges is 0 indicating that there is no counterpart. GraphCopy also support splitting of edges in such a way that both edges resulting from the split are mapped to the same original edge, and each edge of the original graph is mapped to a list of edges. Furthermore, it is allowed to reverse edges in the graph copy.

Do's and Dont's

Here is a short summary, what can be done with GraphCopy, and what should not be done. The following operations are safely supported:

• Splitting of edges such that an original edge is represented by a path in the copy (split(), unsplit()).
• Reversing edges in the copy (Graph::reverseEdge(), Graph::reverseAllEdges()).
• Reinsertion of original edges such that they are represented by a path in the copy (insertEdgePath(), insertEdgePathEmbedded(), removeEdgePath(), removeEdgePathEmbedded()).
• Inserting and removing dummy edges in the copy which are not associated with edges in the original graph.

The following operations are not supported and are thus dangerous:

• Any modifications on the original graph, since the copy will not be notified.
• Moving the source or target node of an edge in the copy to a different node.
• Removing edges in the graph copy that belong to a path representing an original edge.
• ... (better think first!)

Definition at line 254 of file GraphCopy.h.

Constructor & Destructor Documentation

GraphCopy() [1/3]

ogdf::GraphCopy::GraphCopy ( const Graph &  G )

explicit

Creates a graph copy of G.

See init for details.

GraphCopy() [2/3]

ogdf::GraphCopy::GraphCopy ( )

inline

Default constructor (does nothing!).

Definition at line 272 of file GraphCopy.h.

GraphCopy() [3/3]

ogdf::GraphCopy::GraphCopy

(

const GraphCopy &

GC

)

Copy constructor.

Creates a graph copy that is a copy of GC and represents a graph copy of the original graph of GC.

~GraphCopy()

virtual ogdf::GraphCopy::~GraphCopy ( )

inlinevirtual

Definition at line 281 of file GraphCopy.h.

Member Function Documentation

chain()

const List< edge > & ogdf::GraphCopy::chain ( edge  e ) const

inline

Returns the list of edges coresponding to edge e.

Parameters

e	is an edge in the original graph.

Returns

the corresponding list of edges in the graph copy.

Definition at line 345 of file GraphCopy.h.

clear()

virtual void ogdf::GraphCopy::clear ( )

overridevirtual

Removes all nodes and all edges from the graph.

Reimplemented from ogdf::Graph.

copy() [1/3]

adjEntry ogdf::GraphCopy::copy ( adjEntry  adj ) const

inline

Returns the adjacency entry in the copy graph corresponding to adj.

Note that this method does not pay attention to reversed edges. Given a source (target) adjacency entry, the first (last) source (target) adjacency entry of the copy chain is returned.

Parameters

adj	is an adjacency entry in the copy graph.

Returns

the corresponding adjacency entry in the original graph.

Definition at line 366 of file GraphCopy.h.

copy() [2/3]

edge ogdf::GraphCopy::copy ( edge  e ) const

inline

Returns the first edge in the list of edges coresponding to edge e.

Parameters

e	is an edge in the original graph.

Returns

the first edge in the corresponding list of edges in the graph copy or nullptr if it does not exist.

Definition at line 354 of file GraphCopy.h.

copy() [3/3]

node ogdf::GraphCopy::copy ( node  v ) const

inline

Returns the node in the graph copy corresponding to v.

Parameters

v	is a node in the original graph.

Returns

the corresponding node in the graph copy.

Definition at line 338 of file GraphCopy.h.

createEmpty()

void ogdf::GraphCopy::createEmpty

(

const Graph &

G

)

Associates the graph copy with G, but does not create any nodes or edges.

By using this method, the graph copy gets associated with G. This does not modify the existing nodes and edges, but they become dummies.

The following code snippet shows a typical application of this functionality:

GraphCopy GC;
GC.createEmpty(G);
 
// compute connected components of G
NodeArray<int> component(G);
int numCC = connectedComponents(G,component);
 
// intialize the array of lists of nodes contained in a CC
Array<List<node> > nodesInCC(numCC);
 
for(node v : G.nodes)
  nodesInCC[component[v]].pushBack(v);
 
EdgeArray<edge> auxCopy(G);
Array<DPoint> boundingBox(numCC);
 
for(int i = 0; i < numCC; ++i) {
  GC.initByNodes(nodesInCC[i],auxCopy);
  ...
}

Parameters

G	is the graph of which this graph copy shall be a copy.

delEdge()

virtual void ogdf::GraphCopy::delEdge ( edge  e )

overridevirtual

Removes edge e and clears the list of edges corresponding to e's original edge.

Precondition

The list of edges corresponding to e's original edge contains only e.

Parameters

e	is an edge in the graph copy.

Reimplemented from ogdf::Graph.

delNode()

virtual void ogdf::GraphCopy::delNode ( node  v )

overridevirtual

Removes node v and all its adjacent edges cleaning-up their corresponding lists of original edges.

Precondition

The corresponding lists oforiginal edges contain each only one edge.

Parameters

v	is a node in the graph copy.

Reimplemented from ogdf::Graph.

embed()

bool ogdf::GraphCopy::embed

(

)

Embeds the graph copy.

Deprecated:

"Use ogdf::planarEmbed() instead."

hasAdjacentEdgesCrossings()

bool ogdf::GraphCopy::hasAdjacentEdgesCrossings

(

)

const

Returns whether the GraphCopy contains at least one crossing of two adjacent edges.

hasNonSimpleCrossings()

bool ogdf::GraphCopy::hasNonSimpleCrossings ( ) const

inline

Returns whether the GraphCopy contains crossings that will result in a non-simple drawing.

This method will return true iff the GraphCopy contains a) a crossing of two adjacent edges (see hasAdjacentEdgesCrossings()), or b) two edges crossing each other multiple times (see hasSameEdgesCrossings()).

Warning

Crossings of an edge with itself are currently not detected.

Definition at line 495 of file GraphCopy.h.

hasSameEdgesCrossings()

bool ogdf::GraphCopy::hasSameEdgesCrossings

(

)

const

Returns whether there are two edges in the GraphCopy that cross each other multiple times.

init()

void ogdf::GraphCopy::init

(

const Graph &

G

)

Re-initializes the copy using the graph G.

This method assures that the adjacency lists of nodes in the constructed copy are in the same order as the adjacency lists in G. This is in particular important when dealing with embedded graphs.

Parameters

G	the graph to be copied

initByActiveNodes()

void ogdf::GraphCopy::initByActiveNodes	(	const List< node > &	nodeList,
		const NodeArray< bool > &	activeNodes,
		EdgeArray< edge > &	eCopy
	)

Initializes the graph copy for the nodes in nodeList.

Creates copies of all nodes in nodeList and edges between two nodes which are both contained in nodeList. Any nodes and edges allocated before are destroyed.

See also

createEmpty()

Parameters

nodeList	is the list of nodes in the original graph for which copies are created in the graph copy.
activeNodes	must be true for every node in nodeList, false otherwise.
eCopy	is assigned the copy of each original edge.

initByCC()

void ogdf::GraphCopy::initByCC	(	const CCsInfo &	info,
		int	cc,
		EdgeArray< edge > &	eCopy
	)

Initializes the graph copy for the nodes in component cc.

Parameters

info	must be a connected component info structure for the original graph.
cc	is the number of the connected component.
eCopy	is assigned a mapping from original to copy edges.

initByNodes()

void ogdf::GraphCopy::initByNodes	(	const List< node > &	origNodes,
		EdgeArray< edge > &	eCopy
	)

Initializes the graph copy for the nodes in a component.

Creates copies of all nodes in origNodes and their incident edges. Any nodes and edges allocated before are removed.

The order of entries in the adjacency lists is preserved, i.e., if the original graph is embedded, its embedding induces the embedding of the created copy.

It is important that origNodes is the complete list of nodes in a connected component. If you wish to initialize the graph copy for an arbitrary set of nodes, use the method initByActiveNodes().

See also

createEmpty() for an example.

Parameters

origNodes	is the list of nodes in the original graph for which copies are created in the graph copy.
eCopy	is assigned the copy of each original edge.

initGC()

void ogdf::GraphCopy::initGC ( const GraphCopy &  GC, NodeArray< node > &  vCopy, EdgeArray< edge > &  eCopy  )

private

insertCrossing()

edge ogdf::GraphCopy::insertCrossing	(	edge &	crossingEdge,
		edge	crossedEdge,
		bool	rightToLeft
	)

Inserts crossings between two copy edges.

This method is used in TopologyModule.

Let crossingEdge = (a, b) and crossedEdge = (v, w). Then crossedEdge is split creating two edges crossedEdge = (v, u) and (u, w), crossingEdge is removed and replaced by two new edges e1 = (a, u) and e2 = (u, b). Finally it sets crossingEdge to e2 and returns (u, w).

Parameters

crossingEdge	is the edge that is replaced by two new edges. Note that this parameter will be modified to equal the newly created edge (u, b).
crossedEdge	is the edge that gets split.
rightToLeft	is used as follows: If set to true, crossingEdge will cross crossedEdge from right to left, otherwise from left to right.

Returns

the rear edge resulting from the split operation: (u, w)

insertEdgePath() [1/2]

void ogdf::GraphCopy::insertEdgePath	(	edge	eOrig,
		const SList< adjEntry > &	crossedEdges
	)

Re-inserts edge eOrig by "crossing" the edges in crossedEdges.

Let v and w be the copies of the source and target nodes of eOrig. Each edge in crossedEdges is split creating a sequence u_1, ..., u_k of new nodes, and additional edges are inserted creating a path v, u_1, ..., u_k, w.

Parameters

eOrig	is an edge in the original graph and becomes the original edge of all edges in the path v, u_1, ..., u_k, w.
crossedEdges	are edges in the graph copy.

insertEdgePath() [2/2]

void ogdf::GraphCopy::insertEdgePath	(	node	srcOrig,
		node	tgtOrig,
		const SList< adjEntry > &	crossedEdges
	)

Special version (for FixedEmbeddingUpwardEdgeInserter only).

insertEdgePathEmbedded() [1/2]

void ogdf::GraphCopy::insertEdgePathEmbedded	(	edge	eOrig,
		CombinatorialEmbedding &	E,
		const SList< adjEntry > &	crossedEdges
	)

Re-inserts edge eOrig by "crossing" the edges in crossedEdges in embedding E.

Let v and w be the copies of the source and target nodes of eOrig, and let e_0, e_1, ..., e_k, e_{k+1} be the sequence of edges corresponding to the adjacency entries in crossedEdges. The first edge needs to be incident to v and the last to w; the edges e_1, ..., e_k are each split creating a sequence u_1, ..., u_k of new nodes, and additional edges are inserted creating a path v, u_1, ..., u_k, w.

The following figure illustrates, which adjacency entries need to be in the list crossedEdges. It inserts an edge connecting v and w by passing through the faces f_0, f_1, f_2; in this case, the list crossedEdges must contain the adjacency entries adj_0, ..., adj_3 (in this order).

Parameters

eOrig	is an edge in the original graph and becomes the original edge of all edges in the path v, u_1, ..., u_k, w.
E	is an embedding of the graph copy.
crossedEdges	are a list of adjacency entries in the graph copy.

insertEdgePathEmbedded() [2/2]

void ogdf::GraphCopy::insertEdgePathEmbedded	(	edge	eOrig,
		CombinatorialEmbedding &	E,
		DynamicDualGraph &	dual,
		const SList< adjEntry > &	crossedEdges
	)

isDummy() [1/2]

bool ogdf::GraphCopy::isDummy ( edge  e ) const

inline

Returns true iff e has no corresponding edge in the original graph.

Parameters

e	is an edge in the graph copy.

Definition at line 386 of file GraphCopy.h.

isDummy() [2/2]

bool ogdf::GraphCopy::isDummy ( node  v ) const

inline

Returns true iff v has no corresponding node in the original graph.

Parameters

v	is a node in the graph copy.

Definition at line 380 of file GraphCopy.h.

isReversed()

bool ogdf::GraphCopy::isReversed ( edge  e ) const

inline

Returns true iff edge e has been reversed.

Parameters

e	is an edge in the original graph.

Definition at line 392 of file GraphCopy.h.

isReversedCopyEdge()

bool ogdf::GraphCopy::isReversedCopyEdge

(

edge

e

)

const

Returns true iff e is reversed w.r.t.

the original edge of e. This method should be used, if the copy edge is split and e is part of the chain of the original edge. This method assumes that the list of copy edges forms a chain

Parameters

e	is an edge in the graphcopy

newEdge() [1/7]

edge ogdf::Graph::newEdge	(	adjEntry	adjSrc,
		adjEntry	adjTgt,
		Direction	dir = Direction::after
	)

Creates a new edge at predefined positions in the adjacency lists.

Let v be the node whose adjacency list contains adjSrc, and w the node whose adjacency list contains adjTgt. Then, the created edge is (v,w).

Parameters

adjSrc	is the adjacency entry after which the new edge is inserted in the adjacency list of v.
adjTgt	is the adjacency entry after which the new edge is inserted in the adjacency list of w.
dir	specifies if the edge is inserted before or after the given adjacency entries.

Returns

the newly created edge.

newEdge() [2/7]

edge ogdf::Graph::newEdge	(	adjEntry	adjSrc,
		node	w
	)

Creates a new edge at predefined positions in the adjacency lists.

Let v be the node whose adjacency list contains adjSrc. Then, the created edge is (v,w).

Parameters

adjSrc	is the adjacency entry after which the new edge is inserted in the adjacency list of v.
w	is the source node of the new edge; the edge is added at the end of the adjacency list of w.

Returns

the newly created edge.

newEdge() [3/7]

edge ogdf::GraphCopy::newEdge

(

edge

eOrig

)

Creates a new edge (v,w) with original edge eOrig.

newEdge() [4/7]

edge ogdf::GraphCopy::newEdge	(	node	v,
		adjEntry	adj,
		edge	eOrig,
		CombinatorialEmbedding &	E
	)

Creates a new edge with original edge eOrig in an embedding E.

Let w be the node whose adjacency list contains adjTgt. The original edge eOrig must connect the original nodes of v and w. If eOrig = (original(v),original(w)), then the created edge is (v,w), otherwise it is (w,v). The new edge e must split a face in E, such that e comes after adj in the adjacency list of v and at the end of the adjacency list of v.

Parameters

v	is a node in the graph copy.
adj	is an adjacency entry in the graph copy.
eOrig	is an edge in the original graph.
E	is an embedding of the graph copy.

Returns

the created edge.

newEdge() [5/7]

edge ogdf::Graph::newEdge	(	node	v,
		adjEntry	adjTgt
	)

Creates a new edge at predefined positions in the adjacency lists.

Let w be the node whose adjacency list contains adjTgt. Then, the created edge is (v,w).

Parameters

v	is the source node of the new edge; the edge is added at the end of the adjacency list of v.
adjTgt	is the adjacency entry after which the new edge is inserted in the adjacency list of w.

Returns

the newly created edge.

newEdge() [6/7]

edge ogdf::Graph::newEdge	(	node	v,
		node	w
	)

Creates a new edge (v,w) and returns it.

Parameters

v	is the source node of the newly created edge.
w	is the target node of the newly created edge.

Returns

the newly created edge.

newEdge() [7/7]

edge ogdf::Graph::newEdge	(	node	v,
		node	w,
		int	index
	)

Creates a new edge (v,w) with predefined index and returns it.

Precondition

index is currently not the index of any other edge in the graph.

Attention

Passing an edge index that is already in use results in an inconsistent data structure. Only use this method if you know what you're doing!

Parameters

v	is the source node of the newly created edge.
w	is the target node of the newly created edge.
index	is the index that will be assigned to the newly created edge.

Returns

the newly created edge.

newNode() [1/3]

node ogdf::Graph::newNode

(

)

Creates a new node and returns it.

newNode() [2/3]

node ogdf::Graph::newNode

(

int

index

)

Creates a new node with predefined index and returns it.

Precondition

index is currently not the index of any other node in the graph.

Attention

Passing a node index that is already in use results in an inconsistent data structure. Only use this method if you know what you're doing!

Parameters

index

is the index that will be assigned to the newly created node.

Returns

the newly created node.

newNode() [3/3]

node ogdf::GraphCopy::newNode ( node  vOrig )

inline

Creates a new node in the graph copy with original node vOrig.

Warning

You have to make sure that the original node makes sense, in particular that vOrig is not the original node of another node in the copy.

Definition at line 412 of file GraphCopy.h.

operator=()

GraphCopy & ogdf::GraphCopy::operator=

(

const GraphCopy &

GC

)

Assignment operator.

Creates a graph copy that is a copy of GC and represents a graph copy of the original graph of GC.

The constructor assures that the adjacency lists of nodes in the constructed graph are in the same order as the adjacency lists in G. This is in particular important when dealing with embedded graphs.

original() [1/4]

const Graph & ogdf::GraphCopy::original ( ) const

inline

Returns a reference to the original graph.

Definition at line 289 of file GraphCopy.h.

original() [2/4]

adjEntry ogdf::GraphCopy::original ( adjEntry  adj ) const

inline

Returns the adjacency entry in the original graph corresponding to adj.

Note that this method does not pay attention to reversed edges. Given a source (target) adjacency entry, the source (target) adjacency entry of the original edge is returned.

This method must not be called on inner adjacency entries of a copy chain but only on a chain's source/target entry.

Parameters

adj	is an adjacency entry in the copy graph.

Returns

the corresponding adjacency entry in the original graph.

Definition at line 320 of file GraphCopy.h.

original() [3/4]

edge ogdf::GraphCopy::original ( edge  e ) const

inline

Returns the edge in the original graph corresponding to e.

Parameters

e	is an edge in the graph copy.

Returns

the corresponding edge in the original graph, or 0 if no such edge exists.

Definition at line 305 of file GraphCopy.h.

original() [4/4]

node ogdf::GraphCopy::original ( node  v ) const

inline

Returns the node in the original graph corresponding to v.

Parameters

v	is a node in the graph copy.

Returns

the corresponding node in the original graph, or 0 if no such node exists.

Definition at line 297 of file GraphCopy.h.

removeAdjacentEdgesCrossing()

void ogdf::GraphCopy::removeAdjacentEdgesCrossing ( adjEntry  adj1, adjEntry  adj2, DynamicDualGraph *  dualGraph  )

protected

Removes the crossing of the two adjacent edges adj1->theEdge() and adj2->theEdge().

Precondition

adj1 and adj2 are successive adjEntries of the same node, pointing towards the common node of both of their original edges.

removeEdgePath()

void ogdf::GraphCopy::removeEdgePath

(

edge

eOrig

)

Removes the complete edge path for edge eOrig.

@param eOrig is an edge in the original graph.

removeEdgePathEmbedded() [1/2]

void ogdf::GraphCopy::removeEdgePathEmbedded	(	CombinatorialEmbedding &	E,
		DynamicDualGraph &	dual,
		edge	eOrig
	)

removeEdgePathEmbedded() [2/2]

void ogdf::GraphCopy::removeEdgePathEmbedded	(	CombinatorialEmbedding &	E,
		edge	eOrig,
		FaceSet< false > &	newFaces
	)

Removes the complete edge path for edge eOrig while preserving the embedding.

If an endpoint of eOrig has degree 1, the node is also deleted (since removing the edge path would otherwise isolated the node, resulting in a broken embedding).

Parameters

E	is an embedding of the graph copy.
eOrig	is an edge in the original graph.
newFaces	is assigned the set of new faces resulting from joining faces when removing edges.

removeNonSimpleCrossings() [1/3]

void ogdf::GraphCopy::removeNonSimpleCrossings ( DynamicDualGraph *  dualGraph = nullptr )

inline

Removes all non-simple cossings (see hasNonSimpleCrossings() for a definition of non-simple crossings).

Warning

Crossings of an edge with itself are currently not removed.

Parameters

dualGraph

points to the dual graph of *this. Can be nullptr if only the GraphCopy should be changed.

Definition at line 522 of file GraphCopy.h.

removeNonSimpleCrossings() [2/3]

void ogdf::GraphCopy::removeNonSimpleCrossings ( node  origNode, DynamicDualGraph *  dualGraph = nullptr  )

inline

Removes all non-simple cossings involving edges incident to origNode (see hasNonSimpleCrossings() for a definition of non-simple crossings).

Warning

Crossings of an edge with itself are currently not removed.

Parameters

origNode	original node from whose incident edges non-simple crossings are removed.
dualGraph	points to the dual graph of *this. Can be nullptr if only the GraphCopy should be changed.

Definition at line 539 of file GraphCopy.h.

removeNonSimpleCrossings() [3/3]

void ogdf::GraphCopy::removeNonSimpleCrossings	(	SListPure< edge > &	edgesToCheck,
		DynamicDualGraph *	dualGraph = nullptr
	)

Removes all non-simple cossings involving edges from edgesToCheck (see hasNonSimpleCrossings() for a definition of non-simple crossings).

Warning

Crossings of an edge with itself are currently not removed.

Parameters

edgesToCheck	edges from which non-simple crossings should be removed.
dualGraph	points to the dual graph of *this. Can be nullptr if only the GraphCopy should be changed.

removePseudoCrossings()

void ogdf::GraphCopy::removePseudoCrossings

(

)

Removes all crossing nodes which are actually only two "touching" edges.

removeSameEdgesCrossing()

void ogdf::GraphCopy::removeSameEdgesCrossing ( adjEntry  adjFirstCrossing1, adjEntry  adjFirstCrossing2, adjEntry  adjSecondCrossing1, adjEntry  adjSecondCrossing2, DynamicDualGraph *  dualGraph  )

protected

Removes the two crossings given by the adjEntries, assuming that both crossings stem from the same two edges.

Precondition

adjFirstCrossing1 and adjFirstCrossing2 as well as adjSecondCrossing1 and adjSecondCrossing2 are successive adjEntries of the same node respectively, such that the former point towards the latter and vice versa.

removeUnnecessaryCrossing() [1/2]

void ogdf::GraphCopy::removeUnnecessaryCrossing ( adjEntry  adj, DynamicDualGraph *  dualGraph  )

protected

Removes the pseudo crossing that adj belongs to.

In comparison to removeUnnecessaryCrossing(adjEntry, adjEntry, adjEntry, adjEntry), this method allows to change a dual graph as well.

Precondition

adj->theNode() is a crossing with two incoming and two outgoing edges. adj and its successor must be part of the same original edge; the same holds for the next two successors respectively.

removeUnnecessaryCrossing() [2/2]

void ogdf::GraphCopy::removeUnnecessaryCrossing ( adjEntry  adjA1, adjEntry  adjA2, adjEntry  adjB1, adjEntry  adjB2  )

protected

setEdge()

void ogdf::GraphCopy::setEdge	(	edge	eOrig,
		edge	eCopy
	)

sets eOrig to be the corresponding original edge of eCopy and vice versa

Parameters

eOrig	is the original edge
eCopy	is the edge copy

setOriginalEdgeAlongCrossings()

void ogdf::GraphCopy::setOriginalEdgeAlongCrossings ( adjEntry  adjCopy1, adjEntry  adjCopy2, node  vCopy, edge  eOrig1, edge  eOrig2  )

protected

Sets the original edges from adjCopy1 up to vCopy to eOrig2, and the original edges from adjCopy2 up to vCopy to eOrig1.

setOriginalEmbedding()

void ogdf::GraphCopy::setOriginalEmbedding

(

)

Sets the embedding of the graph copy to the embedding of the original graph.

Precondition

The graph copy has not been changed after construction, i.e., no new nodes or edges have been added and no edges have been split.

split()

virtual edge ogdf::GraphCopy::split ( edge  e )

overridevirtual

Splits edge e.

See Graph::split for details. Both resulting edges have the same original edge.

Parameters

e	is an edge in the graph copy.

Reimplemented from ogdf::Graph.

Reimplemented in ogdf::ClusterPlanRep, ogdf::PlanRep, ogdf::PlanRepInc, and ogdf::PlanRepUML.

swapOriginalEdgesAtCrossing()

void ogdf::GraphCopy::swapOriginalEdgesAtCrossing ( adjEntry  adjCopy1, adjEntry  adjCopy2, DynamicDualGraph *  dual = nullptr  )

protected

Swaps the original edges from adjCopy1 up to the common node of {adjCopy1, adjCopy2} with the original edges from adjCopy2 up to the same common node.

Can be used to fix crossings of adjacent edges.

Precondition

Both adjCopy1 and adjCopy2 must point towards a common original node at the end of their chains.

swapOriginalEdgesBetweenCrossings()

void ogdf::GraphCopy::swapOriginalEdgesBetweenCrossings ( adjEntry  adjFirstCrossing1, adjEntry  adjFirstCrossing2, adjEntry  adjSecondCrossing1, adjEntry  adjSecondCrossing2, DynamicDualGraph *  dual = nullptr  )

protected

Swaps the original edges from adjFirstCrossing1 up to adjSecondCrossing1->theNode() with the original edges from adjFirstCrossing2 up to adjSecondCrossing2->theNode().

Can be used to fix multiple crossings of the same two edges.

unsplit()

void ogdf::GraphCopy::unsplit ( edge  eIn, edge  eOut  )

overridevirtual

Undoes a previous split operation.

The two edges eIn and eOut are merged to a single edge eIn.

Precondition

The vertex u that was created by the previous split operation has exactly one incoming edge eIn and one outgoing edge eOut.

Parameters

eIn	is an edge (*,u) in the graph copy.
eOut	is an edge (u,*) in the graph copy.

Reimplemented from ogdf::Graph.

Member Data Documentation

m_eCopy

EdgeArray<List<edge> > ogdf::GraphCopy::m_eCopy

protected

The corresponding list of edges in the graph copy.

Definition at line 262 of file GraphCopy.h.

m_eIterator

EdgeArray<ListIterator<edge> > ogdf::GraphCopy::m_eIterator

protected

The position of copy edge in the list.

Definition at line 259 of file GraphCopy.h.

m_eOrig

EdgeArray<edge> ogdf::GraphCopy::m_eOrig

protected

The corresponding edge in the original graph.

Definition at line 258 of file GraphCopy.h.

m_pGraph

const Graph* ogdf::GraphCopy::m_pGraph

protected

The original graph.

Definition at line 256 of file GraphCopy.h.

m_vCopy

NodeArray<node> ogdf::GraphCopy::m_vCopy

protected

The corresponding node in the graph copy.

Definition at line 261 of file GraphCopy.h.

m_vOrig

NodeArray<node> ogdf::GraphCopy::m_vOrig

protected

The corresponding node in the original graph.

Definition at line 257 of file GraphCopy.h.

---

The documentation for this class was generated from the following file:

• include/ogdf/basic/GraphCopy.h