Open Graph Drawing Framework  v.2007.11

Overview Class Hierarchy Class Index Class List Members Namespaces Source Files Search for:

ogdf::AugmentationModule Class Reference

The base class for graph augmentation algorithms. More...

#include <AugmentationModule.h>

Inheritance diagram for ogdf::AugmentationModule:

List of all members.

Public Member Functions
	AugmentationModule ()
	Initializes an augmentation module.
virtual	~AugmentationModule ()
void	call (Graph &G)
	Calls the augmentation module for graph G.
void	operator() (Graph &G)
	Calls the augmentation module for graph G.
void	call (Graph &G, List< edge > &L)
	Calls the augmentation module for graph G.
void	operator() (Graph &G, List< edge > &L)
	Calls the augmentation module for graph G.
int	numberOfAddedEdges () const
	Returns the number of added edges.
void *	operator new (size_t nBytes)
void *	operator new (size_t, void *p)
void	operator delete (void *p)
Protected Member Functions
virtual void	doCall (Graph &G, List< edge > &L)=0
	Implements the augmentation algorithm for graph G.
Private Attributes
int	m_nAddedEdges

---

Detailed Description

The base class for graph augmentation algorithms.

The class AugmentationModule is the base class for augmentation modules. An augmentation module transforms an input graph G into an output graph G' by adding edges, such that G' has a certain property, e.g., biconnected.

Implementation of Augmentation Algorithms

An implementation of an augmentation module must override the protected method doCall(G,L), which gets as input a graph reference G. It then adds the augmented edges to G and returns the list of added edges in L.

Definition at line 78 of file AugmentationModule.h.

---

Constructor & Destructor Documentation

ogdf::AugmentationModule::AugmentationModule

(

)

[inline]

Initializes an augmentation module.

Definition at line 81 of file AugmentationModule.h.

virtual ogdf::AugmentationModule::~AugmentationModule

(

)

[inline, virtual]

Definition at line 83 of file AugmentationModule.h.

---

Member Function Documentation

void ogdf::AugmentationModule::call

(

Graph &

G

)

[inline]

Calls the augmentation module for graph G.

Definition at line 86 of file AugmentationModule.h.

void ogdf::AugmentationModule::operator()

(

Graph &

G

)

[inline]

Calls the augmentation module for graph G.

Definition at line 92 of file AugmentationModule.h.

void ogdf::AugmentationModule::call	(	Graph &	G,
		List< edge > &	L
	)			[inline]

Calls the augmentation module for graph G.

Returns the list of added edges in L.

Definition at line 99 of file AugmentationModule.h.

void ogdf::AugmentationModule::operator()	(	Graph &	G,
		List< edge > &	L
	)			[inline]

Calls the augmentation module for graph G.

Returns the list of added edges in L.

Definition at line 109 of file AugmentationModule.h.

int ogdf::AugmentationModule::numberOfAddedEdges

(

)

const [inline]

Returns the number of added edges.

Definition at line 112 of file AugmentationModule.h.

virtual void ogdf::AugmentationModule::doCall	(	Graph &	G,
		List< edge > &	L
	)			[protected, pure virtual]

Implements the augmentation algorithm for graph G.

Returns the list of added edges in L.

Implemented in ogdf::DfsMakeBiconnected, ogdf::PlanarAugmentation, and ogdf::PlanarAugmentationFix.

void* ogdf::AugmentationModule::operator new

(

size_t

nBytes

)

[inline]

Definition at line 127 of file AugmentationModule.h.

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

Definition at line 127 of file AugmentationModule.h.

void ogdf::AugmentationModule::operator delete

(

void *

p

)

[inline]

Definition at line 127 of file AugmentationModule.h.

---

Member Data Documentation

int ogdf::AugmentationModule::m_nAddedEdges [private]

Definition at line 125 of file AugmentationModule.h.

---

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

• ogdf/module/AugmentationModule.h

---