Open
Graph Drawing
Framework

 v.2010.10
 

Public Member Functions | Private Attributes

ogdf::ShellingOrderSet Class Reference

The node set in a shelling order of a graph. More...

#include <ogdf/planarlayout/ShellingOrder.h>

Inheritance diagram for ogdf::ShellingOrderSet:
ogdf::Array< node >

List of all members.

Public Member Functions

 ShellingOrderSet ()
 Creates an empty shelling order set.
 ShellingOrderSet (int l, adjEntry adjL=0, adjEntry adjR=0)
 Creates a shelling order set for l nodes.
 ~ShellingOrderSet ()
node left () const
 Returns the left-node of the set.
node right () const
 Returns the right-node of the set.
adjEntry leftAdj () const
 Returns the adjacency entry pointing from z1 to the left node (or 0 if no such node).
adjEntry rightAdj () const
 Returns the adjacency entry pointing from zp to the right node (or 0 if no such node).
bool hasLeft () const
 Returns true iff the adjacency entry to the left-node exists.
bool hasRight () const
 Returns true iff the adjacency entry to the right-node exists.
void left (node cl)
 Sets the left-node to cl.
void right (node cr)
 Sets the right-node to cr.
void leftAdj (adjEntry adjL)
 Sets the adjacency entry pointing to the left-node to adjL.
void rightAdj (adjEntry adjR)
 Sets the adjacency entry pointing to the right-node to adjR.
int len () const
 Returns the length of the order set, i.e., the number of contained nodes.
node operator[] (const int i) const
 Returns the i-th node in the order set from left (the leftmost node has index 1).
nodeoperator[] (const int i)
 Returns the i-th node in the order set from left (the leftmost node has index 1).
void operator= (const ShellingOrderSet &S)
 Assignment operator.

Private Attributes

node m_leftVertex
 the left-node of the set.
node m_rightVertex
 the right-node of the set.
adjEntry m_leftAdj
 the adjacency entry pointing to the left-node.
adjEntry m_rightAdj
 the adjacency entry pointing to the right-node.

Detailed Description

The node set in a shelling order of a graph.

Definition at line 70 of file ShellingOrder.h.


Constructor & Destructor Documentation

ogdf::ShellingOrderSet::ShellingOrderSet (  )  [inline]

Creates an empty shelling order set.

Definition at line 74 of file ShellingOrder.h.

ogdf::ShellingOrderSet::ShellingOrderSet ( int  l,
adjEntry  adjL = 0,
adjEntry  adjR = 0 
) [inline]

Creates a shelling order set for l nodes.

Parameters:
l is the number of nodes in the set.
adjL points to the left-node of the set.
adjR points to the right-node of the set.

Definition at line 86 of file ShellingOrder.h.

ogdf::ShellingOrderSet::~ShellingOrderSet (  )  [inline]

Definition at line 95 of file ShellingOrder.h.


Member Function Documentation

bool ogdf::ShellingOrderSet::hasLeft (  )  const [inline]

Returns true iff the adjacency entry to the left-node exists.

Definition at line 119 of file ShellingOrder.h.

bool ogdf::ShellingOrderSet::hasRight (  )  const [inline]

Returns true iff the adjacency entry to the right-node exists.

Definition at line 124 of file ShellingOrder.h.

node ogdf::ShellingOrderSet::left (  )  const [inline]

Returns the left-node of the set.

Definition at line 99 of file ShellingOrder.h.

void ogdf::ShellingOrderSet::left ( node  cl  )  [inline]

Sets the left-node to cl.

Definition at line 129 of file ShellingOrder.h.

void ogdf::ShellingOrderSet::leftAdj ( adjEntry  adjL  )  [inline]

Sets the adjacency entry pointing to the left-node to adjL.

Definition at line 139 of file ShellingOrder.h.

adjEntry ogdf::ShellingOrderSet::leftAdj (  )  const [inline]

Returns the adjacency entry pointing from z1 to the left node (or 0 if no such node).

Definition at line 109 of file ShellingOrder.h.

int ogdf::ShellingOrderSet::len (  )  const [inline]

Returns the length of the order set, i.e., the number of contained nodes.

Definition at line 149 of file ShellingOrder.h.

void ogdf::ShellingOrderSet::operator= ( const ShellingOrderSet S  )  [inline]

Assignment operator.

Definition at line 164 of file ShellingOrder.h.

node& ogdf::ShellingOrderSet::operator[] ( const int  i  )  [inline]

Returns the i-th node in the order set from left (the leftmost node has index 1).

Reimplemented from ogdf::Array< node >.

Definition at line 159 of file ShellingOrder.h.

node ogdf::ShellingOrderSet::operator[] ( const int  i  )  const [inline]

Returns the i-th node in the order set from left (the leftmost node has index 1).

Reimplemented from ogdf::Array< node >.

Definition at line 154 of file ShellingOrder.h.

node ogdf::ShellingOrderSet::right (  )  const [inline]

Returns the right-node of the set.

Definition at line 104 of file ShellingOrder.h.

void ogdf::ShellingOrderSet::right ( node  cr  )  [inline]

Sets the right-node to cr.

Definition at line 134 of file ShellingOrder.h.

adjEntry ogdf::ShellingOrderSet::rightAdj (  )  const [inline]

Returns the adjacency entry pointing from zp to the right node (or 0 if no such node).

Definition at line 114 of file ShellingOrder.h.

void ogdf::ShellingOrderSet::rightAdj ( adjEntry  adjR  )  [inline]

Sets the adjacency entry pointing to the right-node to adjR.

Definition at line 144 of file ShellingOrder.h.


Member Data Documentation

the adjacency entry pointing to the left-node.

Definition at line 175 of file ShellingOrder.h.

the left-node of the set.

Definition at line 173 of file ShellingOrder.h.

the adjacency entry pointing to the right-node.

Definition at line 176 of file ShellingOrder.h.

the right-node of the set.

Definition at line 174 of file ShellingOrder.h.


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