Open
Graph Drawing
Framework

 v.2012.07
 

ogdf::AdjElement Class Reference

Class for adjacency list elements. More...

#include <ogdf/basic/Graph_d.h>

+ Inheritance diagram for ogdf::AdjElement:

List of all members.

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.
int index () const
 Returns the index of this adjacency element.
 operator edge () const
 Conversion to edge.
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()).

Private Member Functions

 AdjElement (node v)
 Constructs an adjacency element for a given node.
 AdjElement (edge e, int id)
 Constructs an adjacency entry for a given edge and index.

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.
AdjElementm_twin
 The corresponding adjacency entry (same edge)

Friends

class Graph
class GraphList< AdjElement >
class 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 375 of file Graph_d.h.


Constructor & Destructor Documentation

ogdf::AdjElement::AdjElement ( node  v)
inlineprivate

Constructs an adjacency element for a given node.

Definition at line 386 of file Graph_d.h.

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

Constructs an adjacency entry for a given edge and index.

Definition at line 388 of file Graph_d.h.


Member Function Documentation

adjEntry ogdf::AdjElement::clockwiseFacePred ( ) const
inline

Returns the clockwise predecessor in face. Use faceCycleSucc instead!

Definition at line 413 of file Graph_d.h.

adjEntry ogdf::AdjElement::clockwiseFaceSucc ( ) const
inline

Returns the clockwise successor in face. Use faceCycleSucc instead!

Definition at line 411 of file Graph_d.h.

adjEntry ogdf::AdjElement::counterClockwiseFacePred ( ) const
inline

Returns the counter-clockwise predecessor in face.

Definition at line 417 of file Graph_d.h.

adjEntry ogdf::AdjElement::counterClockwiseFaceSucc ( ) const
inline

Returns the counter-clockwise successor in face.

Definition at line 415 of file Graph_d.h.

adjEntry ogdf::AdjElement::cyclicPred ( ) const
inline

Returns the cyclic predecessor in the adjacency list.

Definition at line 510 of file Graph_d.h.

adjEntry ogdf::AdjElement::cyclicSucc ( ) const
inline

Returns the cyclic successor in the adjacency list.

Definition at line 505 of file Graph_d.h.

adjEntry ogdf::AdjElement::faceCyclePred ( ) const
inline

Returns the cyclic predecessor in face.

Definition at line 423 of file Graph_d.h.

adjEntry ogdf::AdjElement::faceCycleSucc ( ) const
inline

Returns the cyclic successor in face.

Definition at line 421 of file Graph_d.h.

int ogdf::AdjElement::index ( ) const
inline

Returns the index of this adjacency element.

Definition at line 405 of file Graph_d.h.

ogdf::AdjElement::operator edge ( ) const
inline

Conversion to edge.

Definition at line 394 of file Graph_d.h.

adjEntry ogdf::AdjElement::pred ( ) const
inline

Returns the predecessor in the adjacency list.

Definition at line 429 of file Graph_d.h.

adjEntry ogdf::AdjElement::succ ( ) const
inline

Returns the successor in the adjacency list.

Definition at line 427 of file Graph_d.h.

edge ogdf::AdjElement::theEdge ( ) const
inline

Returns the edge associated with this adjacency entry.

Definition at line 392 of file Graph_d.h.

node ogdf::AdjElement::theNode ( ) const
inline

Returns the node whose adjacency list contains this element.

Definition at line 396 of file Graph_d.h.

adjEntry ogdf::AdjElement::twin ( ) const
inline

Returns the corresponding adjacency element associated with the same edge.

Definition at line 399 of file Graph_d.h.

node ogdf::AdjElement::twinNode ( ) const
inline

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

Definition at line 402 of file Graph_d.h.


Friends And Related Function Documentation

friend class Graph
friend

Reimplemented from ogdf::GraphElement.

Definition at line 376 of file Graph_d.h.

friend class GraphList< AdjElement >
friend

Definition at line 378 of file Graph_d.h.

friend class GraphListBase
friend

Reimplemented from ogdf::GraphElement.

Definition at line 377 of file Graph_d.h.


Member Data Documentation

edge ogdf::AdjElement::m_edge
private

The associated edge.

Definition at line 381 of file Graph_d.h.

int ogdf::AdjElement::m_id
private

The (unique) index of the adjacency entry.

Definition at line 383 of file Graph_d.h.

node ogdf::AdjElement::m_node
private

The node whose adjacency list contains this entry.

Definition at line 382 of file Graph_d.h.

AdjElement* ogdf::AdjElement::m_twin
private

The corresponding adjacency entry (same edge)

Definition at line 380 of file Graph_d.h.


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