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

#include <ogdf/basic/Graph_d.h>

Inheritance diagram for ogdf::Graph:

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

Public Member Functions
	Graph ()
	Constructs an empty graph.
	Graph (const Graph &G)
	Constructs a graph that is a copy of G.
virtual	~Graph ()
	Destructor.
Access methods
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.
Creation of new nodes and edges
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.
Removing nodes and edges
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.
Hiding edges
These methods are used for temporarily hiding edges. Edges are removed from the list of all edges and their corresponding adfjacency entries from the repsective adjacency lists, but the edge objects themselves are not destroyed; hiddenedges can later be reactivated with restoreEdge().
void	hideEdge (edge e)
	Hides the edge e.
void	restoreEdge (edge e)
	Restores a hidden edge e.
void	restoreAllEdges ()
	Restores all hidden edges.
Advanced modification methods
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.
Input and output
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.
Miscellaneous
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.
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.
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.
Operators
Graph &	operator= (const Graph &G)
	Assignment operator.

Static Public Member Functions
static int	nextPower2 (int start, int idCount)
	Returns the smallest power of 2 which is >= 2^start and > idCount.

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

Private Member Functions
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)
void	moveAdj (adjEntry adj, node w)
node	pureNewNode ()
bool	readToEndOfLine (istream &is)
void	reinitArrays ()
void	reinitStructures ()
void	resetAdjEntryIndex (int newIndex, int oldIndex)

Private Attributes
int	m_edgeArrayTableSize
	The current table size of edge arrays associated with this graph.
int	m_edgeIdCount
	The Index that will be assigned to the next created edge.
GraphList< EdgeElement >	m_edges
	The list of all edges.
GraphList< EdgeElement >	m_hiddenEdges
	The list of hidden edges.
int	m_nEdges
	The number of edges in the graph.
int	m_nNodes
	The number of nodes in the graph.
int	m_nodeArrayTableSize
	The current table size of node arrays associated with this graph.
int	m_nodeIdCount
	The Index that will be assigned to the next created node.
GraphList< NodeElement >	m_nodes
	The list of all nodes.
ListPure< AdjEntryArrayBase * >	m_regAdjArrays
	The registered adjEntry arrays.
ListPure< EdgeArrayBase * >	m_regEdgeArrays
	The registered edge arrays.
ListPure< NodeArrayBase * >	m_regNodeArrays
	The registered node arrays.
ListPure< GraphObserver * >	m_regStructures
	The registered graph structures.

Detailed Description

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

Iteration

Besides the usage of iteration macros defined in Graph_d.h, the following code is recommended for further iteration tasks.

Iteration over all outgoing edges e of node v:

forall_adj_edges(e,v)

if(e->source() != v) continue;
Iteration over all ingoing edges e of node v:

forall_adj_edges(e,v)

if(e->target() != v) continue;
Iteration over all nodes x reachable by an outgoing edge e of node v (without self-loops):

forall_adj_edges(e,v)

if ((x = e->target()) == v) continue;
Iteration over all nodes x reachable by an outgoing edge e of node v (with self-loops):

forall_adj_edges(e,v) {

if (e->source() != v) continue;

x = e->target();

}
Iteration over all nodes x reachable by an ingoing edge e of node v (without self-loops):

forall_adj_edges(e,v)

if ((x = e->source()) == v) continue;
Iteration over all nodes x reachable by an ingoing edge e of node v (with self-loops):
forall_adj_edges(e,v) {

if (e->target() != v) continue;

x = e->source();

}

Definition at line 690 of file Graph_d.h.

Member Enumeration Documentation

enum ogdf::Graph::EdgeType

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

Enumerator:

association
generalization
dependency

Definition at line 716 of file Graph_d.h.

enum ogdf::Graph::NodeType

The type of nodes.

Enumerator:

vertex
dummy
generalizationMerger
generalizationExpander
highDegreeExpander
lowDegreeExpander
associationClass

Reimplemented in ogdf::ExtendedNestingGraph.

Definition at line 723 of file Graph_d.h.

