ogdf::UpwardEdgeInserterModule Class Reference

#include <ogdf/upward/UpwardEdgeInserterModule.h>

Inheritance diagram for ogdf::UpwardEdgeInserterModule:

Public Member Functions
	UpwardEdgeInserterModule ()
	Initializes an edge insertion module. More...
virtual	~UpwardEdgeInserterModule ()
ReturnType	call (UpwardPlanRep &UPR, const EdgeArray< bool > &forbidOriginal, const List< edge > &origEdges)
	Inserts all edges in origEdges with given forbidden edges into UPR. More...
ReturnType	call (UpwardPlanRep &UPR, const EdgeArray< int > &costOrig, const EdgeArray< bool > &forbidOriginal, const List< edge > &origEdges)
	Inserts all edges in origEdges with given forbidden edges into UPR. More...
ReturnType	call (UpwardPlanRep &UPR, const EdgeArray< int > &costOrig, const List< edge > &origEdges)
	Inserts all edges in origEdges with given costs into UPR. More...
ReturnType	call (UpwardPlanRep &UPR, const List< edge > &origEdges)
	Inserts all edges in origEdges into UPR. More...
Public Member Functions inherited from ogdf::Module
	Module ()
	Initializes a module. More...
virtual	~Module ()

Protected Member Functions
virtual ReturnType	doCall (UpwardPlanRep &UPR, const List< edge > &origEdges, const EdgeArray< int > *costOrig, const EdgeArray< bool > *forbiddenEdgeOrig)=0
	Actual algorithm call that has to be implemented by derived classes. 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...

Detailed Description

Definition at line 44 of file UpwardEdgeInserterModule.h.

Constructor & Destructor Documentation

UpwardEdgeInserterModule()

ogdf::UpwardEdgeInserterModule::UpwardEdgeInserterModule ( )

inline

Initializes an edge insertion module.

Definition at line 47 of file UpwardEdgeInserterModule.h.

~UpwardEdgeInserterModule()

virtual ogdf::UpwardEdgeInserterModule::~UpwardEdgeInserterModule ( )

inlinevirtual

Definition at line 50 of file UpwardEdgeInserterModule.h.

Member Function Documentation

call() [1/4]

ReturnType ogdf::UpwardEdgeInserterModule::call ( UpwardPlanRep &  UPR, const EdgeArray< bool > &  forbidOriginal, const List< edge > &  origEdges  )

inline

Inserts all edges in origEdges with given forbidden edges into UPR.

Precondition

No forbidden edge may be in origEdges.

Parameters

UPR	is the input upward planarized representation of a FUPS and will also receive the result.
forbidOriginal	points to an edge array indicating if an original edge is forbidden to be crossed.
origEdges	is the list of original edges (edges in the original graph of UPR) that have to be inserted.

Returns

the status of the result.

Definition at line 106 of file UpwardEdgeInserterModule.h.

call() [2/4]

ReturnType ogdf::UpwardEdgeInserterModule::call ( UpwardPlanRep &  UPR, const EdgeArray< int > &  costOrig, const EdgeArray< bool > &  forbidOriginal, const List< edge > &  origEdges  )

inline

Inserts all edges in origEdges with given forbidden edges into UPR.

Parameters

UPR	is the input upward planarized representation of a FUPS and will also receive the result.
costOrig	points to an edge array containing the costs of original edges; edges in UPR without an original edge have zero costs.
forbidOriginal	points to an edge array indicating if an original edge is forbidden to be crossed.
origEdges	is the list of original edges (edges in the original graph of UPR) that have to be inserted.

Definition at line 89 of file UpwardEdgeInserterModule.h.

call() [3/4]

ReturnType ogdf::UpwardEdgeInserterModule::call ( UpwardPlanRep &  UPR, const EdgeArray< int > &  costOrig, const List< edge > &  origEdges  )

inline

Inserts all edges in origEdges with given costs into UPR.

Parameters

UPR	is the input upward planarized representation of a FUPS and will also receive the result.
costOrig	points to an edge array containing the costs of original edges; edges in UPR without an original edge have zero costs.
origEdges	is the list of original edges (edges in the original graph of UPR) that have to be inserted.

Returns

the status of the result.

Definition at line 74 of file UpwardEdgeInserterModule.h.

call() [4/4]

ReturnType ogdf::UpwardEdgeInserterModule::call ( UpwardPlanRep &  UPR, const List< edge > &  origEdges  )

inline

Inserts all edges in origEdges into UPR.

Parameters

UPR	is the input upward planarized representation of a FUPS and will also receive the result.
origEdges	is the list of original edges (edges in the original graph of UPR) that have to be inserted.

Returns

the status of the result.

Definition at line 60 of file UpwardEdgeInserterModule.h.

doCall()

virtual ReturnType ogdf::UpwardEdgeInserterModule::doCall ( UpwardPlanRep &  UPR, const List< edge > &  origEdges, const EdgeArray< int > *  costOrig, const EdgeArray< bool > *  forbiddenEdgeOrig  )

protectedpure virtual

Actual algorithm call that has to be implemented by derived classes.

Parameters

UPR	is the input upward planarized representation of a FUPS and will also receive the result.
origEdges	is the list of original edges (edges in the original graph of UPR) that have to be inserted.
costOrig	points to an edge array containing the costs of original edges; edges in UPR without an original edge have zero costs.
forbiddenEdgeOrig	points to an edge array indicating if an original edge is forbidden to be crossed.

Implemented in ogdf::FixedEmbeddingUpwardEdgeInserter.

---

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

• include/ogdf/upward/UpwardEdgeInserterModule.h