#include <ogdf/upward/FaceSinkGraph.h>

Inheritance diagram for ogdf::FaceSinkGraph:

Public Member Functions
	FaceSinkGraph (const ConstCombinatorialEmbedding &E, node s)
	constructor (we assume that the original graph is connected!)
	FaceSinkGraph ()
	default constructor (dummy)
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
const Graph &	originalGraph () const
	return a reference to the original graph G
node	originalNode (node v) const
node	possibleExternalFaces (SList< face > &externalFaces)
void	sinkSwitches (FaceArray< List< adjEntry > > &faceSwitches)
	compute the sink switches of all faces.
void	stAugmentation (node h, Graph &G, SList< node > &augmentedNodes, SList< edge > &augmentedEdges)
	augments G to an st-planar graph (original implementation)
void	stAugmentation (node h, Graph &G, node &superSink, SList< edge > &augmentedEdges)
	augments G to an st-planar graph
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 () const
	Returns a randomly chosen node.
edge	chooseEdge () const
	Returns a randomly chosen edge.
template<class NODELIST >
void	allNodes (NODELIST &nodes) const
	Returns a list with all nodes of the graph.
template<class EDGELIST >
void	allEdges (EDGELIST &edges) const
	Returns a list with all edges of the graph.
template<class EDGELIST >
void	adjEdges (node v, EDGELIST &edges) const
	Returns a list with all edges adjacent to node v.
template<class ADJLIST >
void	adjEntries (node v, ADJLIST &entries) const
	Returns a list with all entries in the adjacency list of node v.
template<class EDGELIST >
void	inEdges (node v, EDGELIST &edges) const
	Returns a list with all incoming edges of node v.
template<class EDGELIST >
void	outEdges (node v, EDGELIST &edges) const
	Returns a list with all outgoing edges of node v.
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=ogdf::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.
void	delNode (node v)
	Removes node v and all incident edges from the graph.
void	delEdge (edge e)
	Removes edge e from the graph.
void	clear ()
	Removes all nodes and all edges from the graph.
void	hideEdge (edge e)
	Hides the edge e.
void	restoreEdge (edge e)
	Restores a hidden edge e.
void	restoreAllEdges ()
	Restores all hidden edges.
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)
	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) const
	Searches and returns an edge connecting nodes v and 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	collaps (NODELIST &nodes)
	Collapses all nodes in the list nodes 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.
bool	readGML (const char *fileName)
	Reads a graph in GML format from file fileName.
bool	readGML (istream &is)
	Reads a graph in GML format from input stream is.
void	writeGML (const char *fileName) const
	Writes the graph in GML format to file fileName.
void	writeGML (ostream &os) const
	Writes the graph in GML format to output stream os.
bool	readLEDAGraph (const char *fileName)
	Reads a graph in LEDA format from file fileName.
bool	readLEDAGraph (istream &is)
	Read a graph in LEDA format from input stream is.
int	genus () const
	Returns the genus of the graph's embedding.
bool	representsCombEmbedding () const
	Returns true iff the graph represents a combinatorial embedding.
bool	consistencyCheck () const
	Checks the consistency of the data structure.
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.
void	resetEdgeIdCount (int maxId)
	Resets the edge id count to maxId.
Graph &	operator= (const Graph &G)
	Assignment operator.

Private Member Functions
node	checkForest ()
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< node > &augmentedNodes, SList< edge > &augmentedEdges)
node	dfsStAugmentation (node v, node parent, Graph &G, SList< edge > &augmentedEdges)
void	doInit ()
	constructs face-sink graph
void	gatherExternalFaces (node v, node parent, SList< face > &externalFaces)
	builds list of possible external faces
adjEntry	getAdjEntry (node v, face f)
	return a adjEntry of node v which right face is f. Be Carefully! The adjEntry is not always unique.

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	EdgeType { association = 0, generalization = 1, dependency = 2 }
	The type of edges (only used in derived classes). More...
enum	NodeType { vertex, dummy, generalizationMerger, generalizationExpander, highDegreeExpander, lowDegreeExpander, associationClass }
	The type of nodes. More...
Static Public Member Functions inherited from ogdf::Graph
static int	nextPower2 (int start, int idCount)
	Returns the smallest power of 2 which is >= 2^start and > idCount.
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 > &nodes, const NodeArray< bool > &activeNodes, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
void	constructInitByNodes (const Graph &G, const List< node > &nodes, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
	Constructs a copy of the subgraph of G induced by nodes.

Detailed Description

Definition at line 60 of file FaceSinkGraph.h.

Constructor & Destructor Documentation

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

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

ogdf::FaceSinkGraph::FaceSinkGraph ( )

inline

default constructor (dummy)

Definition at line 67 of file FaceSinkGraph.h.

Member Function Documentation

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

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

inline

Definition at line 97 of file FaceSinkGraph.h.

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

private

performs dfs-traversal and checks for backwards edges

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

private

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

private

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

private

void ogdf::FaceSinkGraph::doInit ( )

private

constructs face-sink graph

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

inline

Definition at line 115 of file FaceSinkGraph.h.

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

inline

Definition at line 121 of file FaceSinkGraph.h.

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

adjEntry ogdf::FaceSinkGraph::getAdjEntry	(	node	v,
		face	f
	)

private

return a adjEntry of node v which right face is f. Be Carefully! The adjEntry is not always unique.

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

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

inline

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

Definition at line 79 of file FaceSinkGraph.h.

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 91 of file FaceSinkGraph.h.

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

inline

return a reference to the original graph G

Definition at line 74 of file FaceSinkGraph.h.

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 85 of file FaceSinkGraph.h.

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 107 of file FaceSinkGraph.h.

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

compute the sink switches of all faces.

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)

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)

Member Data Documentation

NodeArray<bool> ogdf::FaceSinkGraph::m_containsSource

private

contains face node the source ?

Definition at line 194 of file FaceSinkGraph.h.

NodeArray<face> ogdf::FaceSinkGraph::m_originalFace

private

original face in E

Definition at line 193 of file FaceSinkGraph.h.

NodeArray<node> ogdf::FaceSinkGraph::m_originalNode

private

original node in G

Definition at line 192 of file FaceSinkGraph.h.

const ConstCombinatorialEmbedding* ogdf::FaceSinkGraph::m_pE

private

associated embedding of graph G

Definition at line 188 of file FaceSinkGraph.h.

node ogdf::FaceSinkGraph::m_source

private

the single source

Definition at line 189 of file FaceSinkGraph.h.

node ogdf::FaceSinkGraph::m_T

private

representative of unique tree T

Definition at line 190 of file FaceSinkGraph.h.

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

ogdf/upward/FaceSinkGraph.h

OpenGraph DrawingFramework

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Open
Graph Drawing
Framework