Constructor & Destructor Documentation

ogdf::Graph::Graph ( )

Constructs an empty graph.

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:

G	is the graph that will be copied.

virtual ogdf::Graph::~Graph ( )

virtual

Destructor.

Member Function Documentation

template<class EDGELIST >

void ogdf::Graph::adjEdges	(	node	v,
		EDGELIST &	edges
	)		const

inline

Returns a list with all edges adjacent to node v.

Template Parameters:

EDGELIST is the type of edge list, which is returned.

Parameters:

v	is the node whose incident edges are queried.
edges	is assigned the list of all edges incident to v (including incoming and outcoming edges).

Definition at line 826 of file Graph_d.h.

template<class ADJLIST >

void ogdf::Graph::adjEntries	(	node	v,
		ADJLIST &	entries
	)		const

inline

Returns a list with all entries in the adjacency list of node v.

Template Parameters:

ADJLIST is the type of adjacency entry list, which is returned.

Parameters:

v	is the node whose adjacency entries are queried.
entries	is assigned the list of all adjacency entries in the adjacency list of v.

Definition at line 840 of file Graph_d.h.

int ogdf::Graph::adjEntryArrayTableSize ( ) const

inline

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

Definition at line 777 of file Graph_d.h.

template<class EDGELIST >

void ogdf::Graph::allEdges ( EDGELIST & edges ) const

inline

Returns a list with all edges of the graph.

Template Parameters:

EDGELIST is the type of edge list, which is returned.

Parameters:

edges is assigned the list of all edges.

Definition at line 812 of file Graph_d.h.

template<class NODELIST >

void ogdf::Graph::allNodes ( NODELIST & nodes ) const

inline

Returns a list with all nodes of the graph.

Template Parameters:

NODELIST is the type of node list, which is returned.

Parameters:

nodes is assigned the list of all nodes.

Definition at line 800 of file Graph_d.h.

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

protected

edge ogdf::Graph::chooseEdge ( ) const

Returns a randomly chosen edge.

node ogdf::Graph::chooseNode ( ) const

Returns a randomly chosen node.

void ogdf::Graph::clear ( )

Removes all nodes and all edges from the graph.

template<class NODELIST >

void ogdf::Graph::collaps ( NODELIST & nodes )

inline

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

Parallel edges are removed.

Template Parameters:

NODELIST is the type of input node list.

Parameters:

nodes is the list of nodes that will be collapsed. This list will be empty after the call.

Definition at line 1171 of file Graph_d.h.

bool ogdf::Graph::consistencyCheck ( ) const

Checks the consistency of the data structure.

Remarks:: This method is meant for debugging purposes only.

Returns:: true if everything is ok, false if the data structure is inconsistent.

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

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

protected

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

protected

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

protected

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

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

node ogdf::Graph::contract ( edge e )

Contracts edge e while preserving the order of adjacency entries.

Parameters:

e	is the edge to be contracted.

Returns:: the endpoint of e to which all edges have been moved.

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

private

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

private

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

private

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

Removes edge e from the graph.

Parameters:

e	is the egde that will be deleted.

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

Removes node v and all incident edges from the graph.

Parameters:

v	is the node that will be deleted.

int ogdf::Graph::edgeArrayTableSize ( ) const

inline

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

Definition at line 775 of file Graph_d.h.

bool ogdf::Graph::empty ( ) const

inline

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

Definition at line 757 of file Graph_d.h.

edge ogdf::Graph::firstEdge ( ) const

inline

Returns the first edge in the list of all edges.

Definition at line 785 of file Graph_d.h.

node ogdf::Graph::firstNode ( ) const

inline

Returns the first node in the list of all nodes.

Definition at line 780 of file Graph_d.h.

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, \(c\) connected components, \(nz\) isolated vertices, and \(fc\) face cycles. Then,

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

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

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

Hides the edge e.

The edge e is removed from the list of all edges and adjacency lists of nodes, but not deleted; e can be restored by calling restoreEdge(e).

Attention:: If an edge is hidden, its source and target node may not be deleted!

Parameters:

