Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::Graph Class Reference

Data type for general directed graphs (adjacency list representation). More...

#include <ogdf/basic/Graph_d.h>

+ Inheritance diagram for ogdf::Graph:

Classes

class  CCsInfo
 Info structure for maintaining connected components. More...
 
class  HiddenEdgeSet
 Functionality for temporarily hiding edges in constant time. More...
 

Public Types

Enumerations

These enumerations are mainly meant for advanced or internal usage scenarios.

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

These types are used for graph object iterators, which are returned by graph object containers like nodes and edges.

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 Member Functions

Access methods
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...
 
Creation of new nodes and edges
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...
 
Removing nodes and edges
virtual void delNode (node v)
 Removes node v and all incident edges from the graph. More...
 
virtual void delEdge (edge e)
 Removes edge e from the graph. More...
 
virtual void clear ()
 Removes all nodes and all edges from the graph. More...
 
Advanced modification methods
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...
 
Miscellaneous
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...
 
Registering arrays and observers

These methods are used by various graph array types like NodeArray or EdgeArray.

There should be no need to use them directly in user code.

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

Private Attributes

int m_edgeArrayTableSize
 The current table size of edge arrays associated with this graph. More...
 
int m_edgeIdCount
 The Index that will be assigned to the next created edge. More...
 
List< HiddenEdgeSet * > m_hiddenEdgeSets
 The list of hidden edges. More...
 
std::mutex m_mutexRegArrays
 The critical section for protecting shared acces to register/unregister methods. More...
 
int m_nodeArrayTableSize
 The current table size of node arrays associated with this graph. More...
 
int m_nodeIdCount
 The Index that will be assigned to the next created node. More...
 
ListPure< AdjEntryArrayBase * > m_regAdjArrays
 The registered adjEntry arrays. More...
 
ListPure< EdgeArrayBase * > m_regEdgeArrays
 The registered edge arrays. More...
 
ListPure< NodeArrayBase * > m_regNodeArrays
 The registered node arrays. More...
 
ListPure< GraphObserver * > m_regStructures
 The registered graph structures. More...
 

Graph object containers

These containers maintain the nodes and edges of the graph, and provide node and edge iterators.

internal::GraphObjectContainer< NodeElementnodes
 The container containing all node objects. More...
 
internal::GraphObjectContainer< EdgeElementedges
 The container containing all edge objects. 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...
 

Operators

Graphoperator= (const Graph &G)
 Assignment operator. More...
 
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...
 
