ogdf: ogdf::CrossingMinimizationModule Class Reference


Public Member Functions
	CrossingMinimizationModule ()
	Initializes a crossing minimization module.
virtual	~CrossingMinimizationModule ()
ReturnType	call (PlanRep &PG, int cc, int &crossingNumber, const EdgeArray< int > cost=0, const EdgeArray< bool > forbid=0, const EdgeArray< unsigned int > *subgraphs=0)
	Computes a planarized representation of the input graph.
ReturnType	operator() (PlanRep &PG, int cc, int &crossingNumber, const EdgeArray< int > cost=0, const EdgeArray< bool > forbid=0, const EdgeArray< unsigned int > *const subgraphs=0)
	Computes a planarized representation of the input graph (shorthand for call).
bool	useCost () const
	Returns true iff edge costs are given.
bool	useForbid () const
	Returns true iff forbidden edges are given.
bool	useSubgraphs () const
void *	operator new (size_t nBytes)
void *	operator new (size_t, void *p)
void	operator delete (void *p)
Protected Member Functions
virtual ReturnType	doCall (PlanRep &PG, int cc, const EdgeArray< int > &cost, const EdgeArray< bool > &forbid, const EdgeArray< unsigned int > &subgraphs, int &crossingNumber)=0
	Actual algorithm call that needs to be implemented by derived classed.
Private Attributes
bool	m_useCost
	True iff edge costs are given.
bool	m_useForbid
	True iff forbidden edges are given.
bool	m_useSubgraphs

Detailed Description

Constructor & Destructor Documentation

ogdf::CrossingMinimizationModule::CrossingMinimizationModule ( ) [inline]

Initializes a crossing minimization module.

virtual ogdf::CrossingMinimizationModule::~CrossingMinimizationModule ( ) [inline, virtual]

Member Function Documentation

ReturnType ogdf::CrossingMinimizationModule::call	(	PlanRep &	PG,
		int	cc,
		int &	crossingNumber,
		const EdgeArray< int > *	cost = `0`,
		const EdgeArray< bool > *	forbid = `0`,
		const EdgeArray< unsigned int > *	subgraphs = `0`
	)			`[inline]`

Computes a planarized representation of the input graph.

Parameters:

	PG	represents the input graph as well as the computed planarized representation after the call. PG has to be initialzed as a PlanRep of the input graph and is modified to obatain the planarized representation (crossings are replaced by dummy vertices with degree four.
	cc	is the number of the connected component in PG that is considered.
	crossingNumber	is assigned the number of crossings.
	forbid	points to an edge array indicating which edges are not allowed to be crossed, i.e., (*forbid)[e] = true. If forbid = 0, no edges are forbidden.
	cost	points to an edge array that gives the cost of each edge. If cost = 0, all edges have cost 1.
	subgraphs

ReturnType ogdf::CrossingMinimizationModule::operator()	(	PlanRep &	PG,
		int	cc,
		int &	crossingNumber,
		const EdgeArray< int > *	cost = `0`,
		const EdgeArray< bool > *	forbid = `0`,
		const EdgeArray< unsigned int > *const	subgraphs = `0`
	)			`[inline]`

Computes a planarized representation of the input graph (shorthand for call).

bool ogdf::CrossingMinimizationModule::useCost ( ) const [inline]

Returns true iff edge costs are given.

bool ogdf::CrossingMinimizationModule::useForbid ( ) const [inline]

Returns true iff forbidden edges are given.

bool ogdf::CrossingMinimizationModule::useSubgraphs ( ) const [inline]

virtual ReturnType ogdf::CrossingMinimizationModule::doCall	(	PlanRep &	PG,
		int	cc,
		const EdgeArray< int > &	cost,
		const EdgeArray< bool > &	forbid,
		const EdgeArray< unsigned int > &	subgraphs,
		int &	crossingNumber
	)			`[protected, pure virtual]`

Actual algorithm call that needs to be implemented by derived classed.

Parameters:

	PG	represents the input graph as well as the computed planarized representation after the call. PG is initialzed as a PlanRep of the input graph and has to be modified so that it represents the planarized representation (crossings are replaced by dummy vertices with degree four).
	cc	is the number of the connected component in PG that is considered.
	crossingNumber	is assigned the number of crossings.
	forbid	points to an edge array indicating which edges are not allowed to be crossed, i.e., (*forbid)[e] = true.
	cost	points to an edge array that gives the cost of each edge.
	subgraphs