Class for the representation of nodes. More...

#include <ogdf/basic/Graph_d.h>

Inheritance diagram for ogdf::NodeElement:

Public Member Functions
template<class EDGELIST >
void	adjEdges (EDGELIST &edgeList) const
	Returns a list with all edges incident to this node.

template<class ADJLIST >
void	allAdjEntries (ADJLIST &adjList) const
	Returns a list with all adjacency entries of this node.

int	degree () const
	Returns the degree of the node (indegree + outdegree).

adjEntry	firstAdj () const
	Returns the first entry in the adjaceny list.

const Graph *	graphOf () const
	Returns the graph containing this node (debug only).

int	indeg () const
	Returns the indegree of the node.

int	index () const
	Returns the (unique) node index.

template<class EDGELIST >
void	inEdges (EDGELIST &edgeList) const
	Returns a list with all incoming edges of this node.

adjEntry	lastAdj () const
	Returns the last entry in the adjacency list.

int	outdeg () const
	Returns the outdegree of the node.

template<class EDGELIST >
void	outEdges (EDGELIST &edgeList) const
	Returns a list with all outgoing edges of this node.

node	pred () const
	Returns the predecessor in the list of all nodes.

node	succ () const
	Returns the successor in the list of all nodes.

Static Public Member Functions
static int	compare (const NodeElement &x, const NodeElement &y)
	Standard Comparer.

Public Attributes
internal::GraphObjectContainer< AdjElement >	adjEntries
	The container containing all entries in the adjacency list of this node.

Private Member Functions
	NodeElement (const Graph *pGraph, int id)
	Constructs a node element with index `id`.

Private Attributes
int	m_id
	The (unique) index of the node.

int	m_indeg
	The indegree of the node.

int	m_outdeg
	The outdegree of the node.

const Graph *	m_pGraph
	The graph containg this node (debug only).

Private Attributes inherited from ogdf::internal::GraphElement
GraphElement *	m_next = nullptr
	The successor in the list.

GraphElement *	m_prev = nullptr
	The predecessor in the list.

Friends
class	Graph

class	internal::GraphList< NodeElement >

Detailed Description

Class for the representation of nodes.

Definition at line 241 of file Graph_d.h.

Constructor & Destructor Documentation

◆ NodeElement()

ogdf::NodeElement::NodeElement	(	const Graph *	pGraph,
		int	id
	)

inlineprivate

Constructs a node element with index id.

Remarks: The parameter pGraph is only passed in a debug build. It is used, e.g., by NodeArray for checking if a node belongs to the correct graph.

Definition at line 263 of file Graph_d.h.

Member Function Documentation

◆ adjEdges()

template<class EDGELIST >

void ogdf::NodeElement::adjEdges ( EDGELIST & edgeList ) const

inline

Returns a list with all edges incident to this node.

Note that each self-loop of this node is contained twice in the list.

Template Parameters

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

Parameters

edgeList is assigned the list of all edges incident to this node (including incoming and outcoming edges).

Definition at line 320 of file Graph_d.h.

◆ allAdjEntries()

template<class ADJLIST >

void ogdf::NodeElement::allAdjEntries ( ADJLIST & adjList ) const

inline

Returns a list with all adjacency entries of this node.

Template Parameters

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

Parameters

adjList is assigned the list of all adjacency entries of this node.

Definition at line 304 of file Graph_d.h.

◆ compare()

static int ogdf::NodeElement::compare	(	const NodeElement &	x,
		const NodeElement &	y
	)

inlinestatic

Standard Comparer.

Definition at line 349 of file Graph_d.h.

◆ degree()

int ogdf::NodeElement::degree ( ) const

inline

Returns the degree of the node (indegree + outdegree).

Definition at line 284 of file Graph_d.h.

◆ firstAdj()

adjEntry ogdf::NodeElement::firstAdj ( ) const

inline

Returns the first entry in the adjaceny list.

Definition at line 287 of file Graph_d.h.

◆ graphOf()

const Graph * ogdf::NodeElement::graphOf ( ) const

inline

Returns the graph containing this node (debug only).

Definition at line 345 of file Graph_d.h.

◆ indeg()

int ogdf::NodeElement::indeg ( ) const

inline

Returns the indegree of the node.

Definition at line 278 of file Graph_d.h.

◆ index()

int ogdf::NodeElement::index ( ) const

inline

Returns the (unique) node index.

Definition at line 275 of file Graph_d.h.

◆ inEdges()

template<class EDGELIST >

void ogdf::NodeElement::inEdges ( EDGELIST & edgeList ) const

Returns a list with all incoming edges of this node.

Template Parameters

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

Parameters

edgeList is assigned the list of all incoming edges incident to this node.

Definition at line 502 of file Graph_d.h.

◆ lastAdj()

adjEntry ogdf::NodeElement::lastAdj ( ) const

inline

Returns the last entry in the adjacency list.

Definition at line 290 of file Graph_d.h.

◆ outdeg()

int ogdf::NodeElement::outdeg ( ) const

inline

Returns the outdegree of the node.

Definition at line 281 of file Graph_d.h.

◆ outEdges()

template<class EDGELIST >

void ogdf::NodeElement::outEdges ( EDGELIST & edgeList ) const

Returns a list with all outgoing edges of this node.

Template Parameters

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

Parameters

edgeList is assigned the list of all outgoing edges incident to this node.

Definition at line 513 of file Graph_d.h.

◆ pred()

node ogdf::NodeElement::pred ( ) const

inline

Returns the predecessor in the list of all nodes.

Definition at line 296 of file Graph_d.h.

◆ succ()

node ogdf::NodeElement::succ ( ) const

inline

Returns the successor in the list of all nodes.

Definition at line 293 of file Graph_d.h.

Friends And Related Symbol Documentation

◆ Graph

friend class Graph

friend

Definition at line 242 of file Graph_d.h.

◆ internal::GraphList< NodeElement >

friend class internal::GraphList< NodeElement >

friend

Definition at line 242 of file Graph_d.h.

Member Data Documentation

◆ adjEntries

internal::GraphObjectContainer<AdjElement> ogdf::NodeElement::adjEntries

The container containing all entries in the adjacency list of this node.

Definition at line 272 of file Graph_d.h.

◆ m_id

int ogdf::NodeElement::m_id

private

The (unique) index of the node.

Definition at line 248 of file Graph_d.h.

◆ m_indeg

int ogdf::NodeElement::m_indeg

private

The indegree of the node.

Definition at line 246 of file Graph_d.h.

◆ m_outdeg

int ogdf::NodeElement::m_outdeg

private

The outdegree of the node.

Definition at line 247 of file Graph_d.h.

◆ m_pGraph

const Graph* ogdf::NodeElement::m_pGraph

private

The graph containg this node (debug only).

Definition at line 252 of file Graph_d.h.

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

include/ogdf/basic/Graph_d.h

OpenGraph DrawingFramework

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ NodeElement()

Member Function Documentation

◆ adjEdges()

◆ allAdjEntries()

◆ compare()

◆ degree()

◆ firstAdj()

◆ graphOf()

◆ indeg()

◆ index()

◆ inEdges()

◆ lastAdj()

◆ outdeg()

◆ outEdges()

◆ pred()

◆ succ()

Friends And Related Symbol Documentation

◆ Graph

◆ internal::GraphList< NodeElement >

Member Data Documentation

◆ adjEntries

◆ m_id

◆ m_indeg

◆ m_outdeg

◆ m_pGraph

Open
Graph Drawing
Framework