void copy (const Graph &G, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
 
void copy (const Graph &G)
 
edge createEdgeElement (node v, node w, adjEntry adjSrc, adjEntry adjTgt)
 
node pureNewNode ()
 
void moveAdj (adjEntry adj, node w)
 
void resetTableSizes ()
 Sets the sizes of registered node and edge arrays to the next power of two that is no less than the current id counts. Respects the minimum table size constants. More...
 
void reinitArrays (bool doResetTableSizes=true)
 Re-initializes registed arrays with respect to the current sizes. Calls resetTableSizes() if doResetTableSizes is true (default). More...
 
void reinitStructures ()
 
void resetAdjEntryIndex (int newIndex, int oldIndex)
 
void restoreAllEdges ()
 Used to restore all hidden edges upon deleting the graph. More...
 

Detailed Description

Data type for general directed graphs (adjacency list representation).

Thread Safety

The class Graph allows shared access of threads to const methods only. If one thread executes a non-const method, shared access is no longer thread-safe.

Iteration

You may iterate over the nodes and edges of a graph using C++11 range-based for loops. Find some examples below.

  • Iterate over all nodes v of graph G using c++11 syntax :

    for(node v : G.nodes) {
    // do stuff with node v
    }

  • Iterate over all nodes v of graph G :

    for(node v = G.firstNode(); v != nullptr; v = v->succ()) {
    // do stuff with node v
    }

  • Iterate over all edges e of graph G using c++11 syntax :

    for(edge e : G.edges) {
    // do stuff with node v
    }

  • Iterate over all incident edges of node v using c++11 syntax:
    for(adjEntry adj : v->adjEntries) {
    edge e = adj->theEdge();
    // do stuff with edge e
    }

Definition at line 495 of file Graph_d.h.

Member Typedef Documentation

◆ adjEntry_iterator

Provides a bidirectional iterator to an entry in an adjacency list.

Definition at line 531 of file Graph_d.h.

◆ edge_iterator

Provides a bidirectional iterator to an edge in a graph.

Definition at line 529 of file Graph_d.h.

◆ node_iterator

Provides a bidirectional iterator to a node in a graph.

Definition at line 527 of file Graph_d.h.

Member Enumeration Documentation

◆ EdgeType

enum ogdf::Graph::EdgeType
strong

The type of edges (only used in derived classes).

Enumerator
association 
generalization 
dependency 

Definition at line 541 of file Graph_d.h.

◆ NodeType

enum ogdf::Graph::NodeType
strong

The type of nodes.

Enumerator
vertex 
dummy 
generalizationMerger 
generalizationExpander 
highDegreeExpander 
lowDegreeExpander 
associationClass 

Definition at line 548 of file Graph_d.h.

Constructor & Destructor Documentation

◆ Graph() [1/2]

ogdf::Graph::Graph ( )

Constructs an empty graph.

◆ Graph() [2/2]

ogdf::Graph::Graph ( const Graph G)

Constructs a graph that is a copy of G.

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.

Parameters
Gis the graph that will be copied.

◆ ~Graph()

virtual ogdf::Graph::~Graph ( )
virtual

Destructor.

Member Function Documentation

◆ adjEntryArrayTableSize()

int ogdf::Graph::adjEntryArrayTableSize ( ) const
inline

Returns the table size of adjEntry arrays associated with this graph.

Definition at line 618 of file Graph_d.h.

◆ allEdges()

template<class CONTAINER >
void ogdf::Graph::allEdges ( CONTAINER &  edgeContainer) const
inline

Returns a container with all edges of the graph.

Template Parameters
CONTAINERis the type of the edge container which is returned.
Parameters
edgeContaineris assigned the list of all edges.

Definition at line 664 of file Graph_d.h.

◆ allNodes()

template<class CONTAINER >
void ogdf::Graph::allNodes ( CONTAINER &  nodeContainer) const
inline

Returns a container with all nodes of the graph.

Template Parameters
CONTAINERis the type of node container which is returned.
Parameters
nodeContaineris assigned the container of all nodes.

Definition at line 654 of file Graph_d.h.

◆ assign()

void ogdf::Graph::assign ( const Graph G,
NodeArray< node > &  mapNode,
EdgeArray< edge > &  mapEdge 
)
protected

◆ chooseEdge()

edge ogdf::Graph::chooseEdge ( std::function< bool(edge)>  includeEdge = [](edge) { return true;},
bool  isFastTest = true 
) const

Returns a random edge.

nullptr is returned if no feasible edge exists.

See also
chooseIteratorFrom

◆ chooseNode()

node ogdf::Graph::chooseNode ( std::function< bool(node)>  includeNode = [](node) { return true;},
bool  isFastTest = true 
) const

Returns a random node.

nullptr is returned if no feasible node exists.

See also
chooseIteratorFrom

◆ clear()

virtual void ogdf::Graph::clear ( )
virtual

Removes all nodes and all edges from the graph.

Reimplemented in ogdf::GraphCopy.

◆ collapse()

template<class NODELIST >
void ogdf::Graph::collapse ( NODELIST &  nodesToCollapse)
inline

Collapses all nodes in the list nodesToCollapse to the first node in the list.

Parallel edges are removed.

Template Parameters
NODELISTis the type of input node list.
Parameters
nodesToCollapseis the list of nodes that will be collapsed. This list will be empty after the call.

Definition at line 1030 of file Graph_d.h.

◆ construct()

void ogdf::Graph::construct ( const Graph G,
NodeArray< node > &  mapNode,
EdgeArray< edge > &  mapEdge 
)
protected

◆ constructInitByActiveNodes()

void ogdf::Graph::constructInitByActiveNodes ( const List< node > &  nodeList,
const NodeArray< bool > &  activeNodes,
NodeArray< node > &  mapNode,
EdgeArray< edge > &  mapEdge 
)
protected

◆ constructInitByCC()

void ogdf::Graph::constructInitByCC ( const CCsInfo info,
int  cc,
NodeArray< node > &  mapNode,
EdgeArray< edge > &  mapEdge 
)
protected

Constructs a copy of connected component cc in info.

◆ constructInitByNodes()

void ogdf::Graph::constructInitByNodes ( const Graph G,
const List< node > &  nodeList,
NodeArray< node > &  mapNode,
EdgeArray< edge > &  mapEdge 
)
protected

Constructs a copy of the subgraph of G induced by nodeList.

This method preserves the order in the adjacency lists, i.e., if G is embedded, its embedding induces the embedding of the copy.

◆ contract()

node ogdf::Graph::contract ( edge  e,
bool  keepSelfLoops = false 
)

Contracts edge e while preserving the order of adjacency entries.

Parameters
eis the edge to be contracted.
keepSelfLoopsdetermines whether edges parallel to e will result in self-loops or not (in the latter case, they will also be contracted).
Returns
The endpoint of e to which all edges have been moved. The implementation ensures this to be the source of the former edge e.

◆ copy() [1/2]

void ogdf::Graph::copy ( const Graph G)
private

◆ copy() [2/2]

void ogdf::Graph::copy ( const Graph G,
NodeArray< node > &  mapNode,
EdgeArray< edge > &  mapEdge 
)
private

◆ createEdgeElement()

edge ogdf::Graph::createEdgeElement ( node  v,
node  w,
adjEntry  adjSrc,
adjEntry  adjTgt 
)
private

◆ delEdge()

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

Removes edge e from the graph.

Reimplemented in ogdf::GraphCopy, ogdf::PlanRepExpansion, and ogdf::GraphCopySimple.

◆ delNode()

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

Removes node v and all incident edges from the graph.

Reimplemented in ogdf::GraphCopy, and ogdf::GraphCopySimple.

◆ edgeArrayTableSize()

int ogdf::Graph::edgeArrayTableSize ( ) const
inline

Returns the table size of edge arrays associated with this graph.

Definition at line 616 of file Graph_d.h.

◆ empty()

bool ogdf::Graph::empty ( ) const
inline

Returns true iff the graph is empty, i.e., contains no nodes.

Definition at line 598 of file Graph_d.h.

◆ firstEdge()

edge ogdf::Graph::firstEdge ( ) const
inline

Returns the first edge in the list of all edges.

Definition at line 626 of file Graph_d.h.

◆ firstNode()

node ogdf::Graph::firstNode ( ) const
inline

Returns the first node in the list of all nodes.

Definition at line 621 of file Graph_d.h.

◆ genus()

int ogdf::Graph::genus ( ) const

Returns the genus of the graph's embedding.

The genus of a graph is defined as follows. Let G be a graph with m edges, n nodes, nz isolated vertices, fc face cycles, and c connected components. Then,

\[ genus(G) = (m - n - nz - fc + 2c)/2 \]

Returns
the genus of the graph's current embedding; if this is 0, then the graph is planarly embedded.

◆ insert() [1/2]

void ogdf::Graph::insert ( const Graph G)

Inserts Graph G as a subgraph into this Graph.

Parameters
Gis the Graph to be inserted into this Graph.

◆ insert() [2/2]

void ogdf::Graph::insert ( const Graph G,
NodeArray< node > &  nodeMap 
)

Inserts Graph G as a subgraph into this Graph.

Parameters
Gis the Graph to be inserted into this Graph.
nodeMapis assigned a mapping from nodes in G to nodes in this Graph.

◆ lastEdge()

edge ogdf::Graph::lastEdge ( ) const
inline

Returns the last edge in the list of all edges.

Definition at line 628 of file Graph_d.h.

◆ lastNode()

node ogdf::Graph::lastNode ( ) const
inline

Returns the last node in the list of all nodes.

Definition at line 623 of file Graph_d.h.

◆ maxAdjEntryIndex()

int ogdf::Graph::maxAdjEntryIndex ( ) const
inline

Returns the largest used adjEntry index.

Definition at line 611 of file Graph_d.h.

◆ maxEdgeIndex()

int ogdf::Graph::maxEdgeIndex ( ) const
inline

Returns the largest used edge index.

Definition at line 609 of file Graph_d.h.

◆ maxNodeIndex()

int ogdf::Graph::maxNodeIndex ( ) const
inline

Returns the largest used node index.

Definition at line 607 of file Graph_d.h.

◆ move()

void ogdf::Graph::move ( edge  e,
adjEntry  adjSrc,
Direction  dirSrc,
adjEntry  adjTgt,
Direction  dirTgt 
)

Moves edge e to a different adjacency list.

The source adjacency entry of e is moved to the adjacency list containing adjSrc and is inserted before or after adjSrc, and its target adjacency entry to the adjacency list containing adjTgt and is inserted before or after adjTgt; e is afterwards an edge from owner(adjSrc) to owner(adjTgt).

Parameters
eis the edge to be moved.
adjSrcis the adjaceny entry before or after which the source adjacency entry of e will be inserted.
dirSrcspecifies if the source adjacency entry of e will be inserted before or after adjSrc.
adjTgtis the adjaceny entry before or after which the target adjacency entry of e will be inserted.
dirTgtspecifies if the target adjacency entry of e will be inserted before or after adjTgt.

◆ moveAdj() [1/2]

void ogdf::Graph::moveAdj ( adjEntry  adj,
node  w 
)
private

◆ moveAdj() [2/2]

void ogdf::Graph::moveAdj ( adjEntry  adjMove,
Direction  dir,
adjEntry  adjPos 
)
inline

Moves adjacency entry adjMove before or after adjPos.

Precondition
adjMove and adjAfter are distinct entries in the same adjacency list.
Parameters
adjMoveis an entry in the adjacency list of a node in this graph.
adjPosis an entry in the same adjacency list as adjMove.
dirspecifies if adjMove is moved before or after adjPos.

Definition at line 1094 of file Graph_d.h.

◆ moveAdjAfter()

void ogdf::Graph::moveAdjAfter ( adjEntry  adjMove,
adjEntry  adjAfter 
)
inline

Moves adjacency entry adjMove after adjAfter.

Precondition
adjMove and adjAfter are distinct entries in the same adjacency list.
Parameters
adjMoveis an entry in the adjacency list of a node in this graph.
adjAfteris an entry in the same adjacency list as adjMove.

Definition at line 1110 of file Graph_d.h.

◆ moveAdjBefore()

void ogdf::Graph::moveAdjBefore ( adjEntry  adjMove,
adjEntry  adjBefore 
)
inline

Moves adjacency entry adjMove before adjBefore.

Precondition
adjMove and adjBefore are distinct entries in the same adjacency list.
Parameters
adjMoveis an entry in the adjacency list of a node in this graph.
adjBeforeis an entry in the same adjacency list as adjMove.

Definition at line 1125 of file Graph_d.h.

◆ moveRegisterArray()

template<class ArrayBase >
void ogdf::Graph::moveRegisterArray ( ListIterator< ArrayBase * >  it,
ArrayBase *  pArray 
) const
inline

Move the registration it of an graph element array to pArray (used with move semantics for graph element arrays).

Definition at line 1261 of file Graph_d.h.

◆ moveSource() [1/2]

void ogdf::Graph::moveSource ( edge  e,
adjEntry  adjSrc,
Direction  dir 
)

Moves the source node of edge e to a specific position in an adjacency list.

Let w be the node containing adjSrc. If e=(v,u) before, then e=(w,u) afterwards. Inserts the adjacency entry before or after adjSrc according to dir.

Parameters
eis the edge whose source node is moved.
adjSrcis the adjacency entry before or after which the source adjacency entry of e is inserted.
dirspecifies if the source adjacency entry of e is inserted before or after adjSrc.

◆ moveSource() [2/2]

void ogdf::Graph::moveSource ( edge  e,
node  w 
)

Moves the source node of edge e to node w.

If e=(v,u) before, then e=(w,u) afterwards.

Parameters
eis the edge whose source node is moved.
wis the new source node of e.

◆ moveTarget() [1/2]

void ogdf::Graph::moveTarget ( edge  e,
adjEntry  adjTgt,
Direction  dir 
)

Moves the target node of edge e to a specific position in an adjacency list.

Let w be the node containing adjTgt. If e=(v,u) before, then e=(v,w) afterwards. Inserts the adjacency entry before or after adjTgt according to dir.

Parameters
eis the edge whose target node is moved.
adjTgtis the adjacency entry before or after which the target adjacency entry of e is inserted.
dirspecifies if the target adjacency entry of e is inserted before or after adjTgt.

◆ moveTarget() [2/2]

void ogdf::Graph::moveTarget ( edge  e,
node  w 
)

Moves the target node of edge e to node w.

If e=(v,u) before, then e=(v,w) afterwards.

Parameters
eis the edge whose target node is moved.
wis the new target node of e.

◆ newEdge() [1/5]

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

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

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

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

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

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

node ogdf::Graph::newNode ( )

Creates a new node and returns it.

◆ newNode() [2/2]

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
indexis the index that will be assigned to the newly created node.
Returns
the newly created node.

◆ nodeArrayTableSize()

int ogdf::Graph::nodeArrayTableSize ( ) const
inline

Returns the table size of node arrays associated with this graph.

Definition at line 614 of file Graph_d.h.

◆ numberOfEdges()

int ogdf::Graph::numberOfEdges ( ) const
inline

Returns the number of edges in the graph.

Definition at line 604 of file Graph_d.h.

◆ numberOfNodes()

int ogdf::Graph::numberOfNodes ( ) const
inline

Returns the number of nodes in the graph.

Definition at line 601 of file Graph_d.h.

◆ operator=()

Graph& ogdf::Graph::operator= ( const Graph G)

Assignment operator.

The assignment operature 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.

Parameters
Gis the graph to be copied.
Returns
this graph.

◆ pureNewNode()

node ogdf::Graph::pureNewNode ( )
private

◆ registerArray() [1/3]

ListIterator<AdjEntryArrayBase*> ogdf::Graph::registerArray ( AdjEntryArrayBase pAdjArray) const

Registers an adjEntry array.

Remarks
This method is automatically called by adjacency entry arrays; it should not be called manually.
Parameters
pAdjArrayis a pointer to the adjacency entry array's base; this adjacency entry array must be associated with this graph.
Returns
an iterator pointing to the entry for the registered adjacency entry array in the list of registered adjacency entry arrays. This iterator is required for unregistering the adjacency entry array again.

◆ registerArray() [2/3]

ListIterator<EdgeArrayBase*> ogdf::Graph::registerArray ( EdgeArrayBase pEdgeArray) const

Registers an edge array.

Remarks
This method is automatically called by edge arrays; it should not be called manually.
Parameters
pEdgeArrayis a pointer to the edge array's base; this edge array must be associated with this graph.
Returns
an iterator pointing to the entry for the registered edge array in the list of registered edge arrays. This iterator is required for unregistering the edge array again.

◆ registerArray() [3/3]

ListIterator<NodeArrayBase*> ogdf::Graph::registerArray ( NodeArrayBase pNodeArray) const

Registers a node array.

Remarks
This method is automatically called by node arrays; it should not be called manually.
Parameters
pNodeArrayis a pointer to the node array's base; this node array must be associated with this graph.
Returns
an iterator pointing to the entry for the registered node array in the list of registered node arrays. This iterator is required for unregistering the node array again.

◆ registerStructure()

ListIterator<GraphObserver*> ogdf::Graph::registerStructure ( GraphObserver pStructure) const

Registers a graph observer (e.g. a ClusterGraph).

Parameters
pStructureis a pointer to the graph observer that shall be registered; this graph observer must be associated with this graph.
Returns
an iterator pointing to the entry for the registered graph observer in the list of registered graph observers. This iterator is required for unregistering the graph observer again.

◆ reinitArrays()

void ogdf::Graph::reinitArrays ( bool  doResetTableSizes = true)
private

Re-initializes registed arrays with respect to the current sizes. Calls resetTableSizes() if doResetTableSizes is true (default).

◆ reinitStructures()

void ogdf::Graph::reinitStructures ( )
private

◆ representsCombEmbedding()

bool ogdf::Graph::representsCombEmbedding ( ) const
inline

Returns true iff the graph represents a combinatorial embedding.

Returns
true if the current embedding (given by the adjacency lists) represents a combinatorial embedding, false otherwise.

Definition at line 1174 of file Graph_d.h.

◆ resetAdjEntryIndex()

void ogdf::Graph::resetAdjEntryIndex ( int  newIndex,
int  oldIndex 
)
private

◆ resetEdgeIdCount()

void ogdf::Graph::resetEdgeIdCount ( int  maxId)

Resets the edge id count to maxId.

The next edge will get edge id maxId +1. Use this function with caution! It is provided as an efficient way to reduce the edge id count. The Graph class increments the edge id count whenever an edge is created; free edge ids resulting from removing edges are not reused (there is not something like a freelist).

This function is , e.g., useful, when a lot of edges has been added and all these edges are removed again (without creating other new edges meanwile). Then, it is safe to reduce the edge id count to the value it had before, cf. the following code snippet:

int oldIdCount = G.maxEdgeIndex();
Create some edges
...
Remove all these edges again
G.resetEdgeIdCount(oldIdCount);

Reducing the edge id count will reduce the memory consumption of edge arrays associated with the graph.

Precondition
-1 <= maxId <= maximal edge id in the graph.
Parameters
maxIdis an upper bound of the edge ids in the graph.

◆ resetTableSizes()

void ogdf::Graph::resetTableSizes ( )
private

Sets the sizes of registered node and edge arrays to the next power of two that is no less than the current id counts. Respects the minimum table size constants.

◆ restoreAllEdges()

void ogdf::Graph::restoreAllEdges ( )
private

Used to restore all hidden edges upon deleting the graph.

◆ reverseAdjEdges() [1/2]

void ogdf::Graph::reverseAdjEdges ( )

Reverses all adjacency lists.

◆ reverseAdjEdges() [2/2]

void ogdf::Graph::reverseAdjEdges ( node  v)
inline

Reverses the adjacency list of v.

Parameters
vis the node whose adjacency list will be reveresed.

Definition at line 1082 of file Graph_d.h.

◆ reverseAllEdges()

void ogdf::Graph::reverseAllEdges ( )

Reverses all edges in the graph.

◆ reverseEdge()

void ogdf::Graph::reverseEdge ( edge  e)

Reverses the edge e, i.e., exchanges source and target node.

◆ searchEdge()

edge ogdf::Graph::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 ))).

