Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::FUPSModule Class Referenceabstract

Interface for feasible upward planar subgraph algorithms. More...

#include <ogdf/upward/FUPSModule.h>

+ Inheritance diagram for ogdf::FUPSModule:

Public Member Functions

 FUPSModule ()
 Initializes a feasible upward planar subgraph module. More...
 
virtual ~FUPSModule ()
 
ReturnType call (UpwardPlanRep &UPR, List< edge > &delEdges)
 Computes a feasible upward planar subgraph of the input graph. More...
 
ReturnType operator() (UpwardPlanRep &UPR, List< edge > &delEdges)
 Computes a upward planarized representation of the input graph (shorthand for call) More...
 
- Public Member Functions inherited from ogdf::Module
 Module ()
 Initializes a module. More...
 
virtual ~Module ()
 

Protected Member Functions

virtual ReturnType doCall (UpwardPlanRep &UPR, List< edge > &delEdges)=0
 Computes a feasible upward planar subgraph of the input graph. 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...
 

Detailed Description

Interface for feasible upward planar subgraph algorithms.

Definition at line 43 of file FUPSModule.h.

Constructor & Destructor Documentation

◆ FUPSModule()

ogdf::FUPSModule::FUPSModule ( )
inline

Initializes a feasible upward planar subgraph module.

Definition at line 49 of file FUPSModule.h.

◆ ~FUPSModule()

virtual ogdf::FUPSModule::~FUPSModule ( )
inlinevirtual

Definition at line 52 of file FUPSModule.h.

Member Function Documentation

◆ call()

ReturnType ogdf::FUPSModule::call ( UpwardPlanRep UPR,
List< edge > &  delEdges 
)
inline

Computes a feasible upward planar subgraph of the input graph.

Parameters
UPRrepresents the feasible upward planar subgraph after the call. UPR has to be initialzed as a UpwardPlanRep of the input graph G and is modified. The subgraph is represented as an upward planar representation.
delEdgesis the list of deleted edges which are deleted from the input graph in order to obtain the subgraph. The edges are edges of the original graph of UPR.
Returns
the status of the result.

Definition at line 64 of file FUPSModule.h.

◆ doCall()

virtual ReturnType ogdf::FUPSModule::doCall ( UpwardPlanRep UPR,
List< edge > &  delEdges 
)
protectedpure virtual

Computes a feasible upward planar subgraph of the input graph.

Parameters
UPRrepresents the feasible upward planar subgraph after the call. UPR has to be initialzed as a UpwardPlanRep of the input graph G and is modified. The subgraph is represented as an upward planar representation.
delEdgesis the list of deleted edges which are deleted from the input graph in order to obtain the subgraph. The edges are edges of the original graph G.
Returns
the status of the result.

Implemented in ogdf::FUPSSimple, and ogdf::MaximalFUPS.

◆ operator()()

ReturnType ogdf::FUPSModule::operator() ( UpwardPlanRep UPR,
List< edge > &  delEdges 
)
inline

Computes a upward planarized representation of the input graph (shorthand for call)

Definition at line 71 of file FUPSModule.h.


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