Copies of graphs supporting edge splitting. More...

#include <ogdf/basic/GraphCopy.h>

Inheritance diagram for ogdf::GraphCopy:

Public Member Functions
	GraphCopy ()

	GraphCopy (const Graph &G)

	GraphCopy (const Graph *G)

	GraphCopy (const GraphCopy &other)

void	clear () override
	Removes all nodes and edges from this copy but does not break the link with the original graph. More...

GraphCopy &	operator= (const GraphCopy &other)

void	setOriginalGraph (const Graph &G)
	Re-initializes the copy using `G`, but does not create any nodes or edges. More...

void	setOriginalGraph (const Graph *G) override
	Associates the graph copy with `G`, but does not create any nodes or edges. More...

virtual void	setOriginalGraph (const Graph *G)=0
	Re-initializes the copy using `G` (which might be null), but does not create any nodes or edges. More...

Mapping between original graph and copy
const List< edge > &	chain (edge e) const
	Returns the list of edges coresponding to edge `e`. More...

edge	copy (edge e) const override
	Returns the first edge in the list of edges corresponding to edge `e`. More...

adjEntry	copy (adjEntry adj) const override
	Returns the adjacency entry in the copy graph corresponding to `adj`. More...

bool	isReversed (edge e) const
	Returns true iff edge `e` has been reversed. More...

bool	isReversedCopyEdge (edge e) const
	Returns true iff `e` is reversed w.r.t. More...

node	copy (node v) const
	Returns the node in the graph copy corresponding to `v`. More...

virtual edge	copy (edge e) const=0
	Returns the edge in the graph copy corresponding to `e`. More...

virtual adjEntry	copy (adjEntry adj) const=0
	Returns the adjacency entry in the graph copy corresponding to `adj`. More...

Creation and deletion of nodes and edges
void	delEdge (edge e) override
	Removes edge e and clears the list of edges corresponding to `e's` original edge. More...

edge	split (edge e) override
	Splits edge `e`. More...

void	unsplit (edge eIn, edge eOut) override
	Undoes a previous split operation. More...

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

void	setEdge (edge eOrig, edge eCopy)
	sets eOrig to be the corresponding original edge of eCopy and vice versa More...

void	setOriginalEmbedding () override
	Sets the embedding of the graph copy to the embedding of the original graph. More...

void	removePseudoCrossings ()
	Removes all crossing nodes which are actually only two "touching" edges. More...

bool	hasSameEdgesCrossings () const
	Returns whether there are two edges in the GraphCopy that cross each other multiple times. More...

bool	hasAdjacentEdgesCrossings () const
	Returns whether the GraphCopy contains at least one crossing of two adjacent edges. More...

bool	hasNonSimpleCrossings () const
	Returns whether the GraphCopy contains crossings that will result in a non-simple drawing. More...

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). More...

void	removeNonSimpleCrossings (DynamicDualGraph *dualGraph=nullptr)
	Removes all non-simple cossings (see hasNonSimpleCrossings() for a definition of non-simple crossings). More...

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). More...

void	insertEdgePath (edge eOrig, const SList< adjEntry > &crossedEdges)
	Re-inserts edge `eOrig` by "crossing" the edges in `crossedEdges`. More...

void	insertEdgePath (node srcOrig, node tgtOrig, const SList< adjEntry > &crossedEdges)
	Special version (for FixedEmbeddingUpwardEdgeInserter only). More...

void	removeEdgePath (edge eOrig)
	Removes the complete edge path for edge `eOrig`. More...

edge	insertCrossing (edge &crossingEdge, edge crossedEdge, bool rightToLeft)
	Inserts crossings between two copy edges. More...

edge	newEdge (node v, node w, int index=-1)
	Creates a new edge (`v`,`w`) and returns it. More...

edge	newEdge (node v, adjEntry adjTgt, int index=-1)
	Creates a new edge at predefined positions in the adjacency lists. More...

edge	newEdge (adjEntry adjSrc, node w, int index=-1)
	Creates a new edge at predefined positions in the adjacency lists. More...

edge	newEdge (adjEntry adjSrc, adjEntry adjTgt, Direction dir=Direction::after, int index=-1)
	Creates a new edge at predefined positions in the adjacency lists. More...

