Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

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. More...
 
 GraphCopySimple (const Graph &G)
 Constructs a copy of graph G. More...
 
 GraphCopySimple (const GraphCopySimple &GC)
 Copy constructor. More...
 
virtual ~GraphCopySimple ()
 
adjEntry copy (adjEntry adj) const
 Returns the adjacency entry in the graph copy corresponding to adj. More...
 
edge copy (edge e) const
 Returns the edge in the graph copy corresponding to e. More...
 
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...
 
virtual void delEdge (edge e) override
 Removes edge e. More...
 
virtual void delNode (node v) override
 Removes node v. More...
 
void init (const Graph &G)
 Re-initializes the copy using G. 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...
 
edge newEdge (adjEntry adjSrc, adjEntry adjTgt, Direction dir=Direction::after)
 Creates a new edge at predefined positions in the adjacency lists. More...
 
edge newEdge (adjEntry adjSrc, node w)
 Creates a new edge at predefined positions in the adjacency lists. More...
 
edge newEdge (edge eOrig)
 Creates a new edge in the graph copy with original edge eOrig. More...
 
edge newEdge (node v, adjEntry adjTgt)
 Creates a new edge at predefined positions in the adjacency lists. More...
 
edge newEdge (node v, node w)
 Creates a new edge (v,w) and returns it. More...
 
edge newEdge (node v, node w, int index)
 Creates a new edge (v,w) with predefined index and returns it. More...
 
node newNode ()
 Creates a new node and returns it. More...
 
node newNode (int index)
 Creates a new node with predefined index and returns it. More...
 
node newNode (node vOrig)
 Creates a new node in the graph copy with original node vOrig. More...
 
GraphCopySimpleoperator= (const GraphCopySimple &GC)
 Assignment operator. More...
 
const Graphoriginal () 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...
 
- Public Member Functions inherited from ogdf::Graph
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...
 
int nodeArrayTableSize () const
 Returns the table size of node arrays associated with this graph. More...
 
int edgeArrayTableSize () const
 Returns the table size of edge arrays associated with this graph. More...
 
int adjEntryArrayTableSize () const
 Returns the table size of adjEntry arrays associated with this graph. 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 ()
 Creates a new node and returns it. More...
 
node newNode (int index)
 Creates a new node with predefined index and returns it. More...
 
edge newEdge (node v, node w)
 Creates a new edge (v,w) and returns it. More...
 
edge newEdge (node v, node w, int index)
 Creates a new edge (v,w) with predefined index and returns it. More...
 
edge newEdge (adjEntry adjSrc, adjEntry adjTgt, Direction dir=Direction::after)
 Creates a new edge at predefined positions in the adjacency lists. More...
 
edge newEdge (node v, adjEntry adjTgt)
 Creates a new edge at predefined positions in the adjacency lists. More...
 
edge newEdge (adjEntry adjSrc, node w)
 Creates a new edge at predefined positions in the adjacency lists. More...
 
virtual void clear ()
 Removes all nodes and all edges from the graph. More...
 
void insert (const Graph &G, NodeArray< node > &nodeMap)
 Inserts Graph G as a subgraph into this Graph. More...
 
void insert (const Graph &G)
 Inserts Graph G as a subgraph into this Graph. More...
 
virtual edge split (edge e)
 Splits edge e into two edges introducing a new node. More...
 
void unsplit (node u)
 Undoes a split operation. More...
 
virtual void unsplit (edge eIn, edge eOut)
 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...
 
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...
 
ListIterator< NodeArrayBase * > registerArray (NodeArrayBase *pNodeArray) const
 Registers a node array. More...
 
ListIterator< EdgeArrayBase * > registerArray (EdgeArrayBase *pEdgeArray) const
 Registers an edge array. More...
 
ListIterator< AdjEntryArrayBase * > registerArray (AdjEntryArrayBase *pAdjArray) const
 Registers an adjEntry array. More...
 
ListIterator< GraphObserver * > registerStructure (GraphObserver *pStructure) const
 Registers a graph observer (e.g. a ClusterGraph). More...
 
