Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::SimpleEmbedder Class Reference

Embedder that chooses a largest face as the external one. More...

#include <ogdf/planarity/SimpleEmbedder.h>

+ Inheritance diagram for ogdf::SimpleEmbedder:

Public Member Functions

 SimpleEmbedder ()
 
 ~SimpleEmbedder ()
 
virtual void doCall (Graph &G, adjEntry &adjExternal) override
 Call embedder algorithm. More...
 
- Public Member Functions inherited from ogdf::EmbedderModule
 EmbedderModule ()
 Initializes an embedder module. More...
 
virtual ~EmbedderModule ()
 
void call (Graph &G, adjEntry &adjExternal)
 Calls the embedder algorithm for graph G. More...
 
void operator() (Graph &G, adjEntry &adjExternal)
 Calls the embedder algorithm for graph G. 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...
 

Private Member Functions

face findBestExternalFace (const PlanRep &PG, const CombinatorialEmbedding &E)
 Find best suited external face according to certain criteria. 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

Embedder that chooses a largest face as the external one.

Uses ogdf::planarEmbed() to compute an embedding.

Definition at line 47 of file SimpleEmbedder.h.

Constructor & Destructor Documentation

◆ SimpleEmbedder()

ogdf::SimpleEmbedder::SimpleEmbedder ( )
inline

Definition at line 51 of file SimpleEmbedder.h.

◆ ~SimpleEmbedder()

ogdf::SimpleEmbedder::~SimpleEmbedder ( )
inline

Definition at line 52 of file SimpleEmbedder.h.

Member Function Documentation

◆ doCall()

virtual void ogdf::SimpleEmbedder::doCall ( Graph G,
adjEntry adjExternal 
)
overridevirtual

Call embedder algorithm.

Parameters
Gis the original graph. Its adjacency list is changed by the embedder.
adjExternalis an adjacency entry on the external face and is set by the embedder.

Implements ogdf::EmbedderModule.

◆ findBestExternalFace()

face ogdf::SimpleEmbedder::findBestExternalFace ( const PlanRep PG,
const CombinatorialEmbedding E 
)
private

Find best suited external face according to certain criteria.

Parameters
PGis a planar representation of the original graph.
Eis a combinatorial embedding of the original graph.
Returns
Best suited external face.

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