Class for adjacency list elements. More...

#include <ogdf/basic/Graph_d.h>

Inheritance diagram for ogdf::AdjElement:

Public Member Functions
adjEntry	clockwiseFacePred () const
	Returns the clockwise predecessor in face. Use faceCycleSucc instead!

adjEntry	clockwiseFaceSucc () const
	Returns the clockwise successor in face. Use faceCycleSucc instead!

adjEntry	counterClockwiseFacePred () const
	Returns the counter-clockwise predecessor in face.

adjEntry	counterClockwiseFaceSucc () const
	Returns the counter-clockwise successor in face.

adjEntry	cyclicPred () const
	Returns the cyclic predecessor in the adjacency list.

adjEntry	cyclicSucc () const
	Returns the cyclic successor in the adjacency list.

adjEntry	faceCyclePred () const
	Returns the cyclic predecessor in face.

adjEntry	faceCycleSucc () const
	Returns the cyclic successor in face.

const Graph *	graphOf () const

int	index () const
	Returns the index of this adjacency element.

bool	isBetween (adjEntry adjBefore, adjEntry adjAfter) const
	Returns whether this adjacency entry lies between `adjBefore` and `adjAfter` in clockwise rotation.

bool	isSource () const
	Returns `true` iff this is the source adjacency entry of the corresponding edge.

	operator edge () const
	Conversion to edge.

	operator node () const
	Casts to the node whose adjacency list contains this element.

adjEntry	pred () const
	Returns the predecessor in the adjacency list.

adjEntry	succ () const
	Returns the successor in the adjacency list.

edge	theEdge () const
	Returns the edge associated with this adjacency entry.

node	theNode () const
	Returns the node whose adjacency list contains this element.

adjEntry	twin () const
	Returns the corresponding adjacency element associated with the same edge.

node	twinNode () const
	Returns the associated node of the corresponding adjacency entry (shorthand for twin()->theNode()).

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

Private Member Functions
	AdjElement (edge e, int id)
	Constructs an adjacency entry for a given edge and index.

	AdjElement (node v)
	Constructs an adjacency element for a given node.

Private Attributes
edge	m_edge
	The associated edge.

int	m_id
	The (unique) index of the adjacency entry.

node	m_node
	The node whose adjacency list contains this entry.

AdjElement *	m_twin
	The corresponding adjacency entry (same edge)

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

class	internal::GraphListBase

Detailed Description

Class for adjacency list elements.

Adjacency list elements represent the occurrence of an edges in the adjacency list of a node.

Definition at line 143 of file Graph_d.h.

Constructor & Destructor Documentation

◆ AdjElement() [1/2]

ogdf::AdjElement::AdjElement ( node v )

inlineexplicitprivate

Constructs an adjacency element for a given node.

Definition at line 154 of file Graph_d.h.

◆ AdjElement() [2/2]

ogdf::AdjElement::AdjElement	(	edge	e,
		int	id
	)

inlineprivate

Constructs an adjacency entry for a given edge and index.

Definition at line 157 of file Graph_d.h.

Member Function Documentation

◆ clockwiseFacePred()

adjEntry ogdf::AdjElement::clockwiseFacePred ( ) const

inline

Returns the clockwise predecessor in face. Use faceCycleSucc instead!

Definition at line 203 of file Graph_d.h.

◆ clockwiseFaceSucc()

adjEntry ogdf::AdjElement::clockwiseFaceSucc ( ) const

inline

Returns the clockwise successor in face. Use faceCycleSucc instead!

Definition at line 200 of file Graph_d.h.

◆ compare()

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

inlinestatic

Standard Comparer.

Definition at line 234 of file Graph_d.h.

◆ counterClockwiseFacePred()

adjEntry ogdf::AdjElement::counterClockwiseFacePred ( ) const

inline

Returns the counter-clockwise predecessor in face.

Definition at line 209 of file Graph_d.h.

◆ counterClockwiseFaceSucc()

adjEntry ogdf::AdjElement::counterClockwiseFaceSucc ( ) const

inline

Returns the counter-clockwise successor in face.

Definition at line 206 of file Graph_d.h.

◆ cyclicPred()

adjEntry ogdf::AdjElement::cyclicPred ( ) const

inline

Returns the cyclic predecessor in the adjacency list.

Definition at line 359 of file Graph_d.h.

◆ cyclicSucc()

adjEntry ogdf::AdjElement::cyclicSucc ( ) const

inline

Returns the cyclic successor in the adjacency list.

Definition at line 355 of file Graph_d.h.

◆ faceCyclePred()

adjEntry ogdf::AdjElement::faceCyclePred ( ) const

