Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::PlanarSubgraphModule< TCost > Class Template Referenceabstract

Interface for planar subgraph algorithms. More...

#include <ogdf/planarity/PlanarSubgraphModule.h>

+ Inheritance diagram for ogdf::PlanarSubgraphModule< TCost >:

Public Member Functions

 PlanarSubgraphModule ()
 Initializes a planar subgraph module (default constructor). More...
 
ReturnType call (const Graph &G, const EdgeArray< TCost > &cost, const List< edge > &preferredEdges, List< edge > &delEdges, bool preferredImplyPlanar=false)
 Returns the set of edges delEdges which have to be deleted to obtain the planar subgraph. More...
 
ReturnType call (const Graph &G, const EdgeArray< TCost > &cost, List< edge > &delEdges)
 Returns the set of edges delEdges which have to be deleted to obtain the planar subgraph. More...
 
ReturnType call (const Graph &G, const List< edge > &preferredEdges, List< edge > &delEdges, bool preferredImplyPlanar=false)
 Returns the set of edges delEdges which have to be deleted to obtain the planar subgraph. More...
 
ReturnType call (const Graph &G, List< edge > &delEdges)
 Returns the set of edges delEdges which have to be deleted to obtain the planar subgraph. More...
 
ReturnType callAndDelete (GraphCopy &GC, const List< edge > &preferredEdges, List< edge > &delOrigEdges, bool preferredImplyPlanar=false)
 Makes GC planar by deleting edges. More...
 
ReturnType callAndDelete (GraphCopy &GC, List< edge > &delOrigEdges)
 Makes G planar by deleting edges. More...
 
virtual PlanarSubgraphModuleclone () const =0
 Returns a new instance of the planar subgraph module with the same option settings. More...
 
unsigned int maxThreads () const
 Returns the maximal number of used threads. More...
 
void maxThreads (unsigned int n)
 Sets the maximal number of used threads to n. More...
 
ReturnType operator() (const Graph &G, const List< edge > &preferredEdges, List< edge > &delEdges, bool preferredImplyPlanar=false)
 Returns the set of edges delEdges which have to be deleted to obtain the planar subgraph. More...
 
ReturnType operator() (const Graph &G, List< edge > &delEdges)
 Returns the set of edges delEdges which have to be deleted to obtain the 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 Graph &G, const List< edge > &preferredEdges, List< edge > &delEdges, const EdgeArray< TCost > *pCost=nullptr, bool preferredImplyPlanar=false)=0
 Computes the set of edges delEdges which have to be deleted to obtain the planar subgraph. More...
 

Private Attributes

unsigned int m_maxThreads
 The maximal number of used threads. 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

template<typename TCost>
class ogdf::PlanarSubgraphModule< TCost >

Interface for planar subgraph algorithms.

See also
PlanarizationLayout, PlanarizationGridLayout

Definition at line 49 of file PlanarSubgraphModule.h.

Constructor & Destructor Documentation

◆ PlanarSubgraphModule()

template<typename TCost >
ogdf::PlanarSubgraphModule< TCost >::PlanarSubgraphModule ( )
inline

Initializes a planar subgraph module (default constructor).

Definition at line 55 of file PlanarSubgraphModule.h.

Member Function Documentation

◆ call() [1/4]

template<typename TCost >
ReturnType ogdf::PlanarSubgraphModule< TCost >::call ( const Graph G,
const EdgeArray< TCost > &  cost,
const List< edge > &  preferredEdges,
List< edge > &  delEdges,
bool  preferredImplyPlanar = false 
)
inline

Returns the set of edges delEdges which have to be deleted to obtain the planar subgraph.

Parameters
Gis the input graph.
costare the costs of edges.
preferredEdgesare edges that should be contained in the planar subgraph.
delEdgesis the set of edges that need to be deleted to obtain the planar subgraph.
preferredImplyPlanarindicates that the edges preferredEdges induce a planar graph.

Definition at line 72 of file PlanarSubgraphModule.h.

◆ call() [2/4]

template<typename TCost >
ReturnType ogdf::PlanarSubgraphModule< TCost >::call ( const Graph G,
const EdgeArray< TCost > &  cost,
List< edge > &  delEdges 
)
inline

Returns the set of edges delEdges which have to be deleted to obtain the planar subgraph.

Parameters
Gis the input graph.
costare the costs of edges.
delEdgesis the set of edges that need to be deleted to obtain the planar subgraph.

Definition at line 104 of file PlanarSubgraphModule.h.

◆ call() [3/4]

template<typename TCost >
ReturnType ogdf::PlanarSubgraphModule< TCost >::call ( const Graph G,
const List< edge > &  preferredEdges,
List< edge > &  delEdges,
bool  preferredImplyPlanar = false 
)
inline

Returns the set of edges delEdges which have to be deleted to obtain the planar subgraph.