void unregisterArray (ListIterator< NodeArrayBase * > it) const
 Unregisters a node array. More...
 
void unregisterArray (ListIterator< EdgeArrayBase * > it) const
 Unregisters an edge array. More...
 
void unregisterArray (ListIterator< AdjEntryArrayBase * > it) const
 Unregisters an adjEntry array. More...
 
void unregisterStructure (ListIterator< GraphObserver * > it) const
 Unregisters a graph observer. More...
 
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). More...
 
void resetEdgeIdCount (int maxId)
 Resets the edge id count to maxId. More...
 
 Graph ()
 Constructs an empty graph. More...
 
 Graph (const Graph &G)
 Constructs a graph that is a copy of G. More...
 
virtual ~Graph ()
 Destructor. More...
 
Graphoperator= (const Graph &G)
 Assignment operator. More...
 

Private Member Functions

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

Private Attributes

EdgeArray< edgem_eCopy
 The corresponding edge in the graph copy. More...
 
EdgeArray< edgem_eOrig
 The corresponding edge in the original graph. More...
 
const Graphm_pGraph
 The original graph. More...
 
NodeArray< nodem_vCopy
 The corresponding node in the graph copy. More...
 
NodeArray< nodem_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< NodeElementnodes
 The container containing all node objects. More...
 
internal::GraphObjectContainer< EdgeElementedges
 The container containing all edge objects. More...
 
- Protected Member Functions inherited from ogdf::Graph
void construct (const Graph &G, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
 
void assign (const Graph &G, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
 
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. More...
 
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. More...
 

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 60 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 78 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
adjis 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 147 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
eis an edge in the original graph.
Returns
the corresponding edge in the graph copy, or nullptr if it doesn't exists.

Definition at line 134 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
vis a node in the original graph.
Returns
the corresponding node in the graph copy, or nullptr if it doesn't exists.

Definition at line 126 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
eis an edge in the graph copy.

Reimplemented from ogdf::Graph.

◆ delNode()

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

Removes node v.

Parameters
vis 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
eis 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
vis a node in the graph copy.

Definition at line 157 of file GraphCopy.h.

◆ newEdge() [1/6]

edge ogdf::Graph::newEdge

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
adjSrcis the adjacency entry after which the new edge is inserted in the adjacency list of v.
adjTgtis the adjacency entry after which the new edge is inserted in the adjacency list of w.
dirspecifies if the edge is inserted before or after the given adjacency entries.
Returns
the newly created edge.

◆ newEdge() [2/6]

edge ogdf::Graph::newEdge

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
adjSrcis the adjacency entry after which the new edge is inserted in the adjacency list of v.
wis 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

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
vis the source node of the new edge; the edge is added at the end of the adjacency list of v.
adjTgtis 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

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

Parameters
vis the source node of the newly created edge.
wis the target node of the newly created edge.
Returns
the newly created edge.

◆ newEdge() [6/6]

edge ogdf::Graph::newEdge

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
vis the source node of the newly created edge.
wis the target node of the newly created edge.
indexis 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

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
indexis 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 87 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
adjis an adjacency entry in the copy graph.
Returns
the corresponding adjacency entry in the original graph.

Definition at line 115 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
eis an edge in the graph copy.
Returns
the corresponding edge in the original graph, or 0 if no such edge exists.

Definition at line 103 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
vis a node in the graph copy.
Returns
the corresponding node in the original graph, or 0 if no such node exists.

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

◆ m_eOrig

EdgeArray<edge> ogdf::GraphCopySimple::m_eOrig
private

The corresponding edge in the original graph.

Definition at line 65 of file GraphCopy.h.

◆ m_pGraph

const Graph* ogdf::GraphCopySimple::m_pGraph
private

The original graph.

Definition at line 62 of file GraphCopy.h.

◆ m_vCopy

NodeArray<node> ogdf::GraphCopySimple::m_vCopy
private

The corresponding node in the graph copy.

Definition at line 64 of file GraphCopy.h.

◆ m_vOrig

NodeArray<node> ogdf::GraphCopySimple::m_vOrig
private

The corresponding node in the original graph.

Definition at line 63 of file GraphCopy.h.


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