Couenne 0.5.8
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Couenne::exprVar Class Reference

variable-type operator More...

#include <CouenneExprVar.hpp>

+ Inheritance diagram for Couenne::exprVar:
+ Collaboration diagram for Couenne::exprVar:

Public Member Functions

virtual enum nodeType Type () const
 Node type.
 
 exprVar (int varIndex, Domain *d=NULL)
 Constructor.
 
virtual ~exprVar ()
 destructor
 
 exprVar (const exprVar &e, Domain *d=NULL)
 Copy constructor.
 
virtual exprVarclone (Domain *d=NULL) const
 Cloning method.
 
int Index () const
 Get variable index in problem.
 
virtual expressionLb ()
 Get lower bound expression.
 
virtual expressionUb ()
 Get upper bound expression.
 
virtual CouNumberlb ()
 Get/set lower bound value.
 
virtual CouNumberub ()
 Get/set upper bound value.
 
virtual void print (std::ostream &out=std::cout, bool=false) const
 print
 
virtual CouNumber operator() ()
 return the value of the variable
 
virtual CouNumber gradientNorm (const double *x)
 return l-2 norm of gradient at given point
 
virtual expressiondifferentiate (int index)
 differentiation
 
virtual int DepList (std::set< int > &deplist, enum dig_type type=ORIG_ONLY)
 fill in the set with all indices of variables appearing in the expression
 
virtual void crossBounds ()
 set bounds depending on both branching rules and propagated bounds.
 
virtual expressionsimplify ()
 simplify
 
virtual int Linearity ()
 get a measure of "how linear" the expression is (see CouenneTypes.hpp)
 
virtual bool isDefinedInteger ()
 is this expression defined as an integer?
 
virtual bool isInteger ()
 is this variable integer?
 
virtual void getBounds (expression *&, expression *&)
 Get expressions of lower and upper bound of an expression (if any)
 
virtual void getBounds (CouNumber &lb, CouNumber &ub)
 Get value of lower and upper bound of an expression (if any)
 
virtual void generateCuts (OsiCuts &, const CouenneCutGenerator *, t_chg_bounds *=NULL, int=-1, CouNumber=-COUENNE_INFINITY, CouNumber=COUENNE_INFINITY)
 Get values of lower and upper bound of an expression (if any)
 
virtual void generateCuts (expression *w, OsiCuts &cs, const CouenneCutGenerator *cg, t_chg_bounds *=NULL, int=-1, CouNumber=-COUENNE_INFINITY, CouNumber=COUENNE_INFINITY)
 generate convexification cut for constraint w = this
 
virtual enum expr_type code ()
 code for comparison
 
virtual bool impliedBound (int, CouNumber *, CouNumber *, t_chg_bounds *, enum auxSign=expression::AUX_EQ)
 implied bound processing
 
virtual int rank ()
 rank of an original variable is always one
 
virtual void fillDepSet (std::set< DepNode *, compNode > *, DepGraph *)
 update dependence set with index of this variable
 
virtual bool isFixed ()
 is this variable fixed?
 
virtual void linkDomain (Domain *d)
 link this variable to a domain
 
virtual Domaindomain ()
 return pointer to variable domain
 
virtual void decreaseMult ()
 
virtual void zeroMult ()
 Disable variable (empty for compatibility with exprAux)
 
virtual void setInteger (bool value)
 Set this variable as integer (empty for compatibility with exprAux)
 
virtual enum convexity convexity () const
 either CONVEX, CONCAVE, AFFINE, or NONCONVEX
 
virtual CouenneObjectproperObject (CouenneCutGenerator *c, CouenneProblem *p, Bonmin::BabSetupBase *base, JnlstPtr jnlst_)
 return proper object to handle expression associated with this variable (NULL if this is not an auxiliary)
 
virtual enum auxSign sign () const
 return its sign in the definition constraint
 
