Open
Graph Drawing
Framework

 v.2010.10
 

Public Member Functions | Protected Member Functions | Protected Attributes

ogdf::ShellingOrderModule Class Reference

Base class for modules that compute a shelling order of a graph. More...

#include <ogdf/module/ShellingOrderModule.h>

Inheritance diagram for ogdf::ShellingOrderModule:
ogdf::BiconnectedShellingOrder ogdf::TriconnectedShellingOrder

List of all members.

Public Member Functions

void call (const Graph &G, ShellingOrder &order, adjEntry adj=0)
 Computes a shelling order of an embedded graph G such that adj lies on the external face.
void callLeftmost (const Graph &G, ShellingOrder &order, adjEntry adj=0)
 Computes a lefmost shelling order of an embedded graph G such that adj lies on the external face.
void baseRatio (double x)
 Sets the option base ratio to x.
double baseRatio () const
 Returns the current setting of the option base ratio.
virtual ~ShellingOrderModule ()

Protected Member Functions

virtual void doCall (const Graph &G, adjEntry adj, List< ShellingOrderSet > &partition)=0
 This pure virtual function does the actual computation.

Protected Attributes

double m_baseRatio

Detailed Description

Base class for modules that compute a shelling order of a graph.

Definition at line 70 of file ShellingOrderModule.h.


Constructor & Destructor Documentation

virtual ogdf::ShellingOrderModule::~ShellingOrderModule (  )  [inline, virtual]

Definition at line 89 of file ShellingOrderModule.h.


Member Function Documentation

void ogdf::ShellingOrderModule::baseRatio ( double  x  )  [inline]

Sets the option base ratio to x.

Definition at line 84 of file ShellingOrderModule.h.

double ogdf::ShellingOrderModule::baseRatio (  )  const [inline]

Returns the current setting of the option base ratio.

Definition at line 87 of file ShellingOrderModule.h.

void ogdf::ShellingOrderModule::call ( const Graph G,
ShellingOrder order,
adjEntry  adj = 0 
)

Computes a shelling order of an embedded graph G such that adj lies on the external face.

Parameters:
G is the input graph; G must represent a combinatorial embedding.
order is assigned the shelling order.
adj is an adjacency entry on the external face; if adj is 0, a suitable external face is chosen.
void ogdf::ShellingOrderModule::callLeftmost ( const Graph G,
ShellingOrder order,
adjEntry  adj = 0 
)

Computes a lefmost shelling order of an embedded graph G such that adj lies on the external face.

Parameters:
G is the input graph; G must represent a combinatorial embedding.
order is assigned the shelling order.
adj is an adjacency entry on the external face; if adj is 0, a suitable external face is chosen.
virtual void ogdf::ShellingOrderModule::doCall ( const Graph G,
adjEntry  adj,
List< ShellingOrderSet > &  partition 
) [protected, pure virtual]

This pure virtual function does the actual computation.

A derived class must implement this method. It is called with the embedded graph and an adjacency entry describing the external face, and must return the computed order in partition.

Parameters:
G is the embedded input graph.
adj is an adjacency entry on the external face.
partition returns the coputed shelling order.

Implemented in ogdf::BiconnectedShellingOrder, and ogdf::TriconnectedShellingOrder.


Member Data Documentation

Definition at line 105 of file ShellingOrderModule.h.


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