e	is the edge that will be hidden.

template<class EDGELIST >

void ogdf::Graph::inEdges	(	node	v,
		EDGELIST &	edges
	)		const

inline

Returns a list with all incoming edges of node v.

Template Parameters:

EDGELIST is the type of edge list, which is returned.

Parameters:

v	is the node whose incident edges are queried.
edges	is assigned the list of all incoming edges incident to v.

Definition at line 854 of file Graph_d.h.

edge ogdf::Graph::lastEdge ( ) const

inline

Returns the last edge in the list of all edges.

Definition at line 787 of file Graph_d.h.

node ogdf::Graph::lastNode ( ) const

inline

Returns the last node in the list of all nodes.

Definition at line 782 of file Graph_d.h.

int ogdf::Graph::maxAdjEntryIndex ( ) const

inline

Returns the largest used adjEntry index.

Definition at line 770 of file Graph_d.h.

int ogdf::Graph::maxEdgeIndex ( ) const

inline

Returns the largest used edge index.

Definition at line 768 of file Graph_d.h.

int ogdf::Graph::maxNodeIndex ( ) const

inline

Returns the largest used node index.

Definition at line 766 of file Graph_d.h.

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:

e	is the edge to be moved.
adjSrc	is the adjaceny entry before or after which the source adjacency entry of e will be inserted.
dirSrc	specifies if the source adjacency entry of e will be inserted before or after adjSrc.
adjTgt	is the adjaceny entry before or after which the target adjacency entry of e will be inserted.
dirTgt	specifies if the target adjacency entry of e will be inserted before or after adjTgt.

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:

adjMove	is an entry in the adjacency list of a node in this graph.
adjPos	is an entry in the same adjacency list as adjMove.
dir	specifies if adjMove is moved before or after adjPos.

Definition at line 1228 of file Graph_d.h.

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

private

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:

adjMove	is an entry in the adjacency list of a node in this graph.
adjAfter	is an entry in the same adjacency list as adjMove.

Definition at line 1242 of file Graph_d.h.

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:

adjMove	is an entry in the adjacency list of a node in this graph.
adjBefore	is an entry in the same adjacency list as adjMove.

Definition at line 1255 of file Graph_d.h.

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:

e	is the edge whose source node is moved.
w	is the new source node of e.

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:

e	is the edge whose source node is moved.
adjSrc	is the adjacency entry before or after which the source adjacency entry of e is inserted.
dir	specifies if the source adjacency entry of e is inserted before or after adjSrc.

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:

e	is the edge whose target node is moved.
w	is the new target node of e.

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:

e	is the edge whose target node is moved.
adjTgt	is the adjacency entry before or after which the target adjacency entry of e is inserted.
dir	specifies if the target adjacency entry of e is inserted before or after adjTgt.

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

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

Parameters:

v	is the source node of the newly created edge.
w	is the target node of the newly created edge.

Returns:: the newly created edge.

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

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

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

Precondition:: index is currently not the index of any other edge in the graph.

Attention:: Passing an edge index that is already in use results in an inconsistent data structure. Only use this method if you know what you're doing!

Parameters:

v	is the source node of the newly created edge.
w	is the target node of the newly created edge.
index	is the index that will be assigned to the newly created edge.

Returns:: the newly created edge.

edge ogdf::Graph::newEdge	(	adjEntry	adjSrc,
		adjEntry	adjTgt,
		Direction	dir = `ogdf::after`
	)

Creates a new edge at predefined positions in the adjacency lists.

Let v be the node whose adjacency list contains adjSrc, and w the node whose adjacency list contains adjTgt. Then, the created edge is (v,w).

Parameters:

adjSrc	is the adjacency entry after which the new edge is inserted in the adjacency list of v.
adjTgt	is the adjacency entry after which the new edge is inserted in the adjacency list of w.
dir	specifies if the edge is inserted before or after the given adjacency entries.

Returns:: the newly created edge.

edge ogdf::Graph::newEdge	(	node	v,
		adjEntry	adjTgt
	)

