Open
Graph Drawing
Framework

 v.2007.11
 

ogdf::AdjElement Class Reference

Class for adjacency list elements. More...

#include <Graph_d.h>

Inheritance diagram for ogdf::AdjElement:

ogdf::GraphElement

List of all members.

Public Member Functions

edge theEdge () const
 Returns the associated edge.
 operator edge () const
 Conversion to edge.
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()).
int index () const
 Returns the index of this adjacency element.
adjEntry clockwiseFaceSucc () const
 Returns the clockwise successor in face. Use faceCycleSucc instead!
adjEntry clockwiseFacePred () const
 Returns the clockwise predecessor in face. Use faceCycleSucc instead!
adjEntry counterClockwiseFaceSucc () const
 Returns the counter-clockwise successor in face.
adjEntry counterClockwiseFacePred () const
 Returns the counter-clockwise predecessor in face.
adjEntry faceCycleSucc () const
 Returns the cyclic successor in face.
adjEntry faceCyclePred () const
 Returns the cyclic predecessor in face.
adjEntry succ () const
 Returns the successor in the adjacency list.
adjEntry pred () const
 Returns the predecessor in the adjacency list.
adjEntry cyclicSucc () const
 Returns the cyclic successor in the adjacency list.
adjEntry cyclicPred () const
 Returns the cyclic predecessor in the adjacency list.
void * operator new (size_t nBytes)
void * operator new (size_t, void *p)
void operator delete (void *p, size_t nBytes)

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

AdjElementm_twin
 The corresponding adjacency entry (same edge).
edge m_edge
 The associated edge.
node m_node
 The node whose adjacency list contains this entry.
int m_id
 The (unique) index of the adjacency entry.

Friends

class Graph
class GraphListBase
class GraphList< AdjElement >


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


Constructor & Destructor Documentation

ogdf::AdjElement::AdjElement ( node  v  )  [inline, private]

Constructs an adjacency element for a given node.

Definition at line 392 of file Graph_d.h.

ogdf::AdjElement::AdjElement ( edge  e,
int  id 
) [inline, private]

Constructs an adjacency entry for a given edge and index.

Definition at line 394 of file Graph_d.h.


Member Function Documentation

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

Returns the associated edge.

Definition at line 398 of file Graph_d.h.

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

Conversion to edge.

Definition at line 400 of file Graph_d.h.

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

Returns the node whose adjacency list contains this element.

Definition at line 402 of file Graph_d.h.

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

Returns the corresponding adjacency element associated with the same edge.

Definition at line 405 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 408 of file Graph_d.h.

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

Returns the index of this adjacency element.

Definition at line 411 of file Graph_d.h.

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

Returns the clockwise successor in face. Use faceCycleSucc instead!

Definition at line 417 of file Graph_d.h.

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

Returns the clockwise predecessor in face. Use faceCycleSucc instead!

Definition at line 419 of file Graph_d.h.

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

Returns the counter-clockwise successor in face.

Definition at line 421 of file Graph_d.h.

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

Returns the counter-clockwise 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 427 of file Graph_d.h.

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

Returns the cyclic predecessor in face.

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

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

Returns the predecessor in the adjacency list.

Definition at line 435 of file Graph_d.h.

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

Returns the cyclic successor in the adjacency list.

Definition at line 511 of file Graph_d.h.

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

Returns the cyclic predecessor in the adjacency list.

Definition at line 516 of file Graph_d.h.

void* ogdf::AdjElement::operator new ( size_t  nBytes  )  [inline]

Reimplemented from ogdf::GraphElement.

Definition at line 446 of file Graph_d.h.

void* ogdf::AdjElement::operator new ( size_t  ,
void *  p 
) [inline]

Reimplemented from ogdf::GraphElement.

Definition at line 446 of file Graph_d.h.

void ogdf::AdjElement::operator delete ( void *  p,
size_t  nBytes 
) [inline]

Reimplemented from ogdf::GraphElement.

Definition at line 446 of file Graph_d.h.


Friends And Related Function Documentation

friend class Graph [friend]

Reimplemented from ogdf::GraphElement.

Definition at line 382 of file Graph_d.h.

friend class GraphListBase [friend]

Reimplemented from ogdf::GraphElement.

Definition at line 383 of file Graph_d.h.

friend class GraphList< AdjElement > [friend]

Definition at line 384 of file Graph_d.h.


Member Data Documentation

AdjElement* ogdf::AdjElement::m_twin [private]

The corresponding adjacency entry (same edge).

Definition at line 386 of file Graph_d.h.

edge ogdf::AdjElement::m_edge [private]

The associated edge.

Definition at line 387 of file Graph_d.h.

node ogdf::AdjElement::m_node [private]

The node whose adjacency list contains this entry.

Definition at line 388 of file Graph_d.h.

int ogdf::AdjElement::m_id [private]

The (unique) index of the adjacency entry.

Definition at line 389 of file Graph_d.h.


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

© 1999-2007 by oreas GmbH, © 2005-2007 by University Dortmund and University Cologne.

Generated on Thu Nov 22 19:40:07 2007 by doxygen 1.5.4.