Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::CPlanarSubgraphModule Class Referenceabstract

Interface of algorithms for the computation of c-planar subgraphs. More...

#include <ogdf/cluster/CPlanarSubgraphModule.h>

+ Inheritance diagram for ogdf::CPlanarSubgraphModule:

Public Member Functions

 CPlanarSubgraphModule ()
 Constructs a cplanar subgraph module. More...
 
virtual ~CPlanarSubgraphModule ()
 Destruction. More...
 
ReturnType call (const ClusterGraph &G, const EdgeArray< double > *pCost, List< edge > &delEdges)
 Computes set of edges delEdges, which have to be deleted in order to get a c-planar subgraph. More...
 
ReturnType call (const ClusterGraph &G, List< edge > &delEdges)
 Computes set of edges delEdges, which have to be deleted in order to get a c-planar subgraph. More...
 
- Public Member Functions inherited from ogdf::Module
 Module ()
 Initializes a module. More...
 
virtual ~Module ()
 
- Public Member Functions inherited from ogdf::Timeouter
 Timeouter ()
 timeout is turned of by default More...
 
 Timeouter (bool t)
 timeout is turned off (false) or on (true) (with 0 second) More...
 
 Timeouter (const Timeouter &t)
 
 Timeouter (double t)
 timeout is set to the given value (seconds) More...
 
 ~Timeouter ()
 
bool isTimeLimit () const
 returns whether any time limit is set or not More...
 
Timeouteroperator= (const Timeouter &t)
 
double timeLimit () const
 returns the current time limit for the call More...
 
void timeLimit (bool t)
 shorthand to turn timelimit off or on (with 0 seconds) More...
 
void timeLimit (double t)
 sets the time limit for the call (in seconds); <0 means no limit. More...
 

Protected Member Functions

virtual ReturnType doCall (const ClusterGraph &CG, const EdgeArray< double > *pCost, List< edge > &delEdges)=0
 Computes a c-planar subgraph. More...
 

Additional Inherited Members

- Public Types inherited from ogdf::Module
enum  ReturnType { ReturnType::Feasible, ReturnType::Optimal, ReturnType::NoFeasibleSolution, ReturnType::TimeoutFeasible, ReturnType::TimeoutInfeasible, ReturnType::Error }
 The return type of a module. More...
 
- Static Public Member Functions inherited from ogdf::Module
static bool isSolution (ReturnType ret)
 Returns true iff ret indicates that the module returned a feasible solution. More...
 
- Protected Attributes inherited from ogdf::Timeouter
double m_timeLimit
 Time limit for module calls (< 0 means no limit). More...
 

Detailed Description

Interface of algorithms for the computation of c-planar subgraphs.

Definition at line 42 of file CPlanarSubgraphModule.h.

Constructor & Destructor Documentation

◆ CPlanarSubgraphModule()

ogdf::CPlanarSubgraphModule::CPlanarSubgraphModule ( )
inline

Constructs a cplanar subgraph module.

Definition at line 47 of file CPlanarSubgraphModule.h.

◆ ~CPlanarSubgraphModule()

virtual ogdf::CPlanarSubgraphModule::~CPlanarSubgraphModule ( )
inlinevirtual

Destruction.

Definition at line 49 of file CPlanarSubgraphModule.h.

Member Function Documentation

◆ call() [1/2]

ReturnType ogdf::CPlanarSubgraphModule::call ( const ClusterGraph G,
const EdgeArray< double > *  pCost,
List< edge > &  delEdges 
)
inline

Computes set of edges delEdges, which have to be deleted in order to get a c-planar subgraph.

Must be implemented by derived classes.

Parameters
Gis the clustergraph.
pCostAssigns integral weight to all edges. We ask for a heavy subgraph. If set to nullptr all edges have a weight of 1.
delEdgesholds the edges not in the subgraph on return.

Definition at line 76 of file CPlanarSubgraphModule.h.

◆ call() [2/2]

ReturnType ogdf::CPlanarSubgraphModule::call ( const ClusterGraph G,
List< edge > &  delEdges 
)
inline

Computes set of edges delEdges, which have to be deleted in order to get a c-planar subgraph.

Must be implemented by derived classes.

Parameters
Gis the clustergraph.
delEdgesholds the edges not in the subgraph on return.

Definition at line 60 of file CPlanarSubgraphModule.h.

◆ doCall()

virtual ReturnType ogdf::CPlanarSubgraphModule::doCall ( const ClusterGraph CG,
const EdgeArray< double > *  pCost,
List< edge > &  delEdges 
)
protectedpure virtual

Computes a c-planar subgraph.

If delEdges is empty on return, the clustered graph G is c-planar- The actual algorithm call that must be implemented by derived classes!

Parameters
CGis the given cluster graph.
pCostAssigns integral weight to all edges. We ask for a heavy subgraph. If set to nullptr all edges have a weight of 1.
delEdgesholds the set of edges that have to be deleted.

Implemented in ogdf::MaximumCPlanarSubgraph.


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