Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::MinSteinerTreeDirectedCut< T >::EdgeVariable Class Reference

Variable for directed edges. More...

#include <ogdf/graphalg/MinSteinerTreeDirectedCut.h>

+ Inheritance diagram for ogdf::MinSteinerTreeDirectedCut< T >::EdgeVariable:

Public Member Functions

 EdgeVariable (abacus::Master *master, int id, edge e, double coeff, double lb=0.0, double ub=1.0, abacus::VarType::TYPE vartype=abacus::VarType::Binary)
 
double coefficient () const
 objective function coefficient More...
 
int id () const
 id of the edge (variable) More...
 
node source () const
 source node More...
 
node target () const
 target node More...
 
edge theEdge () const
 the associated edge More...
 
- 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...
 
FSVarStatfsVarStat ()
 
const FSVarStatfsVarStat () 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...
 
bool global () const
 Returns true if the constraint/variable is globally valid, false otherwise. More...
 
bool local () const
 Returns true if the constraint/variable is only locally valid, false otherwise. 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...
 
virtual void print (std::ostream &out) const
 Writes the constraint/variable to the output stream out. More...
 
const Subsub () 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...
 
virtual unsigned hashKey () const
 Should provide a key for the constraint/variable that can be used to insert it into a hash table. More...
 
virtual const char * name () const
 Should return the name of the constraint/variable. 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...
 
virtual double rank () const
 The function should return a rank associated with the constraint/variable. More...
 
- Public Member Functions inherited from abacus::AbacusRoot
virtual ~AbacusRoot ()
 The destructor. More...
 

Private Attributes

edge m_edge
 the edge More...
 
int m_id
 id of the edge More...
 

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
Mastermaster_
 A pointer to the corresponding master of the optimization. More...
 
const Subsub_
 A pointer to the subproblem associated with the constraint/variable. More...
 
bool expanded_
 true, if expanded version of constraint/variables available. More...
 
int nReferences_
 The number of references to the pool slot the constraint is stored in. More...
 
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...
 
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...
 
bool local_
 true if the constraint/variable is only locally valid More...
 

Detailed Description

template<typename T>
class ogdf::MinSteinerTreeDirectedCut< T >::EdgeVariable

Variable for directed edges.

Definition at line 773 of file MinSteinerTreeDirectedCut.h.

Constructor & Destructor Documentation

◆ EdgeVariable()

template<typename T >
ogdf::MinSteinerTreeDirectedCut< T >::EdgeVariable::EdgeVariable ( abacus::Master master,
int  id,
edge  e,
double  coeff,
double  lb = 0.0,
double  ub = 1.0,
abacus::VarType::TYPE  vartype = abacus::VarType::Binary 
)
inline

Definition at line 776 of file MinSteinerTreeDirectedCut.h.

Member Function Documentation

◆ coefficient()

template<typename T >
double ogdf::MinSteinerTreeDirectedCut< T >::EdgeVariable::coefficient ( ) const
inline

objective function coefficient

Definition at line 798 of file MinSteinerTreeDirectedCut.h.

◆ id()

template<typename T >
int ogdf::MinSteinerTreeDirectedCut< T >::EdgeVariable::id ( ) const
inline

id of the edge (variable)

Definition at line 796 of file MinSteinerTreeDirectedCut.h.

◆ source()

template<typename T >
node ogdf::MinSteinerTreeDirectedCut< T >::EdgeVariable::source ( ) const
inline

source node

Definition at line 800 of file MinSteinerTreeDirectedCut.h.

◆ target()

template<typename T >
node ogdf::MinSteinerTreeDirectedCut< T >::EdgeVariable::target ( ) const
inline

target node

Definition at line 802 of file MinSteinerTreeDirectedCut.h.

◆ theEdge()

template<typename T >
edge ogdf::MinSteinerTreeDirectedCut< T >::EdgeVariable::theEdge ( ) const
inline

the associated edge

Definition at line 794 of file MinSteinerTreeDirectedCut.h.

Member Data Documentation

◆ m_edge

template<typename T >
edge ogdf::MinSteinerTreeDirectedCut< T >::EdgeVariable::m_edge
private

the edge

Definition at line 806 of file MinSteinerTreeDirectedCut.h.

◆ m_id

template<typename T >
int ogdf::MinSteinerTreeDirectedCut< T >::EdgeVariable::m_id
private

id of the edge

Definition at line 808 of file MinSteinerTreeDirectedCut.h.


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