- Public Member Functions inherited from Couenne::expression
 expression ()
 Constructor.
 
 expression (const expression &e, Domain *d=NULL)
 Copy constructor.
 
virtual ~expression ()
 Destructor.
 
virtual expressionclone (Domain *d=NULL) const
 Cloning method.
 
virtual int Index () const
 Return index of variable (only valid for exprVar and exprAux)
 
virtual int nArgs () const
 return number of arguments (when applicable, that is, with N-ary functions)
 
virtual expression ** ArgList () const
 return arglist (when applicable, that is, with N-ary functions)
 
virtual void ArgList (expression **al)
 set arglist (used in deleting nodes without deleting children)
 
virtual expressionArgument () const
 return argument (when applicable, i.e., with univariate functions)
 
virtual expression ** ArgPtr ()
 return pointer to argument (when applicable, i.e., with univariate functions)
 
virtual enum nodeType Type () const
 node type
 
virtual expressionImage () const
 return pointer to corresponding expression (for auxiliary variables only)
 
virtual void Image (expression *image)
 set expression associated with this auxiliary variable (for compatibility with exprAux)
 
virtual CouNumber Value () const
 value (empty)
 
virtual const expressionOriginal () const
 If this is an exprClone of a exprClone of an expr???, point to the original expr??? instead of an exprClone – improve computing efficiency.
 
virtual void print (std::ostream &s=std::cout, bool=false) const
 print expression to iostream
 
virtual CouNumber operator() ()=0
 null function for evaluating the expression
 
virtual CouNumber gradientNorm (const double *x)
 return l-2 norm of gradient at given point
 
virtual expressiondifferentiate (int)
 differentiation
 
virtual int dependsOn (int *ind, int n, enum dig_type type=STOP_AT_AUX)
 dependence on variable set: return cardinality of subset of the set of indices in first argument which occur in expression.
 
int dependsOn (int singleton, enum dig_type type=STOP_AT_AUX)
 version with one index only
 
virtual int DepList (std::set< int > &deplist, enum dig_type type=ORIG_ONLY)
 fill std::set with indices of variables on which this expression depends.
 
virtual expressionsimplify ()
 simplify expression (useful for derivatives)
 
virtual int Linearity ()
 get a measure of "how linear" the expression is (see CouenneTypes.h)
 
virtual bool isDefinedInteger ()
 is this expression defined as an integer?
 
virtual bool isInteger ()
 is this expression integer?
 
virtual void getBounds (expression *&, expression *&)
 Get lower and upper bound of an expression (if any)
 
virtual void getBounds (CouNumber &, CouNumber &)
 Get lower and upper bound of an expression (if any) – real values.
 
virtual exprAuxstandardize (CouenneProblem *p, bool addAux=true)
 Create standard form of this expression, by:
 
virtual void generateCuts (expression *w, OsiCuts &cs, const CouenneCutGenerator *cg, t_chg_bounds *chg=NULL, int wind=-1, CouNumber lb=-COUENNE_INFINITY, CouNumber ub=COUENNE_INFINITY)
 generate convexification cut for constraint w = this
 
virtual enum expr_type code ()
 return integer for comparing expressions (used to recognize common expression)
 
virtual enum convexity convexity () const
 either CONVEX, CONCAVE, AFFINE, or NONCONVEX
 
virtual int compare (expression &)
 compare expressions
 
virtual int compare (exprCopy &)
 compare copies of expressions
 
virtual int rank ()
 used in rank-based branching variable choice: original variables have rank 1; auxiliary w=f(x) has rank r(w) = r(x)+1; finally, auxiliary w=f(x1,x2...,xk) has rank r(w) = 1+max{r(xi):i=1..k}.
 
virtual bool impliedBound (int, CouNumber *, CouNumber *, t_chg_bounds *, enum auxSign=expression::AUX_EQ)
 does a backward implied bound processing on every expression, including exprSums although already done by Clp (useful when repeated within Couenne).
 