Creates a new edge at predefined positions in the adjacency lists.

Let w be the node whose adjacency list contains adjTgt. Then, the created edge is (v,w).

Parameters:

v	is the source node of the new edge; the edge is added at the end of the adjacency list of v.
adjTgt	is the adjacency entry after which the new edge is inserted in the adjacency list of w.

Returns:: the newly created edge.

Reimplemented in ogdf::GraphCopy.

edge ogdf::Graph::newEdge	(	adjEntry	adjSrc,
		node	w
	)

Creates a new edge at predefined positions in the adjacency lists.

Let v be the node whose adjacency list contains adjSrc. Then, the created edge is (v,w).

Parameters:

adjSrc	is the adjacency entry after which the new edge is inserted in the adjacency list of v.
w	is the source node of the new edge; the edge is added at the end of the adjacency list of w.

Returns:: the newly created edge.

Reimplemented in ogdf::GraphCopy.

node ogdf::Graph::newNode ( )

Creates a new node and returns it.

Reimplemented in ogdf::GraphCopy, ogdf::GraphCopySimple, and ogdf::EdgeWeightedGraph< T >.

node ogdf::Graph::newNode ( int index )

Creates a new node with predefined index and returns it.

Precondition:: index is currently not the index of any other node in the graph.

Attention:: Passing a node index that is already in use results in an inconsistent data structure. Only use this method if you know what you're doing!

Parameters:

index is the index that will be assigned to the newly created node.

Returns:: the newly created node.

static int ogdf::Graph::nextPower2	(	int	start,
		int	idCount
	)

static

Returns the smallest power of 2 which is >= 2^start and > idCount.

int ogdf::Graph::nodeArrayTableSize ( ) const

inline

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

Definition at line 773 of file Graph_d.h.

int ogdf::Graph::numberOfEdges ( ) const

inline

Returns the number of edges in the graph.

Definition at line 763 of file Graph_d.h.

int ogdf::Graph::numberOfNodes ( ) const

inline

Returns the number of nodes in the graph.

Definition at line 760 of file Graph_d.h.

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:

G	is the graph to be copied.

Returns:: this graph.

template<class EDGELIST >

void ogdf::Graph::outEdges	(	node	v,
		EDGELIST &	edges
	)		const

inline

Returns a list with all outgoing edges of node v.

Template Parameters:

EDGELIST is the type of edge list, which is returned.

Parameters:

v	is the node whose incident edges are queried.
edges	is assigned the list of all outgoing edges incident to v.

Definition at line 868 of file Graph_d.h.

node ogdf::Graph::pureNewNode ( )

private

bool ogdf::Graph::readGML ( const char * fileName )

Reads a graph in GML format from file fileName.

Parameters:

fileName is the name of the input file.

Returns:: true if successful, false otherwise.

bool ogdf::Graph::readGML ( istream & is )

Reads a graph in GML format from input stream is.

Parameters:

is	is the input file stream.

Returns:: true if successful, false otherwise.

bool ogdf::Graph::readLEDAGraph ( const char * fileName )

Reads a graph in LEDA format from file fileName.

Parameters:

fileName is the name of the input file.

Returns:: true if successful, false otherwise.

bool ogdf::Graph::readLEDAGraph ( istream & is )

Read a graph in LEDA format from input stream is.

Parameters:

is	is the input file stream.

Returns:: true if successful, false otherwise.

bool ogdf::Graph::readToEndOfLine ( istream & is )

private

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:

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

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:

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

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:

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

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

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

Parameters:

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

void ogdf::Graph::reinitArrays ( )

private

void ogdf::Graph::reinitStructures ( )

private

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 1350 of file Graph_d.h.

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

private

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 \(\leq\) maxId \(\leq\) maximal edge id in the graph.

Parameters:

maxId is an upper bound of the edge ids in the graph.

void ogdf::Graph::restoreAllEdges ( )

Restores all hidden edges.

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

Restores a hidden edge e.

Precondition:: e is currently hidden and its source and target have not been removed!

Parameters:

e	is the hidden edge that will be restored.

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

