#include <ogdf/upward/FaceSinkGraph.h>

Inheritance diagram for ogdf::FaceSinkGraph:

Public Member Functions
	FaceSinkGraph ()
	default constructor (dummy)

	FaceSinkGraph (const ConstCombinatorialEmbedding &E, node s)
	constructor (we assume that the original graph is connected!)

bool	containsSource (node v) const

node	faceNodeOf (edge e)

node	faceNodeOf (face f)

void	init (const ConstCombinatorialEmbedding &E, node s)

const ConstCombinatorialEmbedding &	originalEmbedding () const
	returns a reference to the embedding E of the original graph G

face	originalFace (node v) const
	returns the face in E corresponding to node v in the face-sink graph, 0 if v corresponds to a sink-switch

const Graph &	originalGraph () const
	return a reference to the original graph G

node	originalNode (node v) const
	returns the sink-switch in G corresponding to node v in the face-sink graph, 0 if v corresponds to a face

node	possibleExternalFaces (SList< face > &externalFaces)
	returns the list of faces f in E such that there exists an upward-planar drawing realizing E with f as external face a node v_T in tree T is returned as representative. v_T is 0 if no possible external face exists.

void	sinkSwitches (FaceArray< List< adjEntry > > &faceSwitches)
	compute the sink switches of all faces.

void	stAugmentation (node h, Graph &G, node &superSink, SList< edge > &augmentedEdges)
	augments G to an st-planar graph

void	stAugmentation (node h, Graph &G, SList< node > &augmentedNodes, SList< edge > &augmentedEdges)
	augments G to an st-planar graph (original implementation)

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

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

	Graph (Graph &&move)=delete

virtual	~Graph ()
	Destructor.

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

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

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.

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 (int index=-1)
	Creates a new node and returns it.

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

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

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

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

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.

virtual void	delNode (node v)
	Removes node `v` and all incident edges from the graph.

virtual void	delEdge (edge e)
	Removes edge `e` from the graph.

virtual void	clear ()
	Removes all nodes and all edges from the graph.

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

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

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.

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.

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

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

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

	operator const internal::GraphNodeRegistry & () const

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

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

	operator const internal::GraphEdgeRegistry & () const

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

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

	operator const internal::GraphAdjRegistry & () const

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

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.

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.

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

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.

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.

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.

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

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.

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

virtual	~Observable ()
	Note that all Observers must already be removed once the destructor of this base class is invoked (e.g.

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

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

Private Member Functions
node	checkForest ()
	checks if the face-sink graph is a forest with 1) there is exactly one tree T containing no internal vertex of G 2) all other trees contain exactly one internal vertex of G a node in tree T is returned as representative

bool	dfsCheckForest (node v, node parent, NodeArray< bool > &visited, int &nInternalVertices)
	performs dfs-traversal and checks for backwards edges

node	dfsFaceNodeOf (node v, node parent, face f1, face f2)

node	dfsStAugmentation (node v, node parent, Graph &G, SList< edge > &augmentedEdges)

node	dfsStAugmentation (node v, node parent, Graph &G, SList< node > &augmentedNodes, SList< edge > &augmentedEdges)

void	doInit ()
	constructs face-sink graph

void	gatherExternalFaces (node v, node parent, SList< face > &externalFaces)
	builds list of possible external faces

Private Attributes
NodeArray< bool >	m_containsSource
	contains face node the source ?

NodeArray< face >	m_originalFace
	original face in E

NodeArray< node >	m_originalNode
	original node in G

const ConstCombinatorialEmbedding *	m_pE
	associated embedding of graph G

node	m_source
	the single source

node	m_T
	representative of unique tree T

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

virtual void	nodeInserted (void *userData, node original, node copy)
	Callback notifying subclasses that insert() copied a node.

virtual void	edgeInserted (void *userData, edge original, edge copy)
	Callback notifying subclasses that insert() copied an edge.

virtual void	postInsert (void *userData, int newNodes, int newEdges)
	Callback notifying subclasses that an insert() call has finished.

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

const ListPure< GraphObserver * > &	getObservers () const

ListPure< GraphObserver * >::iterator	registerObserver (GraphObserver *obs) const
	Registers an observer.

void	unregisterObserver (typename ListPure< GraphObserver * >::iterator it) const
	Unregisters an observer.

Detailed Description

Definition at line 44 of file FaceSinkGraph.h.

Constructor & Destructor Documentation

◆ FaceSinkGraph() [1/2]

ogdf::FaceSinkGraph::FaceSinkGraph	(	const ConstCombinatorialEmbedding &	E,
		node	s
	)

constructor (we assume that the original graph is connected!)

◆ FaceSinkGraph() [2/2]

ogdf::FaceSinkGraph::FaceSinkGraph ( )

inline

default constructor (dummy)

Definition at line 50 of file FaceSinkGraph.h.

Member Function Documentation

◆ checkForest()

node ogdf::FaceSinkGraph::checkForest ( )

private

checks if the face-sink graph is a forest with 1) there is exactly one tree T containing no internal vertex of G 2) all other trees contain exactly one internal vertex of G a node in tree T is returned as representative

◆ containsSource()

bool ogdf::FaceSinkGraph::containsSource ( node v ) const

inline

Definition at line 70 of file FaceSinkGraph.h.

◆ dfsCheckForest()

bool ogdf::FaceSinkGraph::dfsCheckForest	(	node	v,
		node	parent,
		NodeArray< bool > &	visited,
		int &	nInternalVertices
	)

private

performs dfs-traversal and checks for backwards edges

◆ dfsFaceNodeOf()