Parameters
Gis the input graph.
preferredEdgesare edges that should be contained in the planar subgraph.
delEdgesis the set of edges that need to be deleted to obtain the planar subgraph.
preferredImplyPlanarindicates that the edges preferredEdges induce a planar graph.

Definition at line 89 of file PlanarSubgraphModule.h.

◆ call() [4/4]

template<typename TCost >
ReturnType ogdf::PlanarSubgraphModule< TCost >::call ( const Graph G,
List< edge > &  delEdges 
)
inline

Returns the set of edges delEdges which have to be deleted to obtain the planar subgraph.

Parameters
Gis the input graph.
delEdgesis the set of edges that need to be deleted to obtain the planar subgraph.

Definition at line 114 of file PlanarSubgraphModule.h.

◆ callAndDelete() [1/2]

template<typename TCost >
ReturnType ogdf::PlanarSubgraphModule< TCost >::callAndDelete ( GraphCopy GC,
const List< edge > &  preferredEdges,
List< edge > &  delOrigEdges,
bool  preferredImplyPlanar = false 
)
inline

Makes GC planar by deleting edges.

Parameters
GCis a copy of the input graph.
preferredEdgesare edges in GC that should be contained in the planar subgraph.
delOrigEdgesis the set of original edges whose copy has been deleted in GC.
preferredImplyPlanarindicates that the edges preferredEdges induce a planar graph.

Definition at line 142 of file PlanarSubgraphModule.h.

◆ callAndDelete() [2/2]

template<typename TCost >
ReturnType ogdf::PlanarSubgraphModule< TCost >::callAndDelete ( GraphCopy GC,
List< edge > &  delOrigEdges 
)
inline

Makes G planar by deleting edges.

Parameters
GCis a copy of the input graph.
delOrigEdgesis the set of original edges whose copy has been deleted in GC.

Definition at line 163 of file PlanarSubgraphModule.h.

◆ clone()

◆ doCall()

template<typename TCost >
virtual ReturnType ogdf::PlanarSubgraphModule< TCost >::doCall ( const Graph G,
const List< edge > &  preferredEdges,
List< edge > &  delEdges,
const EdgeArray< TCost > *  pCost = nullptr,
bool  preferredImplyPlanar = false 
)
protectedpure virtual

Computes the set of edges delEdges which have to be deleted to obtain the planar subgraph.

This is the actual algorithm call and needs to be implemented by derived classes.

Parameters
Gis the input graph.
preferredEdgesare edges that should be contained in the planar subgraph.
delEdgesis the set of edges that need to be deleted to obtain the planar subgraph.
pCostis apointer to an edge array containing the edge costs; this pointer can be 0 if no costs are given (all edges have cost 1).
preferredImplyPlanarindicates that the edges preferredEdges induce a planar graph.

Implemented in ogdf::MaximalPlanarSubgraphSimple< TCost, typename std::enable_if< std::is_floating_point< TCost >::value >::type >, ogdf::MaximalPlanarSubgraphSimple< TCost, typename std::enable_if< std::is_integral< TCost >::value >::type >, ogdf::PlanarSubgraphTree< TCost >, ogdf::PlanarSubgraphEmpty< TCost >, ogdf::PlanarSubgraphBoyerMyrvold, ogdf::PlanarSubgraphTriangles< TCost >, ogdf::MaximumPlanarSubgraph< TCost >, and ogdf::PlanarSubgraphFast< TCost >.

◆ maxThreads() [1/2]

template<typename TCost >
unsigned int ogdf::PlanarSubgraphModule< TCost >::maxThreads ( ) const
inline

Returns the maximal number of used threads.

Definition at line 172 of file PlanarSubgraphModule.h.

◆ maxThreads() [2/2]

template<typename TCost >
void ogdf::PlanarSubgraphModule< TCost >::maxThreads ( unsigned int  n)
inline

Sets the maximal number of used threads to n.

Definition at line 175 of file PlanarSubgraphModule.h.

◆ operator()() [1/2]

template<typename TCost >
ReturnType ogdf::PlanarSubgraphModule< TCost >::operator() ( const Graph G,
const List< edge > &  preferredEdges,
List< edge > &  delEdges,
bool  preferredImplyPlanar = false 
)
inline

Returns the set of edges delEdges which have to be deleted to obtain the planar subgraph.

Definition at line 121 of file PlanarSubgraphModule.h.

◆ operator()() [2/2]

template<typename TCost >
ReturnType ogdf::PlanarSubgraphModule< TCost >::operator() ( const Graph G,
List< edge > &  delEdges 
)
inline

Returns the set of edges delEdges which have to be deleted to obtain the planar subgraph.

Definition at line 130 of file PlanarSubgraphModule.h.

Member Data Documentation

◆ m_maxThreads

template<typename TCost >
unsigned int ogdf::PlanarSubgraphModule< TCost >::m_maxThreads
private

The maximal number of used threads.

Definition at line 51 of file PlanarSubgraphModule.h.


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