#include <ogdf/cluster/internal/EdgeVar.h>

Inheritance diagram for ogdf::cluster_planarity::EdgeVar:

Public Types
enum	EdgeType { EdgeType::Original, EdgeType::Connect }

Public Member Functions
	EdgeVar (abacus::Master *master, double obj, double lbound, node source, node target)
	Simple version for cplanarity testing (only connect edges allowed, lower bound given) More...

	EdgeVar (abacus::Master *master, double obj, EdgeType eType, node source, node target)

	EdgeVar (abacus::Master *master, double obj, node source, node target)
	Simple version for cplanarity testing (only connect edges allowed) More...

virtual	~EdgeVar ()

virtual void	printMe (std::ostream &out)

node	sourceNode () const

node	targetNode () const

edge	theEdge () const

EdgeType	theEdgeType () const

Public Member Functions inherited from abacus::Variable
	Variable (Master master, const Sub sub, bool dynamic, bool local, double obj, double lBound, double uBound, VarType::TYPE type)
	Initializes a variable. More...

virtual	~Variable ()

bool	binary () const
	Returns true If the type of the variable is Binary, false otherwise. More...

virtual double	coeff (const Constraint *con) const
	Computes the coefficient of the variable in the constraint con. More...

bool	discrete () const
	Returns true if the type of the variable is Integer or Binary, false otherwise. More...

FSVarStat *	fsVarStat ()

const FSVarStat *	fsVarStat () const

virtual int	genColumn (Active< Constraint, Variable > *actCon, Column &col) const
	Computes the column col of the variable associated with the active constraints *actCon. More...

bool	integer () const
	Returns true If the type of the variable is Integer, false otherwise. More...

double	lBound () const
	Returns the lower bound of the variable. More...

void	lBound (double newBound)
	Sets the lower bound of the variable to newBound. More...

virtual double	obj () const
	Returns the objective function coefficient. More...

void	printCol (std::ostream &out, Active< Constraint, Variable > *constraints) const
	Writes the column of the variable corresponding to the constraints to output stream out. More...

virtual double	redCost (Active< Constraint, Variable > actCon, double y) const
	Computes the reduced cost of the variable corresponding the constraint set actCon and the dual variables y. More...

double	uBound () const
	Returns the upper bound of the variable. More...

void	uBound (double newBound)
	Sets the upper bound of the variable to newBound. More...

virtual bool	useful (Active< Constraint, Variable > actCon, double y, double lpVal) const
	Returns whether an (inactive) discrete variable is useful. More...

virtual bool	valid (const Sub *sub) const
	Returns true if the variable is valid, false otherwise. More...

VarType::TYPE	varType () const
	Returns the type of the variable. More...

virtual bool	violated (Active< Constraint, Variable > constraints, double y, double *slack=nullptr) const
	Checks, if a variable does not price out correctly. More...

virtual bool	violated (double rc) const
	Checks, if a variable does not price out correctly. More...

Public Member Functions inherited from abacus::ConVar
	ConVar (Master master, const Sub sub, bool dynamic, bool local)
	Creates an instance of type ConVar. More...

virtual	~ConVar ()

bool	active () const
	Checks if the constraint/variable is active in at least one active subproblem. More...

virtual bool	dynamic () const
	Return true if the constraint/variable is dynamic. More...

virtual bool	equal (const ConVar *cv) const
	Should compare if the constraint/variable is identical (in a mathematical sense) with the constraint/variable cv. More...

bool	global () const
	Returns true if the constraint/variable is globally valid, false otherwise. More...

virtual unsigned	hashKey () const
	Should provide a key for the constraint/variable that can be used to insert it into a hash table. More...

bool	local () const
	Returns true if the constraint/variable is only locally valid, false otherwise. More...

virtual const char *	name () const
	Should return the name of the constraint/variable. More...

virtual void	print (std::ostream &out) const
	Writes the constraint/variable to the output stream out. More...

virtual double	rank () const
	The function should return a rank associated with the constraint/variable. More...

const Sub *	sub () const
	Returns a const pointer to the subproblem associated with the constraint/variable. More...

void	sub (Sub *sub)
	Associates a new subproblem with the constraint/variable. More...

bool	expanded () const
	Returns true if the expanded format of a constraint/variable is available, false otherwise. More...

virtual void	expand () const
	Expands a constraint/variable. More...

virtual void	compress () const
	Compresses a constraint/variable. More...

virtual bool	deletable () const
	Returns true if the constraint/variable can be destructed. More...

Public Member Functions inherited from abacus::AbacusRoot
virtual	~AbacusRoot ()
	The destructor. More...

Private Attributes
edge	m_edge

EdgeType	m_eType

node	m_source

node	m_target

Friends
class	MaxCPlanarSub

Additional Inherited Members
Static Public Member Functions inherited from abacus::AbacusRoot
static bool	ascii2bool (const string &str)
	Converts the string str to a boolean value. More...