node ogdf::FaceSinkGraph::dfsFaceNodeOf	(	node	v,
		node	parent,
		face	f1,
		face	f2
	)

private

◆ dfsStAugmentation() [1/2]

node ogdf::FaceSinkGraph::dfsStAugmentation	(	node	v,
		node	parent,
		Graph &	G,
		SList< edge > &	augmentedEdges
	)

private

◆ dfsStAugmentation() [2/2]

node ogdf::FaceSinkGraph::dfsStAugmentation	(	node	v,
		node	parent,
		Graph &	G,
		SList< node > &	augmentedNodes,
		SList< edge > &	augmentedEdges
	)

private

◆ doInit()

void ogdf::FaceSinkGraph::doInit ( )

private

constructs face-sink graph

◆ faceNodeOf() [1/2]

node ogdf::FaceSinkGraph::faceNodeOf ( edge e )

inline

Definition at line 83 of file FaceSinkGraph.h.

◆ faceNodeOf() [2/2]

node ogdf::FaceSinkGraph::faceNodeOf ( face f )

inline

Definition at line 88 of file FaceSinkGraph.h.

◆ gatherExternalFaces()

void ogdf::FaceSinkGraph::gatherExternalFaces	(	node	v,
		node	parent,
		SList< face > &	externalFaces
	)

private

builds list of possible external faces

all faces in tree T containing the single source s) by a dfs traversal of T

◆ init()

void ogdf::FaceSinkGraph::init	(	const ConstCombinatorialEmbedding &	E,
		node	s
	)

◆ originalEmbedding()

const ConstCombinatorialEmbedding & ogdf::FaceSinkGraph::originalEmbedding ( ) const

inline

returns a reference to the embedding E of the original graph G

Definition at line 58 of file FaceSinkGraph.h.

◆ originalFace()

face ogdf::FaceSinkGraph::originalFace ( node v ) const

inline

returns the face in E corresponding to node v in the face-sink graph, 0 if v corresponds to a sink-switch

Definition at line 66 of file FaceSinkGraph.h.

◆ originalGraph()

const Graph & ogdf::FaceSinkGraph::originalGraph ( ) const

inline

return a reference to the original graph G

Definition at line 55 of file FaceSinkGraph.h.

◆ originalNode()

node ogdf::FaceSinkGraph::originalNode ( node v ) const

inline

returns the sink-switch in G corresponding to node v in the face-sink graph, 0 if v corresponds to a face

Definition at line 62 of file FaceSinkGraph.h.

◆ possibleExternalFaces()

node ogdf::FaceSinkGraph::possibleExternalFaces ( SList< face > & externalFaces )

inline

returns the list of faces f in E such that there exists an upward-planar drawing realizing E with f as external face a node v_T in tree T is returned as representative. v_T is 0 if no possible external face exists.

Definition at line 75 of file FaceSinkGraph.h.

◆ sinkSwitches()

void ogdf::FaceSinkGraph::sinkSwitches ( FaceArray< List< adjEntry > > & faceSwitches )

compute the sink switches of all faces.

◆ stAugmentation() [1/2]

void ogdf::FaceSinkGraph::stAugmentation	(	node	h,
		Graph &	G,
		node &	superSink,
		SList< edge > &	augmentedEdges
	)

augments G to an st-planar graph

(introduces only one new node as super sink into G)

◆ stAugmentation() [2/2]

void ogdf::FaceSinkGraph::stAugmentation	(	node	h,
		Graph &	G,
		SList< node > &	augmentedNodes,
		SList< edge > &	augmentedEdges
	)

augments G to an st-planar graph (original implementation)

introduces also new nodes into G corresponding to face-nodes in face sink graph)

Member Data Documentation

◆ m_containsSource

NodeArray<bool> ogdf::FaceSinkGraph::m_containsSource

private

contains face node the source ?

Definition at line 150 of file FaceSinkGraph.h.

◆ m_originalFace

NodeArray<face> ogdf::FaceSinkGraph::m_originalFace

private

original face in E

Definition at line 149 of file FaceSinkGraph.h.

◆ m_originalNode

NodeArray<node> ogdf::FaceSinkGraph::m_originalNode

private

original node in G

Definition at line 148 of file FaceSinkGraph.h.

◆ m_pE

const ConstCombinatorialEmbedding* ogdf::FaceSinkGraph::m_pE

private

associated embedding of graph G

Definition at line 144 of file FaceSinkGraph.h.

◆ m_source

node ogdf::FaceSinkGraph::m_source

private

the single source

Definition at line 145 of file FaceSinkGraph.h.

◆ m_T

node ogdf::FaceSinkGraph::m_T

private

representative of unique tree T

Definition at line 146 of file FaceSinkGraph.h.

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

include/ogdf/upward/FaceSinkGraph.h

OpenGraph DrawingFramework

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FaceSinkGraph() [1/2]

◆ FaceSinkGraph() [2/2]

Member Function Documentation

◆ checkForest()

◆ containsSource()

◆ dfsCheckForest()

◆ dfsFaceNodeOf()

◆ dfsStAugmentation() [1/2]

◆ dfsStAugmentation() [2/2]

◆ doInit()

◆ faceNodeOf() [1/2]

◆ faceNodeOf() [2/2]

◆ gatherExternalFaces()

◆ init()

◆ originalEmbedding()

◆ originalFace()

◆ originalGraph()

◆ originalNode()

◆ possibleExternalFaces()

◆ sinkSwitches()

◆ stAugmentation() [1/2]

◆ stAugmentation() [2/2]

Member Data Documentation

◆ m_containsSource

◆ m_originalFace

◆ m_originalNode

◆ m_pE

◆ m_source

◆ m_T

Open
Graph Drawing
Framework