Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

abacus::NumCon Class Reference

Constraints defined by a number. More...

#include <ogdf/lib/abacus/numcon.h>

+ Inheritance diagram for abacus::NumCon:

Public Member Functions

 NumCon (Master *master, const Sub *sub, CSense::SENSE sense, bool dynamic, bool local, bool liftable, int number, double rhs)
 Creates a constraint defined by number. More...
 
virtual ~NumCon ()
 The destructor. More...
 
virtual double coeff (const Variable *v) const
 Returns the coefficient of the variable v. More...
 
int number () const
 Returns the identification number of the constraint. More...
 
virtual void print (std::ostream &out) const
 Writes the row format of the constraint on an output stream. More...
 
- Public Member Functions inherited from abacus::Constraint
 Constraint (const Constraint &rhs)
 Copy constructor. More...
 
 Constraint (Master *master)
 Initializes an empty constraint. More...
 
 Constraint (Master *master, const Sub *sub, CSense::SENSE sense, double rhs, bool dynamic, bool local, bool liftable)
 Initializes a constraint. More...
 
virtual ~Constraint ()
 
ConClassclassification (Active< Variable, Constraint > *var=nullptr) const
 Returns a pointer to the classification of the constraint. More...
 
virtual double distance (double *x, Active< Variable, Constraint > *actVar) const
 Returns the Euclidean distance of x associated with variable set actVar to the hyperplane induced by the constraint. More...
 
virtual int genRow (Active< Variable, Constraint > *var, Row &row) const
 Generates the row format of the constraint associated with the variable set var. More...
 
bool liftable () const
 Checks if the constraint is liftable. More...
 
void printRow (std::ostream &out, Active< Variable, Constraint > *var) const
 Writes the row format of the constraint associated with the variable set var to output stream out. More...
 
virtual double rhs () const
 Returns the right hand side of the constraint. More...
 
CSensesense ()
 Returns a pointer to the sense of the constraint. More...
 
const CSensesense () const
 Returns a const pointer to the sense of the constraint. More...
 
virtual double slack (Active< Variable, Constraint > *variables, double *x) const
 Computes the slack of the vector x associated with the variable set variables. More...
 
virtual bool valid (Sub *sub) const
 Checks if the constraint is valid for the subproblem sub. More...
 
virtual bool violated (Active< Variable, Constraint > *variables, double *x, double *sl=nullptr) const
 Checks if a constraint is violated by a vector x associated with a variable set. More...
 
virtual bool violated (double slack) const
 Checks if a constraint is violated given the slack of a vector. 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...
 
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

int number_
 The identification number of the constraint. More...
 

Friends

std::ostream & operator<< (std::ostream &out, const NumCon &rhs)
 The output operator writes the identification number and the right hand side to an output stream. 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 Member Functions inherited from abacus::Constraint
virtual ConClassclassify (Active< Variable, Constraint > *var) const
 The default implementation returns a 0 pointer. More...
 
virtual InfeasCon::INFEAS voidLhsViolated (double newRhs) const
 Can be called if after variable elimination the left hand side of the constraint has become void and the right hand side has been adapted to newRhs. More...
 
- Protected Attributes inherited from abacus::Constraint
ConClassconClass_
 
bool liftable_
 This member is true if also coefficients of variables which have been inactive at generation time can be computed, false otherwise. More...
 
double rhs_
 The right hand side of the constraint. More...
 
CSense sense_
 The sense of the constraint. 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

Constraints defined by a number.

Like the class NumVar for variables we provide the class NumCon for constraints which are uniquely defined by an integer number.

Definition at line 46 of file numcon.h.

Constructor & Destructor Documentation

◆ NumCon()

abacus::NumCon::NumCon ( Master master,
const Sub sub,
CSense::SENSE  sense,
bool  dynamic,
bool  local,
bool  liftable,
int  number,
double  rhs 
)
inline

Creates a constraint defined by number.

Parameters
masterA pointer to the corresponding master of the optimization.
subA pointer to the subproblem associated with the constraint. This can be also the 0-pointer.
senseThe sense of the constraint.
dynamicIf this argument is true, then the constraint can be removed from the active constraint set during the cutting plane phase of the subproblem optimization.
localIf this argument is true, then the constraint is considered to be only locally valid. As a local constraint is associated with a subproblem, sub must not be 0 if local is true.
liftableIf this argument is true, then a lifting procedure must be available, i.e., that the coefficients of variables which have not been active at generation time of the constraint can be computed.
numberThe identification number of the constraint.
rhsThe right hand side of the constraint.

Definition at line 67 of file numcon.h.

◆ ~NumCon()

virtual abacus::NumCon::~NumCon ( )
inlinevirtual

The destructor.

Definition at line 79 of file numcon.h.

Member Function Documentation

◆ coeff()

double abacus::NumCon::coeff ( const Variable v) const
inlinevirtual

Returns the coefficient of the variable v.

Parameters
vThe variable of which the coefficient is determined. It must point to an object of the class ColVar.

Implements abacus::Constraint.

Definition at line 123 of file numcon.h.

◆ number()

int abacus::NumCon::number ( ) const
inline

Returns the identification number of the constraint.

Definition at line 110 of file numcon.h.

◆ print()

virtual void abacus::NumCon::print ( std::ostream &  out) const
inlinevirtual

Writes the row format of the constraint on an output stream.

It redefines the virtual function print() of the base class ConVar.

Parameters
outThe output stream.

Reimplemented from abacus::ConVar.

Definition at line 105 of file numcon.h.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  out,
const NumCon rhs 
)
friend

The output operator writes the identification number and the right hand side to an output stream.

Parameters
outThe output stream.
rhsThe variable being output.
Returns
A reference to the output stream.

Definition at line 88 of file numcon.h.

Member Data Documentation

◆ number_

int abacus::NumCon::number_
private

The identification number of the constraint.

Definition at line 114 of file numcon.h.


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