virtual int Multiplicity ()
 multiplicity of a variable
 
virtual CouNumber selectBranch (const CouenneObject *obj, const OsiBranchingInformation *info, expression *&var, double *&brpts, double *&brDist, int &way)
 set up branching object by evaluating many branching points for each expression's arguments.
 
virtual void replace (exprVar *, exprVar *)
 replace expression with another
 
virtual void fillDepSet (std::set< DepNode *, compNode > *, DepGraph *)
 update dependence set with index of variables on which this expression depends
 
virtual void linkDomain (Domain *d)
 empty function to update domain pointer
 
virtual void realign (const CouenneProblem *p)
 empty function to redirect variables to proper variable vector
 
virtual bool isBijective () const
 indicating if function is monotonically increasing
 
virtual CouNumber inverse (expression *vardep) const
 compute the inverse function
 
virtual void closestFeasible (expression *varind, expression *vardep, CouNumber &left, CouNumber &right) const
 closest feasible points in function in both directions
 
virtual bool isCuttable (CouenneProblem *problem, int index) const
 can this expression be further linearized or are we on its concave ("bad") side
 
virtual bool isaCopy () const
 return true if this is a copy of something (i.e. an exprCopy)
 
virtual expressionCopy () const
 return copy of this expression (only makes sense in exprCopy)
 

Protected Attributes

int varIndex_
 The index of the variable.
 
Domaindomain_
 Pointer to a descriptor of the current point/bounds.
 

Additional Inherited Members

- Public Types inherited from Couenne::expression
enum  auxSign { AUX_UNDEF =-2 , AUX_LEQ =-1 , AUX_EQ , AUX_GEQ }
 "sign" of the constraint defining an auxiliary. More...
 

Detailed Description

variable-type operator

All variables of the expression must be objects of this class or of the derived exprAux class

Definition at line 45 of file CouenneExprVar.hpp.

Constructor & Destructor Documentation

◆ exprVar() [1/2]

Couenne::exprVar::exprVar ( int  varIndex,
Domain d = NULL 
)
inline

Constructor.

Definition at line 59 of file CouenneExprVar.hpp.

◆ ~exprVar()

virtual Couenne::exprVar::~exprVar ( )
inlinevirtual

destructor

Definition at line 64 of file CouenneExprVar.hpp.

◆ exprVar() [2/2]

Couenne::exprVar::exprVar ( const exprVar e,
Domain d = NULL 
)
inline

Copy constructor.

Definition at line 67 of file CouenneExprVar.hpp.

Member Function Documentation

◆ Type()

virtual enum nodeType Couenne::exprVar::Type ( ) const
inlinevirtual

Node type.

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprAux, Couenne::exprLowerBound, and Couenne::exprUpperBound.

Definition at line 55 of file CouenneExprVar.hpp.

◆ clone()

virtual exprVar * Couenne::exprVar::clone ( Domain d = NULL) const
inlinevirtual

Cloning method.

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprAux, Couenne::exprLowerBound, Couenne::exprUpperBound, and Couenne::exprIVar.

Definition at line 72 of file CouenneExprVar.hpp.

◆ Index()

int Couenne::exprVar::Index ( ) const
inlinevirtual

Get variable index in problem.

Reimplemented from Couenne::expression.

Definition at line 76 of file CouenneExprVar.hpp.

◆ Lb()

virtual expression * Couenne::exprVar::Lb ( )
virtual

Get lower bound expression.

Reimplemented in Couenne::exprAux.

◆ Ub()

virtual expression * Couenne::exprVar::Ub ( )
virtual

Get upper bound expression.

Reimplemented in Couenne::exprAux.

◆ lb()

virtual CouNumber & Couenne::exprVar::lb ( )
inlinevirtual

Get/set lower bound value.

Definition at line 84 of file CouenneExprVar.hpp.

◆ ub()