template<typename S , typename T >
edge	newEdge (S src, Direction dirSrc, T tgt, Direction dirTgt, int index=-1)
	Creates a new edge at predefined positions in the adjacency lists. More...

Combinatorial Embeddings
edge	newEdge (node v, adjEntry adj, edge eOrig, CombinatorialEmbedding &E)
	Creates a new edge with original edge `eOrig` in an embedding `E`. More...

void	insertEdgePathEmbedded (edge eOrig, CombinatorialEmbedding &E, const SList< adjEntry > &crossedEdges)
	Re-inserts edge `eOrig` by "crossing" the edges in `crossedEdges` in embedding `E`. More...

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

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

Miscellaneous
void	consistencyCheck () const
	Asserts that this copy is consistent. More...

Public Member Functions inherited from ogdf::GraphCopyBase
	GraphCopyBase ()=default
	Constructs a GraphCopyBase associated with no graph. More...

	GraphCopyBase (const GraphCopyBase &other)=delete

	GraphCopyBase (GraphCopyBase &&other) noexcept=delete

node	copy (node v) const
	Returns the node in the graph copy corresponding to `v`. More...

void	createEmpty (const Graph &G)
	Re-initializes the copy using `G`, but does not create any nodes or edges. More...

void	delNode (node v) override
	Removes node `v`. More...

bool	getLinkCopiesOnInsert () const

const Graph *	getOriginalGraph () const

void	init (const Graph &G)
	Re-initializes the copy using `G`, creating copies for all nodes and edges in `G`. More...

void	init (const Graph *G)
	Re-initializes the copy using `G` (which might be null), creating copies for all nodes and edges in `G`. More...

bool	isDummy (adjEntry adj) const
	Returns true iff `adj->theEdge()` has no corresponding edge in the original graph. More...

bool	isDummy (edge e) const
	Returns true iff `e` has no corresponding edge in the original graph. More...

bool	isDummy (node v) const
	Returns true iff `v` has no corresponding node in the original graph. More...

node	newNode (int index=-1)
	Creates a new node and returns it. More...

node	newNode (node vOrig)
	Creates a new node in the graph copy with original node `vOrig`. More...

GraphCopyBase &	operator= (const GraphCopyBase &other)=delete

GraphCopyBase &	operator= (GraphCopyBase &&other) noexcept=delete

const Graph &	original () const
	Returns a reference to the original graph. More...

adjEntry	original (adjEntry adj) const
	Returns the adjacency entry in the original graph corresponding to `adj`. More...

edge	original (edge e) const
	Returns the edge in the original graph corresponding to `e`. More...

node	original (node v) const
	Returns the node in the original graph corresponding to `v`. More...

void	setLinkCopiesOnInsert (bool linkCopiesOnInsert)
	Whether `insert(getOriginalGraph())` will automatically set `copy` and `original`. More...

void	setOriginalGraph (const Graph &G)
	Re-initializes the copy using `G`, but does not create any nodes or edges. More...

Public Member Functions inherited from ogdf::Graph
	Graph ()
	Constructs an empty graph. More...

	Graph (const Graph &copy)
	Constructs a graph that is a copy of `G`. More...

	Graph (Graph &&move)=delete

virtual	~Graph ()
	Destructor. More...

Graph &	operator= (const Graph &copy)
	Overwrites this graph to be a copy of `G`. More...

Graph &	operator= (Graph &&move)=delete

bool	empty () const
	Returns true iff the graph is empty, i.e., contains no nodes. More...

int	numberOfNodes () const
	Returns the number of nodes in the graph. More...

int	numberOfEdges () const
	Returns the number of edges in the graph. More...

int	maxNodeIndex () const
	Returns the largest used node index. More...

int	maxEdgeIndex () const
	Returns the largest used edge index. More...

int	maxAdjEntryIndex () const
	Returns the largest used adjEntry index. More...

node	firstNode () const
	Returns the first node in the list of all nodes. More...

node	lastNode () const
	Returns the last node in the list of all nodes. More...

edge	firstEdge () const
	Returns the first edge in the list of all edges. More...