Parameters
vis the first endpoint of the edge to be searched.
wis the second endpoint of the edge to be searched.
directediff set to true, enforces that v must be the source node and w the target node of the edge.
Returns
an edge (v,w) (or (w,v) for !directed) if such an edge exists, nullptr otherwise.

◆ sort()

template<class ADJ_ENTRY_LIST >
void ogdf::Graph::sort ( node  v,
const ADJ_ENTRY_LIST &  newOrder 
)
inline

Sorts the adjacency list of node v according to newOrder.

Precondition
newOrder contains exactly the adjacency entries of v!
Template Parameters
ADJ_ENTRY_LISTis the type of the input adjacency entry list.
Parameters
vis the node whose adjacency list will be sorted.
newOrderis the list of adjacency entries of v in the new order.

Definition at line 1061 of file Graph_d.h.

◆ split()

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

Splits edge e into two edges introducing a new node.

Let e=(v,w). Then, the resulting two edges are e=(v,u) and e'=(u,w), where u is a new node.

Note
The edge e is modified by this operation.
Parameters
eis the edge to be split.
Returns
The edge e'.

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

◆ splitNode()

node ogdf::Graph::splitNode ( adjEntry  adjStartLeft,
adjEntry  adjStartRight 
)

Splits a node while preserving the order of adjacency entries.