virtual CouNumber & Couenne::exprVar::ub ( )
inlinevirtual

Get/set upper bound value.

Definition at line 85 of file CouenneExprVar.hpp.

◆ print()

virtual void Couenne::exprVar::print ( std::ostream &  out = std::cout,
bool  = false 
) const
inlinevirtual

print

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprAux, Couenne::exprLowerBound, Couenne::exprUpperBound, and Couenne::exprIVar.

Definition at line 88 of file CouenneExprVar.hpp.

◆ operator()()

virtual CouNumber Couenne::exprVar::operator() ( )
inlinevirtual

return the value of the variable

Implements Couenne::expression.

Reimplemented in Couenne::exprAux, Couenne::exprLowerBound, and Couenne::exprUpperBound.

Definition at line 93 of file CouenneExprVar.hpp.

◆ gradientNorm()

virtual CouNumber Couenne::exprVar::gradientNorm ( const double *  x)
inlinevirtual

return l-2 norm of gradient at given point

Reimplemented from Couenne::expression.

Definition at line 97 of file CouenneExprVar.hpp.

◆ differentiate()

virtual expression * Couenne::exprVar::differentiate ( int  index)
inlinevirtual

differentiation

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprLowerBound, and Couenne::exprUpperBound.

Definition at line 101 of file CouenneExprVar.hpp.

◆ DepList()

virtual int Couenne::exprVar::DepList ( std::set< int > &  deplist,
enum dig_type  type = ORIG_ONLY 
)
inlinevirtual

fill in the set with all indices of variables appearing in the expression

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprAux.

Definition at line 106 of file CouenneExprVar.hpp.

◆ crossBounds()

virtual void Couenne::exprVar::crossBounds ( )
inlinevirtual

set bounds depending on both branching rules and propagated bounds.

To be used after standardization

Reimplemented in Couenne::exprAux.

Definition at line 118 of file CouenneExprVar.hpp.

◆ simplify()

virtual expression * Couenne::exprVar::simplify ( )
inlinevirtual

simplify

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprAux.

Definition at line 121 of file CouenneExprVar.hpp.

◆ Linearity()

virtual int Couenne::exprVar::Linearity ( )
inlinevirtual

get a measure of "how linear" the expression is (see CouenneTypes.hpp)

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprAux, Couenne::exprLowerBound, and Couenne::exprUpperBound.

Definition at line 125 of file CouenneExprVar.hpp.

◆ isDefinedInteger()

virtual bool Couenne::exprVar::isDefinedInteger ( )
inlinevirtual

is this expression defined as an integer?

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprAux, and Couenne::exprIVar.

Definition at line 129 of file CouenneExprVar.hpp.

◆ isInteger()

virtual bool Couenne::exprVar::isInteger ( )
inlinevirtual

is this variable integer?

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprAux, and Couenne::exprIVar.

Definition at line 133 of file CouenneExprVar.hpp.

◆ getBounds() [1/2]

virtual void Couenne::exprVar::getBounds ( expression *&  ,
expression *&   
)
virtual

Get expressions of lower and upper bound of an expression (if any)

Reimplemented from Couenne::expression.

◆ getBounds() [2/2]

virtual void Couenne::exprVar::getBounds ( CouNumber lb,
CouNumber ub 
)
virtual

Get value of lower and upper bound of an expression (if any)

Reimplemented from Couenne::expression.

◆ generateCuts() [1/2]

virtual void Couenne::exprVar::generateCuts ( OsiCuts ,
const CouenneCutGenerator ,
t_chg_bounds = NULL,
int  = -1,
CouNumber  = -COUENNE_INFINITY,
CouNumber  = COUENNE_INFINITY 
)
inlinevirtual

Get values of lower and upper bound of an expression (if any)

generate cuts for expression associated with this auxiliary

Reimplemented in Couenne::exprAux.

Definition at line 156 of file CouenneExprVar.hpp.

◆ generateCuts() [2/2]