inline

Returns the cyclic predecessor in face.

Definition at line 216 of file Graph_d.h.

◆ faceCycleSucc()

adjEntry ogdf::AdjElement::faceCycleSucc ( ) const

inline

Returns the cyclic successor in face.

Definition at line 213 of file Graph_d.h.

◆ graphOf()

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

inline

Definition at line 477 of file Graph_d.h.

◆ index()

int ogdf::AdjElement::index ( ) const

inline

Returns the index of this adjacency element.

Definition at line 179 of file Graph_d.h.

◆ isBetween()

bool ogdf::AdjElement::isBetween	(	adjEntry	adjBefore,
		adjEntry	adjAfter
	)		const

inline

Returns whether this adjacency entry lies between adjBefore and adjAfter in clockwise rotation.

Note that this operation takes time linear in the degree of the node.

Parameters

adjBefore	First adjacency entry. Must be at the same node as this.
adjAfter	Last adjacency entry. Must be at the same node as this.

Returns: true iff this adjacency entry is in between

Definition at line 482 of file Graph_d.h.

◆ isSource()

bool ogdf::AdjElement::isSource ( ) const

inline

Returns true iff this is the source adjacency entry of the corresponding edge.

Definition at line 480 of file Graph_d.h.

◆ operator edge()

ogdf::AdjElement::operator edge ( ) const

inline

Conversion to edge.

Definition at line 164 of file Graph_d.h.

◆ operator node()

ogdf::AdjElement::operator node ( ) const

inline

Casts to the node whose adjacency list contains this element.

Definition at line 170 of file Graph_d.h.

◆ pred()

adjEntry ogdf::AdjElement::pred ( ) const

inline

Returns the predecessor in the adjacency list.

Definition at line 222 of file Graph_d.h.

◆ succ()

adjEntry ogdf::AdjElement::succ ( ) const

inline

Returns the successor in the adjacency list.

Definition at line 219 of file Graph_d.h.

◆ theEdge()

edge ogdf::AdjElement::theEdge ( ) const

inline

Returns the edge associated with this adjacency entry.

Definition at line 161 of file Graph_d.h.

◆ theNode()

node ogdf::AdjElement::theNode ( ) const

inline

Returns the node whose adjacency list contains this element.

Definition at line 167 of file Graph_d.h.

◆ twin()

adjEntry ogdf::AdjElement::twin ( ) const

inline

Returns the corresponding adjacency element associated with the same edge.

Definition at line 173 of file Graph_d.h.

◆ twinNode()

node ogdf::AdjElement::twinNode ( ) const

inline

Returns the associated node of the corresponding adjacency entry (shorthand for twin()->theNode()).

Definition at line 176 of file Graph_d.h.

Friends And Related Symbol Documentation

◆ Graph

friend class Graph

friend

Definition at line 144 of file Graph_d.h.

◆ internal::GraphList< AdjElement >

friend class internal::GraphList< AdjElement >

friend

Definition at line 145 of file Graph_d.h.

◆ internal::GraphListBase

friend class internal::GraphListBase

friend

Definition at line 145 of file Graph_d.h.

Member Data Documentation

◆ m_edge

edge ogdf::AdjElement::m_edge

private

The associated edge.

Definition at line 149 of file Graph_d.h.

◆ m_id

int ogdf::AdjElement::m_id

private

The (unique) index of the adjacency entry.

Definition at line 151 of file Graph_d.h.

◆ m_node

node ogdf::AdjElement::m_node

private

The node whose adjacency list contains this entry.

Definition at line 150 of file Graph_d.h.

◆ m_twin

AdjElement* ogdf::AdjElement::m_twin

private

The corresponding adjacency entry (same edge)

Definition at line 148 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

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ AdjElement() [1/2]

◆ AdjElement() [2/2]

Member Function Documentation

◆ clockwiseFacePred()

◆ clockwiseFaceSucc()

◆ compare()

◆ counterClockwiseFacePred()

◆ counterClockwiseFaceSucc()

◆ cyclicPred()

◆ cyclicSucc()

◆ faceCyclePred()

◆ faceCycleSucc()

◆ graphOf()

◆ index()

◆ isBetween()

◆ isSource()

◆ operator edge()

◆ operator node()

◆ pred()

◆ succ()

◆ theEdge()

◆ theNode()

◆ twin()

◆ twinNode()

Friends And Related Symbol Documentation

◆ Graph

◆ internal::GraphList< AdjElement >

◆ internal::GraphListBase

Member Data Documentation

◆ m_edge

◆ m_id

◆ m_node

◆ m_twin

Open
Graph Drawing
Framework