This method splits a node v into two nodes vl and vr. Node vl receives all adjacent edges of v from adjStartLeft until the edge preceding adjStartRight, and vr the remaining nodes (thus adjStartRight is the first edge that goes to vr). The order of adjacency entries is preserved. Additionally, a new edge (vl,vr) is created, such that this edge is inserted before adjStartLeft and adjStartRight in the adjacency lists of vl and vr.

When adjStartLeft and adjStartRight are the same, vl receives all edges and the edge (vl, vr) is inserted before adjStartLeft in the adjacency list of vl.

Node v is modified to become node vl, and node vr is returned. This method is useful when modifying combinatorial embeddings.

Parameters
adjStartLeftis the first entry that goes to the left node.
adjStartRightis the first entry that goes to the right node.
Returns
the newly created node.

◆ swapAdjEdges()

void ogdf::Graph::swapAdjEdges ( adjEntry  adj1,
adjEntry  adj2 
)
inline

Exchanges two entries in an adjacency list.

Precondition
adj1 and adj2 must be belong to the same adjacency list.
Parameters
adj1the first adjacency entry to be swapped.
adj2the secomd adjacency entry to be swapped.

Definition at line 1143 of file Graph_d.h.

◆ unregisterArray() [1/3]

void ogdf::Graph::unregisterArray ( ListIterator< AdjEntryArrayBase * >  it) const