static bool	endsWith (const string &str, const string &end)
	Returns true if str ends with end, false otherwise. More...

static double	fracPart (double x)
	Returns the absolute value of the fractional part of x. More...

static const char *	onOff (bool value)
	Converts a boolean variable to the strings "on" and "off". More...

Protected Attributes inherited from abacus::Variable
FSVarStat	fsVarStat_
	The global status of fixing and setting of the variable. More...

double	lBound_
	The lower bound of the variable. More...

double	obj_
	The objective function coefficient of the variable. More...

VarType	type_
	The type of the variable. More...

double	uBound_
	The upper bound of the variable. More...

Protected Attributes inherited from abacus::ConVar
bool	dynamic_
	If this member is true then the constraint/variable can be also removed from the active formulation after it is added the first time. More...

bool	expanded_
	true, if expanded version of constraint/variables available. More...

bool	local_
	true if the constraint/variable is only locally valid More...

Master *	master_
	A pointer to the corresponding master of the optimization. More...

int	nActive_
	The number of active subproblems of which the constraint/variable belongs to the set of active constraints/variables. More...

int	nLocks_
	The number of locks which have been set on the constraint/variable. More...

int	nReferences_
	The number of references to the pool slot the constraint is stored in. More...

const Sub *	sub_
	A pointer to the subproblem associated with the constraint/variable. More...

Detailed Description

Definition at line 45 of file EdgeVar.h.

Member Enumeration Documentation

◆ EdgeType

enum ogdf::cluster_planarity::EdgeVar::EdgeType

strong

Enumerator
Original
Connect

Definition at line 49 of file EdgeVar.h.

Constructor & Destructor Documentation

◆ EdgeVar() [1/3]

ogdf::cluster_planarity::EdgeVar::EdgeVar	(	abacus::Master *	master,
		double	obj,
		EdgeType	eType,
		node	source,
		node	target
	)

◆ EdgeVar() [2/3]

ogdf::cluster_planarity::EdgeVar::EdgeVar	(	abacus::Master *	master,
		double	obj,
		node	source,
		node	target
	)

Simple version for cplanarity testing (only connect edges allowed)

◆ EdgeVar() [3/3]

ogdf::cluster_planarity::EdgeVar::EdgeVar	(	abacus::Master *	master,
		double	obj,
		double	lbound,
		node	source,
		node	target
	)

Simple version for cplanarity testing (only connect edges allowed, lower bound given)

◆ ~EdgeVar()

virtual ogdf::cluster_planarity::EdgeVar::~EdgeVar ( )

virtual

Member Function Documentation

◆ printMe()

virtual void ogdf::cluster_planarity::EdgeVar::printMe ( std::ostream & out )

inlinevirtual

Reimplemented in ogdf::cluster_planarity::CPlanarEdgeVar.

Definition at line 70 of file EdgeVar.h.

◆ sourceNode()

node ogdf::cluster_planarity::EdgeVar::sourceNode ( ) const

inline

Definition at line 61 of file EdgeVar.h.

◆ targetNode()

node ogdf::cluster_planarity::EdgeVar::targetNode ( ) const

inline

Definition at line 63 of file EdgeVar.h.

◆ theEdge()

edge ogdf::cluster_planarity::EdgeVar::theEdge ( ) const

inline

Definition at line 59 of file EdgeVar.h.

◆ theEdgeType()

EdgeType ogdf::cluster_planarity::EdgeVar::theEdgeType ( ) const

inline

Definition at line 65 of file EdgeVar.h.

Friends And Related Function Documentation

◆ MaxCPlanarSub

friend class MaxCPlanarSub

friend

Definition at line 46 of file EdgeVar.h.

Member Data Documentation

◆ m_edge

edge ogdf::cluster_planarity::EdgeVar::m_edge

private

Definition at line 83 of file EdgeVar.h.

◆ m_eType

EdgeType ogdf::cluster_planarity::EdgeVar::m_eType

private

Definition at line 78 of file EdgeVar.h.

◆ m_source

node ogdf::cluster_planarity::EdgeVar::m_source

private

Definition at line 81 of file EdgeVar.h.

◆ m_target

node ogdf::cluster_planarity::EdgeVar::m_target

private

Definition at line 82 of file EdgeVar.h.

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

include/ogdf/cluster/internal/EdgeVar.h

OpenGraph DrawingFramework

Public Types

Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ EdgeType

Constructor & Destructor Documentation

◆ EdgeVar() [1/3]

◆ EdgeVar() [2/3]

◆ EdgeVar() [3/3]

◆ ~EdgeVar()

Member Function Documentation

◆ printMe()

◆ sourceNode()

◆ targetNode()

◆ theEdge()

◆ theEdgeType()

Friends And Related Function Documentation

◆ MaxCPlanarSub

Member Data Documentation

◆ m_edge

◆ m_eType

◆ m_source

◆ m_target

Open
Graph Drawing
Framework