ogdf::ShellingOrderModule Class Reference

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

#include <ogdf/planarlayout/ShellingOrderModule.h>

Inheritance diagram for ogdf::ShellingOrderModule:

Public Member Functions
virtual	~ShellingOrderModule ()
double	baseRatio () const
	Returns the current setting of the option base ratio.
void	baseRatio (double x)
	Sets the option base ratio to x.
void	call (const Graph &G, ShellingOrder &order, adjEntry adj=nullptr)
	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=nullptr)
	Computes a lefmost shelling order of an embedded graph G such that adj lies on the external face.

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 44 of file ShellingOrderModule.h.

Constructor & Destructor Documentation

~ShellingOrderModule()

virtual ogdf::ShellingOrderModule::~ShellingOrderModule ( )

inlinevirtual

Definition at line 70 of file ShellingOrderModule.h.

Member Function Documentation

baseRatio() [1/2]

double ogdf::ShellingOrderModule::baseRatio ( ) const

inline

Returns the current setting of the option base ratio.

Definition at line 68 of file ShellingOrderModule.h.

baseRatio() [2/2]

void ogdf::ShellingOrderModule::baseRatio ( double  x )

inline

Sets the option base ratio to x.

Definition at line 65 of file ShellingOrderModule.h.

call()

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

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.

callLeftmost()

void ogdf::ShellingOrderModule::callLeftmost	(	const Graph &	G,
		ShellingOrder &	order,
		adjEntry	adj = nullptr
	)

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.

doCall()

virtual void ogdf::ShellingOrderModule::doCall ( const Graph &  G, adjEntry  adj, List< ShellingOrderSet > &  partition  )

protectedpure 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

m_baseRatio

double ogdf::ShellingOrderModule::m_baseRatio

protected

Definition at line 84 of file ShellingOrderModule.h.

---

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

• include/ogdf/planarlayout/ShellingOrderModule.h