Unregisters an adjEntry array.

Parameters
itis an iterator pointing to the entry in the list of registered adjacency entry arrays for the adjacency entry array to be unregistered.

◆ unregisterArray() [2/3]

void ogdf::Graph::unregisterArray ( ListIterator< EdgeArrayBase * >  it) const

Unregisters an edge array.

Parameters
itis an iterator pointing to the entry in the list of registered edge arrays for the edge array to be unregistered.

◆ unregisterArray() [3/3]

void ogdf::Graph::unregisterArray ( ListIterator< NodeArrayBase * >  it) const

Unregisters a node array.

Parameters
itis an iterator pointing to the entry in the list of registered node arrays for the node array to be unregistered.

◆ unregisterStructure()

void ogdf::Graph::unregisterStructure ( ListIterator< GraphObserver * >  it) const

Unregisters a graph observer.

Parameters
itis an iterator pointing to the entry in the list of registered graph observers for the graph observer to be unregistered.

◆ unsplit() [1/2]

virtual void ogdf::Graph::unsplit ( edge  eIn,
edge  eOut 
)
virtual

Undoes a split operation.

For two edges eIn = (x,u) and eOut = (u,y), removes node u by joining eIn and eOut. Edge eOut is removed and eIn is reused.

Precondition
eIn and eOut are the only edges incident with u and none of them is a self-loop.
Parameters
eInis the (only) incoming edge of u.
eOutis the (only) outgoing edge of u.

