Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::AugmentationModule Class Referenceabstract

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

#include <ogdf/augmentation/AugmentationModule.h>

+ Inheritance diagram for ogdf::AugmentationModule:

Public Member Functions

 AugmentationModule ()
 Initializes an augmentation module. More...
 
virtual ~AugmentationModule ()
 
void call (Graph &G)
 Calls the augmentation module for graph G. More...
 
void call (Graph &G, List< edge > &L)
 Calls the augmentation module for graph G. More...
 
int numberOfAddedEdges () const
 Returns the number of added edges. More...
 
void operator() (Graph &G)
 Calls the augmentation module for graph G. More...
 
void operator() (Graph &G, List< edge > &L)
 Calls the augmentation module for graph G. More...
 

Protected Member Functions

virtual void doCall (Graph &G, List< edge > &L)=0
 Implements the augmentation algorithm for graph G. More...
 

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 53 of file AugmentationModule.h.

Constructor & Destructor Documentation

◆ AugmentationModule()

ogdf::AugmentationModule::AugmentationModule ( )
inline

Initializes an augmentation module.

Definition at line 56 of file AugmentationModule.h.

◆ ~AugmentationModule()

virtual ogdf::AugmentationModule::~AugmentationModule ( )
inlinevirtual

Definition at line 58 of file AugmentationModule.h.

Member Function Documentation

◆ call() [1/2]

void ogdf::AugmentationModule::call ( Graph G)
inline

Calls the augmentation module for graph G.

Definition at line 61 of file AugmentationModule.h.

◆ call() [2/2]

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 74 of file AugmentationModule.h.

◆ doCall()

virtual void ogdf::AugmentationModule::doCall ( Graph G,
List< edge > &  L 
)
protectedpure virtual

Implements the augmentation algorithm for graph G.

Returns the list of added edges in L.

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

◆ numberOfAddedEdges()

int ogdf::AugmentationModule::numberOfAddedEdges ( ) const
inline

Returns the number of added edges.

Definition at line 87 of file AugmentationModule.h.

◆ operator()() [1/2]

void ogdf::AugmentationModule::operator() ( Graph G)
inline

Calls the augmentation module for graph G.

Definition at line 67 of file AugmentationModule.h.

◆ operator()() [2/2]

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 84 of file AugmentationModule.h.

Member Data Documentation

◆ m_nAddedEdges

int ogdf::AugmentationModule::m_nAddedEdges
private

Definition at line 100 of file AugmentationModule.h.


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