ogdf::GraphCopySimple Class Reference

Copies of graphs with mapping between nodes and edges. More...

#include <ogdf/basic/GraphCopy.h>

Inheritance diagram for ogdf::GraphCopySimple:

Public Member Functions
	GraphCopySimple ()
	Constructs a GraphCopySimple associated with no graph.
	GraphCopySimple (const Graph &G)
	Constructs a copy of graph G.
	GraphCopySimple (const GraphCopySimple &GC)
	Copy constructor.
virtual	~GraphCopySimple ()
adjEntry	copy (adjEntry adj) const
	Returns the adjacency entry in the graph copy corresponding to adj.
edge	copy (edge e) const
	Returns the edge in the graph copy corresponding to e.
node	copy (node v) const
	Returns the node in the graph copy corresponding to v.
void	createEmpty (const Graph &G)
	Re-initializes the copy using G, but does not create any nodes or edges.
virtual void	delEdge (edge e) override
	Removes edge e.
virtual void	delNode (node v) override
	Removes node v.
void	init (const Graph &G)
	Re-initializes the copy using G.
bool	isDummy (edge e) const
	Returns true iff e has no corresponding edge in the original graph.
bool	isDummy (node v) const
	Returns true iff v has no corresponding node in the original graph.
edge	newEdge (adjEntry adjSrc, adjEntry adjTgt, Direction dir=Direction::after)
	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.
edge	newEdge (edge eOrig)
	Creates a new edge in the graph copy with original edge eOrig.
edge	newEdge (node v, adjEntry adjTgt)
	Creates a new edge at predefined positions in the adjacency lists.
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.
node	newNode ()
	Creates a new node and returns it.
node	newNode (int index)
	Creates a new node with predefined index and returns it.
node	newNode (node vOrig)
	Creates a new node in the graph copy with original node vOrig.
GraphCopySimple &	operator= (const GraphCopySimple &GC)
	Assignment operator.
const Graph &	original () const
	Returns a reference to the original graph.
adjEntry	original (adjEntry adj) const
	Returns the adjacency entry in the original graph corresponding to adj.
edge	original (edge e) const
	Returns the edge in the original graph corresponding to e.
node	original (node v) const
	Returns the node in the original graph corresponding to v.
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.
virtual void	clear ()
	Removes all nodes and all edges from the graph.
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.
virtual edge	split (edge e)
	Splits edge e into two edges introducing a new node.
void	unsplit (node u)
	Undoes a split operation.
virtual void	unsplit (edge eIn, edge eOut)
	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.

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

Private Attributes
EdgeArray< edge >	m_eCopy
	The corresponding edge in the graph copy.
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.

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

Detailed Description

Copies of graphs with mapping between nodes and edges.

The class GraphCopySimple 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. This class does not support splitting of edges in such a way that both edges resulting from the split are mapped to the same original edge; this feature is provided by GraphCopy.

Definition at line 59 of file GraphCopy.h.

Constructor & Destructor Documentation

GraphCopySimple() [1/3]

ogdf::GraphCopySimple::GraphCopySimple

(

)

Constructs a GraphCopySimple associated with no graph.

GraphCopySimple() [2/3]

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

explicit

Constructs a copy of graph G.

GraphCopySimple() [3/3]

ogdf::GraphCopySimple::GraphCopySimple

(

const GraphCopySimple &

GC

)

Copy constructor.

~GraphCopySimple()

virtual ogdf::GraphCopySimple::~GraphCopySimple ( )

inlinevirtual

Definition at line 76 of file GraphCopy.h.

Member Function Documentation

copy() [1/3]

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

inline

Returns the adjacency entry in the graph copy 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 copy edge is returned.

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

Definition at line 145 of file GraphCopy.h.

copy() [2/3]

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

inline

Returns the edge in the graph copy corresponding to e.

Parameters

e	is an edge in the original graph.

Returns

the corresponding edge in the graph copy, or nullptr if it doesn't exists.

Definition at line 132 of file GraphCopy.h.

copy() [3/3]

node ogdf::GraphCopySimple::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, or nullptr if it doesn't exists.

Definition at line 124 of file GraphCopy.h.

createEmpty()

void ogdf::GraphCopySimple::createEmpty

(

const Graph &

G

)

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

delEdge()

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

overridevirtual

Removes edge e.

Parameters

e	is an edge in the graph copy.

Reimplemented from ogdf::Graph.

delNode()

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

overridevirtual

Removes node v.

Parameters

v	is a node in the graph copy.

Reimplemented from ogdf::Graph.

init()

void ogdf::GraphCopySimple::init

(

const Graph &

G

)

Re-initializes the copy using G.

initGC()

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

private

isDummy() [1/2]

bool ogdf::GraphCopySimple::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 163 of file GraphCopy.h.

isDummy() [2/2]

bool ogdf::GraphCopySimple::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 157 of file GraphCopy.h.

newEdge() [1/6]

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/6]

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/6]

edge ogdf::GraphCopySimple::newEdge ( edge  eOrig )

inline

Creates a new edge in the graph copy with original edge eOrig.

Warning

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

Definition at line 188 of file GraphCopy.h.

newEdge() [4/6]

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() [5/6]

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() [6/6]

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::GraphCopySimple::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 173 of file GraphCopy.h.

operator=()

GraphCopySimple & ogdf::GraphCopySimple::operator=

(

const GraphCopySimple &

GC

)

Assignment operator.

original() [1/4]

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

inline

Returns a reference to the original graph.

Definition at line 85 of file GraphCopy.h.

original() [2/4]

adjEntry ogdf::GraphCopySimple::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.

Parameters

adj	is an adjacency entry in the copy graph.

Returns

the corresponding adjacency entry in the original graph.

Definition at line 113 of file GraphCopy.h.

original() [3/4]

edge ogdf::GraphCopySimple::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 101 of file GraphCopy.h.

original() [4/4]

node ogdf::GraphCopySimple::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 93 of file GraphCopy.h.

Member Data Documentation

m_eCopy

EdgeArray<edge> ogdf::GraphCopySimple::m_eCopy

private

The corresponding edge in the graph copy.

Definition at line 64 of file GraphCopy.h.

m_eOrig

EdgeArray<edge> ogdf::GraphCopySimple::m_eOrig

private

The corresponding edge in the original graph.

Definition at line 63 of file GraphCopy.h.

m_pGraph

const Graph* ogdf::GraphCopySimple::m_pGraph

private

The original graph.

Definition at line 60 of file GraphCopy.h.

m_vCopy

NodeArray<node> ogdf::GraphCopySimple::m_vCopy

private

The corresponding node in the graph copy.

Definition at line 62 of file GraphCopy.h.

m_vOrig

NodeArray<node> ogdf::GraphCopySimple::m_vOrig

private

The corresponding node in the original graph.

Definition at line 61 of file GraphCopy.h.

---

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

• include/ogdf/basic/GraphCopy.h