edge	lastEdge () const
	Returns the last edge in the list of all edges. More...

node	chooseNode (std::function< bool(node)> includeNode=[](node) { return true;}, bool isFastTest=true) const
	Returns a random node. More...

edge	chooseEdge (std::function< bool(edge)> includeEdge=[](edge) { return true;}, bool isFastTest=true) const
	Returns a random edge. More...

template<class CONTAINER >
void	allNodes (CONTAINER &nodeContainer) const
	Returns a container with all nodes of the graph. More...

template<class CONTAINER >
void	allEdges (CONTAINER &edgeContainer) const
	Returns a container with all edges of the graph. More...

node	newNode (int index=-1)
	Creates a new node and returns it. More...

edge	newEdge (node v, node w, int index=-1)
	Creates a new edge (`v`,`w`) and returns it. More...

edge	newEdge (node v, adjEntry adjTgt, int index=-1)
	Creates a new edge at predefined positions in the adjacency lists. More...

edge	newEdge (adjEntry adjSrc, node w, int index=-1)
	Creates a new edge at predefined positions in the adjacency lists. More...

edge	newEdge (adjEntry adjSrc, adjEntry adjTgt, Direction dir=Direction::after, int index=-1)
	Creates a new edge at predefined positions in the adjacency lists. More...

template<typename S , typename T >
edge	newEdge (S src, Direction dirSrc, T tgt, Direction dirTgt, int index=-1)
	Creates a new edge at predefined positions in the adjacency lists. More...

void	restoreAllEdges ()
	Restore all hidden edges and invalidate all HiddenEdgeSets. More...

void	unsplit (node u)
	Undoes a split operation. More...

node	splitNode (adjEntry adjStartLeft, adjEntry adjStartRight)
	Splits a node while preserving the order of adjacency entries. More...

node	contract (edge e, bool keepSelfLoops=false)
	Contracts edge `e` while preserving the order of adjacency entries. More...

void	move (edge e, adjEntry adjSrc, Direction dirSrc, adjEntry adjTgt, Direction dirTgt)
	Moves edge `e` to a different adjacency list. More...

void	moveTarget (edge e, node w)
	Moves the target node of edge `e` to node `w`. More...

void	moveTarget (edge e, adjEntry adjTgt, Direction dir)
	Moves the target node of edge `e` to a specific position in an adjacency list. More...

void	moveSource (edge e, node w)
	Moves the source node of edge `e` to node `w`. More...