Reimplemented in ogdf::GraphCopy, and ogdf::PlanRepExpansion.

◆ unsplit() [2/2]

void ogdf::Graph::unsplit ( node  u)

Undoes a split operation.

Removes node u by joining the two edges adjacent to u. The outgoing edge of u is removed and the incoming edge e is reused

Precondition
u has exactly one incoming and one outgoing edge, and none of them is a self-loop.
Parameters
uis the node to be unsplit.
Returns
The edge e.

Member Data Documentation

◆ edges

The container containing all edge objects.

Definition at line 571 of file Graph_d.h.

◆ m_edgeArrayTableSize

int ogdf::Graph::m_edgeArrayTableSize
private

The current table size of edge arrays associated with this graph.

Definition at line 504 of file Graph_d.h.

◆ m_edgeIdCount

int ogdf::Graph::m_edgeIdCount
private

The Index that will be assigned to the next created edge.

Definition at line 501 of file Graph_d.h.

◆ m_hiddenEdgeSets

List<HiddenEdgeSet*> ogdf::Graph::m_hiddenEdgeSets
private

The list of hidden edges.

Definition at line 515 of file Graph_d.h.

◆ m_mutexRegArrays

std::mutex ogdf::Graph::m_mutexRegArrays
mutableprivate

The critical section for protecting shared acces to register/unregister methods.

