Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::embedder::EmbedderBCTreeBase< EnableLayers, IsEmbedderMinDepth > Class Template Reference

Common base for embedder algorithms based on BC trees. More...

#include <ogdf/planarity/embedder/EmbedderBCTreeBase.h>

+ Inheritance diagram for ogdf::embedder::EmbedderBCTreeBase< EnableLayers, IsEmbedderMinDepth >:

Protected Member Functions

node initBCTree (Graph &G)
 Initializes pBCTree and returns the root node of this tree or nullptr if G is biconnected. More...
 
virtual adjEntry trivialInit (Graph &G)
 Initialization code for biconnected input. Returns an adjacency entry that lies on the external face. More...
 
- Protected Member Functions inherited from ogdf::EmbedderModule
virtual void doCall (Graph &G, adjEntry &adjExternal)=0
 Calls the embedder algorithm for graph G. More...
 

Protected Attributes

adjEntrypAdjExternal = nullptr
 an adjacency entry on the external face More...
 
BCTreepBCTree = nullptr
 BC-tree of the original graph. More...
 
- Protected Attributes inherited from ogdf::Timeouter
double m_timeLimit
 Time limit for module calls (< 0 means no limit). More...
 

Private Types

using BicompEmbedder = typename std::conditional< EnableLayers, EmbedderMaxFaceBiconnectedGraphsLayers< int >, EmbedderMaxFaceBiconnectedGraphs< int > >::type
 

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...
 
- 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...
 
- 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

template<bool EnableLayers, bool IsEmbedderMinDepth = false>
class ogdf::embedder::EmbedderBCTreeBase< EnableLayers, IsEmbedderMinDepth >

Common base for embedder algorithms based on BC trees.

Definition at line 44 of file EmbedderBCTreeBase.h.

Member Typedef Documentation

◆ BicompEmbedder

template<bool EnableLayers, bool IsEmbedderMinDepth = false>
using ogdf::embedder::EmbedderBCTreeBase< EnableLayers, IsEmbedderMinDepth >::BicompEmbedder = typename std::conditional<EnableLayers, EmbedderMaxFaceBiconnectedGraphsLayers<int>, EmbedderMaxFaceBiconnectedGraphs<int> >::type
private

Definition at line 45 of file EmbedderBCTreeBase.h.

Member Function Documentation

◆ initBCTree()

template<bool EnableLayers, bool IsEmbedderMinDepth = false>
node ogdf::embedder::EmbedderBCTreeBase< EnableLayers, IsEmbedderMinDepth >::initBCTree ( Graph G)
inlineprotected

Initializes pBCTree and returns the root node of this tree or nullptr if G is biconnected.

Definition at line 66 of file EmbedderBCTreeBase.h.

◆ trivialInit()

template<bool EnableLayers, bool IsEmbedderMinDepth = false>
virtual adjEntry ogdf::embedder::EmbedderBCTreeBase< EnableLayers, IsEmbedderMinDepth >::trivialInit ( Graph G)
inlineprotectedvirtual

Initialization code for biconnected input. Returns an adjacency entry that lies on the external face.

Reimplemented in ogdf::EmbedderMinDepthPiTa, and ogdf::EmbedderMaxFaceLayers.

Definition at line 55 of file EmbedderBCTreeBase.h.

Member Data Documentation

◆ pAdjExternal

template<bool EnableLayers, bool IsEmbedderMinDepth = false>
adjEntry* ogdf::embedder::EmbedderBCTreeBase< EnableLayers, IsEmbedderMinDepth >::pAdjExternal = nullptr
protected

an adjacency entry on the external face

Definition at line 51 of file EmbedderBCTreeBase.h.

◆ pBCTree

template<bool EnableLayers, bool IsEmbedderMinDepth = false>
BCTree* ogdf::embedder::EmbedderBCTreeBase< EnableLayers, IsEmbedderMinDepth >::pBCTree = nullptr
protected

BC-tree of the original graph.

Definition at line 48 of file EmbedderBCTreeBase.h.


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