void	moveSource (edge e, adjEntry adjSrc, Direction dir)
	Moves the source node of edge `e` to a specific position in an adjacency list. More...

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` ))). More...

void	reverseEdge (edge e)
	Reverses the edge `e`, i.e., exchanges source and target node. More...

void	reverseAllEdges ()
	Reverses all edges in the graph. More...

template<class NODELIST >
void	collapse (NODELIST &nodesToCollapse)
	Collapses all nodes in the list `nodesToCollapse` to the first node in the list. More...

template<class ADJ_ENTRY_LIST >
void	sort (node v, const ADJ_ENTRY_LIST &newOrder)
	Sorts the adjacency list of node `v` according to `newOrder`. More...

template<class IT >
void	sort (node v, IT begin, IT end)
	Sorts the adjacency list of node `v` according to the range denoted by two iterators. More...

void	reverseAdjEdges (node v)
	Reverses the adjacency list of `v`. More...

void	moveAdj (adjEntry adjMove, Direction dir, adjEntry adjPos)
	Moves adjacency entry `adjMove` before or after `adjPos`. More...

void	moveAdjAfter (adjEntry adjMove, adjEntry adjAfter)
	Moves adjacency entry `adjMove` after `adjAfter`. More...

void	moveAdjBefore (adjEntry adjMove, adjEntry adjBefore)
	Moves adjacency entry `adjMove` before `adjBefore`. More...

void	reverseAdjEdges ()
	Reverses all adjacency lists. More...

void	swapAdjEdges (adjEntry adj1, adjEntry adj2)
	Exchanges two entries in an adjacency list. More...

int	genus () const
	Returns the genus of the graph's embedding. More...

bool	representsCombEmbedding () const
	Returns true iff the graph represents a combinatorial embedding. More...

void	consistencyCheck () const
	Asserts that this graph is consistent. More...

internal::GraphNodeRegistry &	nodeRegistry ()
	Returns a reference to the registry of node arrays associated with this graph. More...

const internal::GraphNodeRegistry &	nodeRegistry () const
	Returns a const reference to the registry of node arrays associated with this graph. More...

	operator const internal::GraphNodeRegistry & () const

internal::GraphEdgeRegistry &	edgeRegistry ()
	Returns a reference to the registry of edge arrays associated with this graph. More...

const internal::GraphEdgeRegistry &	edgeRegistry () const
	Returns a const reference to the registry of edge arrays associated with this graph. More...

	operator const internal::GraphEdgeRegistry & () const

internal::GraphAdjRegistry &	adjEntryRegistry ()
	Returns a reference to the registry of adjEntry arrays associated with this graph. More...

const internal::GraphAdjRegistry &	adjEntryRegistry () const
	Returns a const reference to the registry of adjEntry arrays associated with this graph. More...

	operator const internal::GraphAdjRegistry & () const

void	resetEdgeIdCount (int maxId)
	Resets the edge id count to `maxId`. More...

void	resetNodeIdCount (int maxId)

template<OGDF_NODE_ITER NI, OGDF_EDGE_ITER EI, bool copyEmbedding = true, bool copyIDs = false, bool notifyObservers = true>
std::pair< int, int >	insert (const NI &nodesBegin, const NI &nodesEnd, const EI &edgesBegin, const EI &edgesEnd, NodeArray< node > &nodeMap, EdgeArray< edge > &edgeMap)
	Inserts a copy of a given subgraph into this graph. More...

template<OGDF_NODE_ITER NI, OGDF_EDGE_FILTER EF, bool copyIDs = false, bool notifyObservers = true>
std::pair< int, int >	insert (const NI &nodesBegin, const NI &nodesEnd, const EF &edgeFilter, NodeArray< node > &nodeMap, EdgeArray< edge > &edgeMap)
	Inserts a copy of a given subgraph into this graph. More...

template<OGDF_NODE_LIST NL>
std::pair< int, int >	insert (const NL &nodeList, const EdgeSet< true > &edgeSet, NodeArray< node > &nodeMap, EdgeArray< edge > &edgeMap)
	Inserts a copy of a given subgraph into this graph. More...

template<OGDF_NODE_LIST NL>
std::pair< int, int >	insert (const NL &nodeList, const EdgeSet< false > &edgeSet, NodeArray< node > &nodeMap, EdgeArray< edge > &edgeMap)
	Inserts a copy of a given subgraph into this graph. More...

template<OGDF_NODE_LIST NL, OGDF_EDGE_LIST EL>
std::pair< int, int >	insert (const NL &nodeList, const EL &edgeList, NodeArray< node > &nodeMap, EdgeArray< edge > &edgeMap)
	Inserts a copy of a given subgraph into this graph. More...

std::pair< int, int >	insert (const CCsInfo &info, int cc, NodeArray< node > &nodeMap, EdgeArray< edge > &edgeMap)
	Inserts a copy of a given connected component `cc` into this graph. More...

std::pair< int, int >	insert (const Graph &G, NodeArray< node > &nodeMap, EdgeArray< edge > &edgeMap)
	Inserts a copy of a given Graph `G` into this graph. More...

std::pair< int, int >	insert (const Graph &G)
	Inserts a copy of a given Graph `G` into this graph. More...

Public Member Functions inherited from ogdf::Observable< GraphObserver, Graph >
	Observable ()=default

	Observable (const Observable &copy)=delete
	If you want to copy a subclass of Observable, call the default Observable() constructor. More...

	Observable (Observable &&move)=delete
	If you want to move a subclass of Observable, call the default Observable() constructor. More...

virtual	~Observable ()

Observable &	operator= (const Observable &copy)=delete

Observable &	operator= (Observable &&move)=delete

Protected Member Functions
void	edgeInserted (void *userData, edge original, edge copy) override
	Callback notifying subclasses that insert() copied an edge. More...

void	removeAdjacentEdgesCrossing (adjEntry adj1, adjEntry adj2, DynamicDualGraph *dualGraph)
	Removes the crossing of the two adjacent edges adj1->theEdge() and adj2->theEdge(). More...

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

void	removeUnnecessaryCrossing (adjEntry adj, DynamicDualGraph *dualGraph)
	Removes the pseudo crossing that adj belongs to. More...

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

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

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(). More...

Protected Member Functions inherited from ogdf::GraphCopyBase
void	nodeInserted (void *userData, node original, node copy) override
	Callback notifying subclasses that insert() copied a node. More...

void *	preInsert (bool copyEmbedding, bool copyIDs, bool notifyObservers, bool edgeFilter, NodeArray< node > &nodeMap, EdgeArray< edge > &edgeMap, int newNodes, int newEdges) override
	Callback notifying subclasses that some graph is about to be insert() -ed. More...

Protected Member Functions inherited from ogdf::Graph
virtual void	postInsert (void *userData, int newNodes, int newEdges)
	Callback notifying subclasses that an insert() call has finished. More...

Protected Member Functions inherited from ogdf::Observable< GraphObserver, Graph >
void	clearObservers ()

const ListPure< GraphObserver * > &	getObservers () const

Protected Attributes
EdgeArray< List< edge > >	m_eCopy
	The corresponding list of edges in the graph copy. More...

EdgeArray< ListIterator< edge > >	m_eIterator
	The position of copy edge in the list. More...

Protected Attributes inherited from ogdf::GraphCopyBase
EdgeArray< edge >	m_eOrig
	The corresponding edge in the original graph. More...

bool	m_linkCopiesOnInsert
	Whether `insert(getOriginalGraph())` will set `copy` and `original`. More...

const Graph *	m_pGraph = nullptr
	The original graph. More...

NodeArray< node >	m_vCopy
	The corresponding node in the graph copy. More...

NodeArray< node >	m_vOrig
	The corresponding node in the original graph. More...

Additional Inherited Members
Public Types inherited from ogdf::Graph
enum	EdgeType { EdgeType::association = 0, EdgeType::generalization = 1, EdgeType::dependency = 2 }
	The type of edges (only used in derived classes). More...

enum	NodeType { NodeType::vertex = 0, NodeType::dummy = 1, NodeType::generalizationMerger = 2, NodeType::generalizationExpander = 3, NodeType::highDegreeExpander = 4, NodeType::lowDegreeExpander = 5, NodeType::associationClass = 6 }
	The type of nodes. More...

using	node_iterator = internal::GraphIterator< node >
	Provides a bidirectional iterator to a node in a graph. More...

using	edge_iterator = internal::GraphIterator< edge >
	Provides a bidirectional iterator to an edge in a graph. More...

using	adjEntry_iterator = internal::GraphIterator< adjEntry >
	Provides a bidirectional iterator to an entry in an adjacency list. More...

Public Attributes inherited from ogdf::Graph
internal::GraphObjectContainer< NodeElement >	nodes
	The container containing all node objects. More...

internal::GraphObjectContainer< EdgeElement >	edges
	The container containing all edge objects. More...

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 391 of file GraphCopy.h.

Constructor & Destructor Documentation

◆ GraphCopy() [1/4]

ogdf::GraphCopy::GraphCopy ( )

inlineexplicit

Definition at line 397 of file GraphCopy.h.

◆ GraphCopy() [2/4]

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

inlineexplicit

Definition at line 399 of file GraphCopy.h.

◆ GraphCopy() [3/4]

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

inlineexplicit

Definition at line 401 of file GraphCopy.h.

◆ GraphCopy() [4/4]

ogdf::GraphCopy::GraphCopy ( const GraphCopy & other )

inline

Definition at line 407 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 454 of file GraphCopy.h.

◆ clear()

void ogdf::GraphCopy::clear ( )

overridevirtual

Removes all nodes and edges from this copy but does not break the link with the original graph.

Implements ogdf::GraphCopyBase.

◆ consistencyCheck()

void ogdf::GraphCopy::consistencyCheck ( ) const

Asserts that this copy is consistent.

◆ copy() [1/5]

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

inlineoverridevirtual

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 or nullptr if it does not exist.

Implements ogdf::GraphCopyBase.

Definition at line 476 of file GraphCopy.h.

◆ copy() [2/5]

virtual adjEntry ogdf::GraphCopyBase::copy

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

Has to be defined by the implemented GraphCopyBase subclass.

Parameters

adj	is an adjacency entry in the original graph.

Returns: the corresponding adjacency entry in the graph copy, or nullptr if it doesn't exist.

◆ copy() [3/5]

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

inlineoverridevirtual

Returns the first edge in the list of edges corresponding 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.

Implements ogdf::GraphCopyBase.

Definition at line 464 of file GraphCopy.h.

◆ copy() [4/5]

virtual edge ogdf::GraphCopyBase::copy

Returns the edge in the graph copy corresponding to e.

Has to be defined by the implemented GraphCopyBase subclass.

Parameters

e	is an edge in the original graph.

Returns: the corresponding edge in the graph copy, or nullptr if it doesn't exist.

◆ copy() [5/5]

node ogdf::GraphCopyBase::copy

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, or nullptr if it doesn't exist.

Definition at line 147 of file GraphCopy.h.

◆ delEdge()

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.

◆ edgeInserted()

void ogdf::GraphCopy::edgeInserted	(	void *	userData,
		edge	original,
		edge	copy
	)

overrideprotectedvirtual

Callback notifying subclasses that insert() copied an edge.

Parameters

userData	value returned from the initial preInsert() call
original	the original edge
copy	the created copy

Reimplemented from ogdf::Graph.

◆ 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 566 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.

◆ 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
	)

◆ 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 491 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

inline

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 before / after which the new edge is inserted in the adjacency list of v.
adjTgt	is the adjacency entry before / 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.
index	is the index that will be assigned to the newly created edge. If negative or not given will use the next free index `maxEdgeIndex()`. Passing an edge index that is already in use results in an inconsistent data structure. Only specify this parameter if you know what you're doing!

Returns: the newly created edge.

Definition at line 1143 of file Graph_d.h.

◆ newEdge() [2/7]

edge ogdf::Graph::newEdge

inline

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 target node of the new edge; the edge is added at the end of the adjacency list of `w`.
index	is the index that will be assigned to the newly created edge. If negative or not given will use the next free index `maxEdgeIndex()`. Passing an edge index that is already in use results in an inconsistent data structure. Only specify this parameter if you know what you're doing!

Returns: the newly created edge.

Definition at line 1121 of file Graph_d.h.

◆ 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

inline

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.
index	is the index that will be assigned to the newly created edge. If negative or not given will use the next free index `maxEdgeIndex()`. Passing an edge index that is already in use results in an inconsistent data structure. Only specify this parameter if you know what you're doing!

Returns: the newly created edge.

Definition at line 1102 of file Graph_d.h.

◆ newEdge() [6/7]

edge ogdf::Graph::newEdge

inline

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.
index	is the index that will be assigned to the newly created edge. If negative or not given will use the next free index `maxEdgeIndex()`. Passing an edge index that is already in use results in an inconsistent data structure. Only specify this parameter if you know what you're doing!

Returns: the newly created edge.

Definition at line 1083 of file Graph_d.h.

◆ newEdge() [7/7]

template<typename S , typename T >

edge ogdf::Graph::newEdge	(	typename S	,
		typename T
	)

inline

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

Let v either be the node src or the node whose adjacency list contains the adjEntry src, and w either the node tgt or the node whose adjacency list contains the adjEntry tgt. Then, the created edge is (v,w).

Parameters

src	is v or the adjacency entry before / after which the new edge is inserted in the adjacency list of v.
dirSrc	specifies if the edge is inserted before or after `adjSrc`.
tgt	is w or the adjacency entry before / after which the new edge is inserted in the adjacency list of w.
dirTgt	specifies if the edge is inserted before or after `adjTgt`.
index	is the index that will be assigned to the newly created edge. If negative or not given will use the next free index `maxEdgeIndex()`. Passing an edge index that is already in use results in an inconsistent data structure. Only specify this parameter if you know what you're doing!

Returns: the newly created edge.

Definition at line 1168 of file Graph_d.h.

◆ operator=()

GraphCopy& ogdf::GraphCopy::operator= ( const GraphCopy & other )

◆ 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 593 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 610 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 ( )

overridevirtual

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

Edges that have no copy in this graph will be left out, while dummy edges that are not present in the original graph will be moved to the end of their nodes' adjacency lists.

Implements ogdf::GraphCopyBase.

◆ setOriginalGraph() [1/3]

void ogdf::GraphCopyBase::setOriginalGraph

inline

Re-initializes the copy using G, but does not create any nodes or edges.

Definition at line 97 of file GraphCopy.h.

◆ setOriginalGraph() [2/3]

void ogdf::GraphCopy::setOriginalGraph ( const Graph * G )

overridevirtual

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.setOriginalGraph(&G);
 
// compute connected components of G
Graph::CCsInfo ccs = Graph::CCsInfo(graph);
 
// create and use graph copy for each connected component separately
NodeArray<edge> nodeCopy(G);
EdgeArray<edge> edgeCopy(G);
for (int i = 0; i < ccs.numberOfCCs(); i++) {
  nodeCopy.init();
  edgeCopy.init();
  GC.clear();
  GC.insert(ccs, i, nodeCopy, edgeCopy);
  ...
}

Parameters

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

Implements ogdf::GraphCopyBase.

Reimplemented in ogdf::EdgeWeightedGraphCopy< T >.

◆ setOriginalGraph() [3/3]

virtual void ogdf::GraphCopyBase::setOriginalGraph

Re-initializes the copy using G (which might be null), but does not create any nodes or edges.

◆ split()

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::PlanRep, ogdf::PlanRepInc, ogdf::PlanRepUML, and ogdf::ClusterPlanRep.

◆ 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 394 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 393 of file GraphCopy.h.

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

include/ogdf/basic/GraphCopy.h

OpenGraph DrawingFramework

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Do's and Dont's

Constructor & Destructor Documentation

◆ GraphCopy() [1/4]

◆ GraphCopy() [2/4]

◆ GraphCopy() [3/4]

◆ GraphCopy() [4/4]

Member Function Documentation

◆ chain()

◆ clear()

◆ consistencyCheck()

◆ copy() [1/5]

◆ copy() [2/5]

◆ copy() [3/5]

◆ copy() [4/5]

◆ copy() [5/5]

◆ delEdge()

◆ edgeInserted()

◆ hasAdjacentEdgesCrossings()

◆ hasNonSimpleCrossings()

◆ hasSameEdgesCrossings()

◆ insertCrossing()

◆ insertEdgePath() [1/2]

◆ insertEdgePath() [2/2]

◆ insertEdgePathEmbedded() [1/2]

◆ insertEdgePathEmbedded() [2/2]

◆ isReversed()

◆ isReversedCopyEdge()

◆ newEdge() [1/7]

◆ newEdge() [2/7]

◆ newEdge() [3/7]

◆ newEdge() [4/7]

◆ newEdge() [5/7]

◆ newEdge() [6/7]

◆ newEdge() [7/7]

◆ operator=()

◆ removeAdjacentEdgesCrossing()

◆ removeEdgePath()

◆ removeEdgePathEmbedded() [1/2]

◆ removeEdgePathEmbedded() [2/2]

◆ removeNonSimpleCrossings() [1/3]

◆ removeNonSimpleCrossings() [2/3]

◆ removeNonSimpleCrossings() [3/3]

◆ removePseudoCrossings()

◆ removeSameEdgesCrossing()

◆ removeUnnecessaryCrossing() [1/2]

◆ removeUnnecessaryCrossing() [2/2]

◆ setEdge()

◆ setOriginalEdgeAlongCrossings()

◆ setOriginalEmbedding()

◆ setOriginalGraph() [1/3]

◆ setOriginalGraph() [2/3]

◆ setOriginalGraph() [3/3]

◆ split()

◆ swapOriginalEdgesAtCrossing()

◆ swapOriginalEdgesBetweenCrossings()

◆ unsplit()

Member Data Documentation

◆ m_eCopy

◆ m_eIterator

Open
Graph Drawing
Framework