Definition at line 512 of file Graph_d.h.

◆ m_nodeArrayTableSize

int ogdf::Graph::m_nodeArrayTableSize
private

The current table size of node arrays associated with this graph.

Definition at line 503 of file Graph_d.h.

◆ m_nodeIdCount

int ogdf::Graph::m_nodeIdCount
private

The Index that will be assigned to the next created node.

Definition at line 498 of file Graph_d.h.

◆ m_regAdjArrays

ListPure<AdjEntryArrayBase*> ogdf::Graph::m_regAdjArrays
mutableprivate

The registered adjEntry arrays.

Definition at line 508 of file Graph_d.h.

◆ m_regEdgeArrays

ListPure<EdgeArrayBase*> ogdf::Graph::m_regEdgeArrays
mutableprivate

The registered edge arrays.

Definition at line 507 of file Graph_d.h.

◆ m_regNodeArrays

ListPure<NodeArrayBase*> ogdf::Graph::m_regNodeArrays
mutableprivate

The registered node arrays.

Definition at line 506 of file Graph_d.h.

◆ m_regStructures

ListPure<GraphObserver*> ogdf::Graph::m_regStructures
mutableprivate

The registered graph structures.

Definition at line 509 of file Graph_d.h.

◆ nodes

The container containing all node objects.

Definition at line 568 of file Graph_d.h.


The documentation for this class was generated from the following file:
ogdf::adjEntry
AdjElement * adjEntry
The type of adjacency entries.
Definition: Graph_d.h:71
ogdf::edge
EdgeElement * edge
The type of edges.
Definition: Graph_d.h:67
ogdf::node
NodeElement * node
The type of nodes.
Definition: Graph_d.h:63
ogdf::Graph::edges
internal::GraphObjectContainer< EdgeElement > edges
The container containing all edge objects.
Definition: Graph_d.h:571
ogdf::graphml::Attribute::G
@ G