Base class for embedder algorithms. More...
#include <ogdf/planarity/EmbedderModule.h>
Public Member Functions | |
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... | |
Timeouter & | operator= (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 void | doCall (Graph &G, adjEntry &adjExternal)=0 |
Calls the embedder algorithm for graph G . 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... | |
Base class for embedder algorithms.
An embedder algorithm computes a planar embedding of a planar graph. Usually, such an algorithm optimizes some properties of the embedding. for example, it might maximize the number of nodes incident with the outer face.
Definition at line 52 of file EmbedderModule.h.
|
inline |
Initializes an embedder module.
Definition at line 55 of file EmbedderModule.h.
|
inlinevirtual |
Definition at line 57 of file EmbedderModule.h.
Calls the embedder algorithm for graph G
.
G
is planar. G | is the graph that shall be embedded. |
adjExternal | is set (by the algorithm) to an adjacency entry on the external face of G . |
Definition at line 66 of file EmbedderModule.h.
|
protectedpure virtual |
Calls the embedder algorithm for graph G
.
G
is guaranteed to be planar. See call .
Implemented in ogdf::EmbedderMinDepthPiTa, ogdf::EmbedderMaxFace, ogdf::SimpleEmbedder, ogdf::EmbedderMinDepth, ogdf::EmbedderMinDepthMaxFace, and ogdf::EmbedderOptimalFlexDraw.
Calls the embedder algorithm for graph G
.
Definition at line 76 of file EmbedderModule.h.