inline

Reverses the adjacency list of v.

Parameters:

v	is the node whose adjacency list will be reveresed.

Definition at line 1216 of file Graph_d.h.

void ogdf::Graph::reverseAdjEdges ( )

Reverses all adjacency lists.

void ogdf::Graph::reverseAllEdges ( )

Reverses all edges in the graph.

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

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

Parameters:

e	is the edge to be reveresed.

edge ogdf::Graph::searchEdge	(	node	v,
		node	w
	)		const

Searches and returns an edge connecting nodes v and w.

Parameters:

v	is the source node of the edge to be searched.
w	is the target node of the edge to be searched.

Returns:: an edge (\ v,w) if such an edge exists, 0 otherwise.

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_LIST is the type of the input adjacency entry list.

Parameters:

v	is the node whose adjacency list will be sorted.
newOrder	is the list of adjacency entries of v in the new order.

Definition at line 1202 of file Graph_d.h.

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:

e	is the edge to be split.

Returns:: The edge e'.

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

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 the adjacency lists of vl and vr.

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

Parameters:

adjStartLeft	is the first entry that goes to the left node.
adjStartRight	is the first entry that goes to the right node.

Returns:: the newly created node.

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:

adj1	the first adjacency entry to be swapped.
adj2	the secomd adjacency entry to be swapped.

Definition at line 1271 of file Graph_d.h.

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

Unregisters a node array.

Parameters:

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

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

Unregisters an edge array.

Parameters:

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

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

unregisters an adjEntry array.

Parameters:

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

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

Unregisters a graph observer.

Parameters:

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

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:

u	is the node to be unsplit.

Returns:: The edge e.

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:

eIn	is the (only) incoming edge of u.
eOut	is the (only) outgoing edge of u.

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

void ogdf::Graph::writeGML ( const char * fileName ) const

Writes the graph in GML format to file fileName.

Parameters:

fileName is the name of the output file.

Reimplemented in ogdf::CompactionConstraintGraph< ATYPE >, and ogdf::CompactionConstraintGraphBase.

void ogdf::Graph::writeGML ( ostream & os ) const

Writes the graph in GML format to output stream os.

Parameters:

os	is the output file stream.

Returns:: true if successful, false otherwise.

Reimplemented in ogdf::CompactionConstraintGraph< ATYPE >, and ogdf::CompactionConstraintGraphBase.

Member Data Documentation

int ogdf::Graph::m_edgeArrayTableSize

private

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

Definition at line 701 of file Graph_d.h.

int ogdf::Graph::m_edgeIdCount

private

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

Definition at line 698 of file Graph_d.h.

GraphList<EdgeElement> ogdf::Graph::m_edges

private

The list of all edges.

Definition at line 693 of file Graph_d.h.

GraphList<EdgeElement> ogdf::Graph::m_hiddenEdges

private

The list of hidden edges.

Definition at line 708 of file Graph_d.h.

int ogdf::Graph::m_nEdges

private

The number of edges in the graph.

Definition at line 695 of file Graph_d.h.

int ogdf::Graph::m_nNodes

private

The number of nodes in the graph.

Definition at line 694 of file Graph_d.h.

int ogdf::Graph::m_nodeArrayTableSize

private

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

Definition at line 700 of file Graph_d.h.

int ogdf::Graph::m_nodeIdCount

private

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

Definition at line 697 of file Graph_d.h.

GraphList<NodeElement> ogdf::Graph::m_nodes

private

The list of all nodes.

Definition at line 692 of file Graph_d.h.

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

mutableprivate

The registered adjEntry arrays.

Definition at line 705 of file Graph_d.h.

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

mutableprivate

The registered edge arrays.

Definition at line 704 of file Graph_d.h.

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

mutableprivate

The registered node arrays.

Definition at line 703 of file Graph_d.h.

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

mutableprivate

The registered graph structures.

Definition at line 706 of file Graph_d.h.

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

ogdf/basic/Graph_d.h

OpenGraph DrawingFramework

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Iteration

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Open
Graph Drawing
Framework