Common parameter functionality for ogdf::VariableEmbeddingInserter and ogdf::VariableEmbeddingInserterDyn. More...
#include <ogdf/planarity/VariableEmbeddingInserterBase.h>
Public Member Functions | |
VariableEmbeddingInserterBase () | |
Creates an instance of variable embedding edge inserter with default settings. More... | |
VariableEmbeddingInserterBase (const VariableEmbeddingInserterBase &inserter) | |
Creates an instance of variable embedding inserter with the same settings as inserter . More... | |
virtual | ~VariableEmbeddingInserterBase () |
Destructor. More... | |
VariableEmbeddingInserterBase & | operator= (const VariableEmbeddingInserterBase &inserter) |
Assignment operator. Copies option settings only. More... | |
Optional parameters | |
void | removeReinsert (RemoveReinsertType rrOption) |
Sets the remove-reinsert postprocessing method. More... | |
RemoveReinsertType | removeReinsert () const |
Returns the current setting of the remove-reinsert postprocessing method. More... | |
void | percentMostCrossed (double percent) |
Sets the option percentMostCrossed to percent . More... | |
double | percentMostCrossed () const |
Returns the current setting of option percentMostCrossed. More... | |
Public Member Functions inherited from ogdf::EdgeInsertionModule | |
EdgeInsertionModule () | |
Initializes an edge insertion module (default constructor). More... | |
EdgeInsertionModule (const EdgeInsertionModule &eim) | |
Initializes an edge insertion module (copy constructor). More... | |
virtual | ~EdgeInsertionModule () |
Destructor. More... | |
ReturnType | call (PlanRepLight &pr, const Array< edge > &origEdges) |
Inserts all edges in origEdges into pr . More... | |
ReturnType | call (PlanRepLight &pr, const EdgeArray< bool > &forbiddenOrig, const Array< edge > &origEdges) |
Inserts all edges in origEdges with given forbidden edges into pr . More... | |
ReturnType | call (PlanRepLight &pr, const EdgeArray< int > &costOrig, const Array< edge > &origEdges) |
Inserts all edges in origEdges with given costs into pr . More... | |
ReturnType | call (PlanRepLight &pr, const EdgeArray< int > &costOrig, const Array< edge > &origEdges, const EdgeArray< uint32_t > &edgeSubGraphs) |
Inserts all edges in origEdges with given costs and subgraphs (for simultaneous drawing) into pr . More... | |
ReturnType | call (PlanRepLight &pr, const EdgeArray< int > &costOrig, const EdgeArray< bool > &forbiddenOrig, const Array< edge > &origEdges) |
Inserts all edges in origEdges with given costs and forbidden edges into pr . More... | |
ReturnType | call (PlanRepLight &pr, const EdgeArray< int > &costOrig, const EdgeArray< bool > &forbiddenOrig, const Array< edge > &origEdges, const EdgeArray< uint32_t > &edgeSubGraphs) |
Inserts all edges in origEdges with given costs, forbidden edges, and subgraphs (for simultaneous drawing) into pr . More... | |
ReturnType | callEx (PlanRepLight &pr, const Array< edge > &origEdges, const EdgeArray< int > *pCostOrig=nullptr, const EdgeArray< bool > *pForbiddenOrig=nullptr, const EdgeArray< uint32_t > *pEdgeSubGraphs=nullptr) |
Inserts all edges in origEdges into pr , optionally costs, forbidden edges, and subgraphs (for simultaneous drawing) may be given. More... | |
virtual EdgeInsertionModule * | clone () const =0 |
Returns a new instance of the edge insertion module with the same option settings. 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... | |
Private Attributes | |
double | m_percentMostCrossed |
The portion of most crossed edges considered. More... | |
RemoveReinsertType | m_rrOption |
The remove-reinsert method. More... | |
int | m_runsPostprocessing |
Runs of remove-reinsert method. More... | |
Further information | |
int | runsPostprocessing () const |
Returns the number of runs performed by the remove-reinsert method after the algorithm has been called. More... | |
void | runsPostprocessing (int runs) |
Sets the number of runs performed by the remove-reinsert method. 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 Member Functions inherited from ogdf::EdgeInsertionModule | |
virtual ReturnType | doCall (PlanRepLight &pr, const Array< edge > &origEdges, const EdgeArray< int > *pCostOrig, const EdgeArray< bool > *pForbiddenOrig, const EdgeArray< uint32_t > *pEdgeSubGraphs)=0 |
Actual algorithm call that has to be implemented by derived classes. More... | |
Protected Attributes inherited from ogdf::Timeouter | |
double | m_timeLimit |
Time limit for module calls (< 0 means no limit). More... | |
Common parameter functionality for ogdf::VariableEmbeddingInserter and ogdf::VariableEmbeddingInserterDyn.
Definition at line 41 of file VariableEmbeddingInserterBase.h.
|
inline |
Creates an instance of variable embedding edge inserter with default settings.
Definition at line 44 of file VariableEmbeddingInserterBase.h.
|
inline |
Creates an instance of variable embedding inserter with the same settings as inserter
.
Definition at line 48 of file VariableEmbeddingInserterBase.h.
|
inlinevirtual |
Destructor.
Definition at line 61 of file VariableEmbeddingInserterBase.h.
|
inline |
Assignment operator. Copies option settings only.
Definition at line 54 of file VariableEmbeddingInserterBase.h.
|
inline |
Returns the current setting of option percentMostCrossed.
Definition at line 82 of file VariableEmbeddingInserterBase.h.
|
inline |
Sets the option percentMostCrossed to percent
.
This option determines the portion of most crossed edges used if the remove-reinsert method is set to RemoveReinsertType::MostCrossed. This portion is number of edges * percentMostCrossed() / 100.
Definition at line 79 of file VariableEmbeddingInserterBase.h.
|
inline |
Returns the current setting of the remove-reinsert postprocessing method.
Definition at line 72 of file VariableEmbeddingInserterBase.h.
|
inline |
Sets the remove-reinsert postprocessing method.
Definition at line 69 of file VariableEmbeddingInserterBase.h.
|
inline |
Returns the number of runs performed by the remove-reinsert method after the algorithm has been called.
Definition at line 90 of file VariableEmbeddingInserterBase.h.
|
inlineprotected |
Sets the number of runs performed by the remove-reinsert method.
Definition at line 94 of file VariableEmbeddingInserterBase.h.
|
private |
The portion of most crossed edges considered.
Definition at line 100 of file VariableEmbeddingInserterBase.h.
|
private |
The remove-reinsert method.
Definition at line 99 of file VariableEmbeddingInserterBase.h.
|
private |
Runs of remove-reinsert method.
Definition at line 102 of file VariableEmbeddingInserterBase.h.