ogdf::VariableEmbeddingInserterBase Class Reference

Common parameter functionality for ogdf::VariableEmbeddingInserter and ogdf::VariableEmbeddingInserterDyn. More...

#include <ogdf/planarity/VariableEmbeddingInserterBase.h>

Inheritance diagram for ogdf::VariableEmbeddingInserterBase:

Public Member Functions
	VariableEmbeddingInserterBase ()
	Creates an instance of variable embedding edge inserter with default settings.
	VariableEmbeddingInserterBase (const VariableEmbeddingInserterBase &inserter)
	Creates an instance of variable embedding inserter with the same settings as inserter.
virtual	~VariableEmbeddingInserterBase ()
	Destructor.
VariableEmbeddingInserterBase &	operator= (const VariableEmbeddingInserterBase &inserter)
	Assignment operator. Copies option settings only.
Optional parameters
void	removeReinsert (RemoveReinsertType rrOption)
	Sets the remove-reinsert postprocessing method.
RemoveReinsertType	removeReinsert () const
	Returns the current setting of the remove-reinsert postprocessing method.
void	percentMostCrossed (double percent)
	Sets the option percentMostCrossed to percent.
double	percentMostCrossed () const
	Returns the current setting of option percentMostCrossed.
Public Member Functions inherited from ogdf::EdgeInsertionModule
	EdgeInsertionModule ()
	Initializes an edge insertion module (default constructor).
	EdgeInsertionModule (const EdgeInsertionModule &eim)
	Initializes an edge insertion module (copy constructor).
virtual	~EdgeInsertionModule ()
	Destructor.
ReturnType	call (PlanRepLight &pr, const Array< edge > &origEdges)
	Inserts all edges in origEdges into pr.
ReturnType	call (PlanRepLight &pr, const EdgeArray< bool > &forbiddenOrig, const Array< edge > &origEdges)
	Inserts all edges in origEdges with given forbidden edges into pr.
ReturnType	call (PlanRepLight &pr, const EdgeArray< int > &costOrig, const Array< edge > &origEdges)
	Inserts all edges in origEdges with given costs into pr.
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.
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.
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.
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.
virtual EdgeInsertionModule *	clone () const =0
	Returns a new instance of the edge insertion module with the same option settings.
Public Member Functions inherited from ogdf::Module
	Module ()
	Initializes a module.
virtual	~Module ()
Public Member Functions inherited from ogdf::Timeouter
	Timeouter ()
	timeout is turned of by default
	Timeouter (bool t)
	timeout is turned off (false) or on (true) (with 0 second)
	Timeouter (const Timeouter &t)
	Timeouter (double t)
	timeout is set to the given value (seconds)
	~Timeouter ()
bool	isTimeLimit () const
	returns whether any time limit is set or not
Timeouter &	operator= (const Timeouter &t)
double	timeLimit () const
	returns the current time limit for the call
void	timeLimit (bool t)
	shorthand to turn timelimit off or on (with 0 seconds)
void	timeLimit (double t)
	sets the time limit for the call (in seconds); <0 means no limit.

Private Attributes
double	m_percentMostCrossed
	The portion of most crossed edges considered.
RemoveReinsertType	m_rrOption
	The remove-reinsert method.
int	m_runsPostprocessing
	Runs of remove-reinsert method.

Further information
int	runsPostprocessing () const
	Returns the number of runs performed by the remove-reinsert method after the algorithm has been called.
void	runsPostprocessing (int runs)
	Sets the number of runs performed by the remove-reinsert method.

Additional Inherited Members
Public Types inherited from ogdf::Module
enum class	ReturnType { Feasible , Optimal , NoFeasibleSolution , TimeoutFeasible , TimeoutInfeasible , 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.
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.
Protected Attributes inherited from ogdf::Timeouter
double	m_timeLimit
	Time limit for module calls (< 0 means no limit).

Detailed Description

Common parameter functionality for ogdf::VariableEmbeddingInserter and ogdf::VariableEmbeddingInserterDyn.

Definition at line 41 of file VariableEmbeddingInserterBase.h.

Constructor & Destructor Documentation

VariableEmbeddingInserterBase() [1/2]

ogdf::VariableEmbeddingInserterBase::VariableEmbeddingInserterBase ( )

inline

Creates an instance of variable embedding edge inserter with default settings.

Definition at line 44 of file VariableEmbeddingInserterBase.h.

VariableEmbeddingInserterBase() [2/2]

ogdf::VariableEmbeddingInserterBase::VariableEmbeddingInserterBase ( const VariableEmbeddingInserterBase &  inserter )

inline

Creates an instance of variable embedding inserter with the same settings as inserter.

Definition at line 48 of file VariableEmbeddingInserterBase.h.

~VariableEmbeddingInserterBase()

virtual ogdf::VariableEmbeddingInserterBase::~VariableEmbeddingInserterBase ( )

inlinevirtual

Destructor.

Definition at line 61 of file VariableEmbeddingInserterBase.h.

Member Function Documentation

operator=()

VariableEmbeddingInserterBase & ogdf::VariableEmbeddingInserterBase::operator= ( const VariableEmbeddingInserterBase &  inserter )

inline

Assignment operator. Copies option settings only.

Definition at line 54 of file VariableEmbeddingInserterBase.h.

percentMostCrossed() [1/2]

double ogdf::VariableEmbeddingInserterBase::percentMostCrossed ( ) const

inline

Returns the current setting of option percentMostCrossed.

Definition at line 82 of file VariableEmbeddingInserterBase.h.

percentMostCrossed() [2/2]

void ogdf::VariableEmbeddingInserterBase::percentMostCrossed ( double  percent )

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.

removeReinsert() [1/2]

RemoveReinsertType ogdf::VariableEmbeddingInserterBase::removeReinsert ( ) const

inline

Returns the current setting of the remove-reinsert postprocessing method.

Definition at line 72 of file VariableEmbeddingInserterBase.h.

removeReinsert() [2/2]

void ogdf::VariableEmbeddingInserterBase::removeReinsert ( RemoveReinsertType  rrOption )

inline

Sets the remove-reinsert postprocessing method.

Definition at line 69 of file VariableEmbeddingInserterBase.h.

runsPostprocessing() [1/2]

int ogdf::VariableEmbeddingInserterBase::runsPostprocessing ( ) const

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.

runsPostprocessing() [2/2]

void ogdf::VariableEmbeddingInserterBase::runsPostprocessing ( int  runs )

inlineprotected

Sets the number of runs performed by the remove-reinsert method.

Definition at line 94 of file VariableEmbeddingInserterBase.h.

Member Data Documentation

m_percentMostCrossed

double ogdf::VariableEmbeddingInserterBase::m_percentMostCrossed

private

The portion of most crossed edges considered.

Definition at line 100 of file VariableEmbeddingInserterBase.h.

m_rrOption

RemoveReinsertType ogdf::VariableEmbeddingInserterBase::m_rrOption

private

The remove-reinsert method.

Definition at line 99 of file VariableEmbeddingInserterBase.h.

m_runsPostprocessing

int ogdf::VariableEmbeddingInserterBase::m_runsPostprocessing

private

Runs of remove-reinsert method.

Definition at line 102 of file VariableEmbeddingInserterBase.h.

---

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

• include/ogdf/planarity/VariableEmbeddingInserterBase.h