virtual void Couenne::exprVar::generateCuts ( expression w,
OsiCuts cs,
const CouenneCutGenerator cg,
t_chg_bounds = NULL,
int  = -1,
CouNumber  = -COUENNE_INFINITY,
CouNumber  = COUENNE_INFINITY 
)
virtual

generate convexification cut for constraint w = this

Reimplemented from Couenne::expression.

◆ code()

virtual enum expr_type Couenne::exprVar::code ( )
inlinevirtual

code for comparison

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprLowerBound, and Couenne::exprUpperBound.

Definition at line 171 of file CouenneExprVar.hpp.

◆ impliedBound()

virtual bool Couenne::exprVar::impliedBound ( int  ,
CouNumber ,
CouNumber ,
t_chg_bounds ,
enum  auxSign = expression::AUX_EQ 
)
virtual

implied bound processing

Reimplemented from Couenne::expression.

◆ rank()

virtual int Couenne::exprVar::rank ( )
inlinevirtual

rank of an original variable is always one

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprAux.

Definition at line 178 of file CouenneExprVar.hpp.

◆ fillDepSet()

virtual void Couenne::exprVar::fillDepSet ( std::set< DepNode *, compNode > *  ,
DepGraph  
)
virtual

update dependence set with index of this variable

Reimplemented from Couenne::expression.

◆ isFixed()

virtual bool Couenne::exprVar::isFixed ( )
inlinevirtual

is this variable fixed?

Definition at line 185 of file CouenneExprVar.hpp.

◆ linkDomain()

virtual void Couenne::exprVar::linkDomain ( Domain d)
inlinevirtual

link this variable to a domain

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprAux.

Definition at line 189 of file CouenneExprVar.hpp.

◆ domain()

virtual Domain * Couenne::exprVar::domain ( )
inlinevirtual

return pointer to variable domain

Definition at line 193 of file CouenneExprVar.hpp.

◆ decreaseMult()

virtual void Couenne::exprVar::decreaseMult ( )
inlinevirtual

Reimplemented in Couenne::exprAux.

Definition at line 197 of file CouenneExprVar.hpp.

◆ zeroMult()

virtual void Couenne::exprVar::zeroMult ( )
inlinevirtual

Disable variable (empty for compatibility with exprAux)

Reimplemented in Couenne::exprAux.

Definition at line 200 of file CouenneExprVar.hpp.

◆ setInteger()

virtual void Couenne::exprVar::setInteger ( bool  value)
inlinevirtual

Set this variable as integer (empty for compatibility with exprAux)

Reimplemented in Couenne::exprAux.

Definition at line 203 of file CouenneExprVar.hpp.

◆ convexity()

virtual enum convexity Couenne::exprVar::convexity ( ) const
inlinevirtual

either CONVEX, CONCAVE, AFFINE, or NONCONVEX

Reimplemented from Couenne::expression.

Definition at line 206 of file CouenneExprVar.hpp.

◆ properObject()

virtual CouenneObject * Couenne::exprVar::properObject ( CouenneCutGenerator c,
CouenneProblem p,
Bonmin::BabSetupBase base,
JnlstPtr  jnlst_ 
)
virtual

return proper object to handle expression associated with this variable (NULL if this is not an auxiliary)

Reimplemented in Couenne::exprAux.

◆ sign()

virtual enum auxSign Couenne::exprVar::sign ( ) const
inlinevirtual

return its sign in the definition constraint

Reimplemented in Couenne::exprAux.

Definition at line 217 of file CouenneExprVar.hpp.

Member Data Documentation

◆ varIndex_

int Couenne::exprVar::varIndex_
protected

The index of the variable.

Definition at line 49 of file CouenneExprVar.hpp.

◆ domain_

Domain* Couenne::exprVar::domain_
protected

Pointer to a descriptor of the current point/bounds.

Definition at line 50 of file CouenneExprVar.hpp.


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