Couenne  0.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
Couenne::exprIVar Class Reference

variable-type operator. More...

#include <CouenneExprIVar.hpp>

Inheritance diagram for Couenne::exprIVar:
Couenne::exprVar Couenne::expression

Public Member Functions

 exprIVar (int varIndex, Domain *d=NULL)
 Constructor. More...
 
 exprIVar (const exprIVar &e, Domain *d=NULL)
 Copy constructor – must go. More...
 
virtual exprVarclone (Domain *d=NULL) const
 Cloning method. More...
 
virtual void print (std::ostream &out=std::cout, bool=false) const
 Print. More...
 
virtual bool isDefinedInteger ()
 is this expression defined as an integer? More...
 
virtual bool isInteger ()
 Is this expression integer? More...
 
- Public Member Functions inherited from Couenne::exprVar
virtual enum nodeType Type () const
 Node type. More...
 
 exprVar (int varIndex, Domain *d=NULL)
 Constructor. More...
 
virtual ~exprVar ()
 destructor More...
 
 exprVar (const exprVar &e, Domain *d=NULL)
 Copy constructor. More...
 
int Index () const
 Get variable index in problem. More...
 
virtual expressionLb ()
 Get lower bound expression. More...
 
virtual expressionUb ()
 Get upper bound expression. More...
 
virtual CouNumberlb ()
 Get/set lower bound value. More...
 
virtual CouNumberub ()
 Get/set upper bound value. More...
 
virtual CouNumber operator() ()
 return the value of the variable More...
 
virtual CouNumber gradientNorm (const double *x)
 return l-2 norm of gradient at given point More...
 
virtual expressiondifferentiate (int index)
 differentiation More...
 
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 More...
 
virtual void crossBounds ()
 set bounds depending on both branching rules and propagated bounds. More...
 
virtual expressionsimplify ()
 simplify More...
 
virtual int Linearity ()
 get a measure of "how linear" the expression is (see CouenneTypes.hpp) More...
 
virtual void getBounds (expression *&, expression *&)
 Get expressions of lower and upper bound of an expression (if any) More...
 
virtual void getBounds (CouNumber &lb, CouNumber &ub)
 Get value of lower and upper bound of an expression (if any) More...
 
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) More...
 
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 More...
 
virtual enum expr_type code ()
 code for comparison More...
 
virtual bool impliedBound (int, CouNumber *, CouNumber *, t_chg_bounds *, enum auxSign=expression::AUX_EQ)
 implied bound processing More...
 
virtual int rank ()
 rank of an original variable is always one More...
 
virtual void fillDepSet (std::set< DepNode *, compNode > *, DepGraph *)
 update dependence set with index of this variable More...
 
virtual bool isFixed ()
 is this variable fixed? More...
 
virtual void linkDomain (Domain *d)
 link this variable to a domain More...
 
virtual Domaindomain ()
 return pointer to variable domain More...
 
virtual void decreaseMult ()
 
virtual void zeroMult ()
 Disable variable (empty for compatibility with exprAux) More...
 
virtual void setInteger (bool value)
 Set this variable as integer (empty for compatibility with exprAux) More...
 
virtual enum convexity convexity () const
 either CONVEX, CONCAVE, AFFINE, or NONCONVEX More...
 
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) More...
 
virtual enum auxSign sign () const
 return its sign in the definition constraint More...
 
- Public Member Functions inherited from Couenne::expression
 expression ()
 Constructor. More...
 
 expression (const expression &e, Domain *d=NULL)
 Copy constructor. More...
 
virtual ~expression ()
 Destructor. More...
 
virtual int nArgs () const
 return number of arguments (when applicable, that is, with N-ary functions) More...
 
virtual expression ** ArgList () const
 return arglist (when applicable, that is, with N-ary functions) More...
 
virtual void ArgList (expression **al)
 set arglist (used in deleting nodes without deleting children) More...
 
virtual expressionArgument () const
 return argument (when applicable, i.e., with univariate functions) More...
 
virtual expression ** ArgPtr ()
 return pointer to argument (when applicable, i.e., with univariate functions) More...
 
virtual expressionImage () const
 return pointer to corresponding expression (for auxiliary variables only) More...
 
virtual void Image (expression *image)
 set expression associated with this auxiliary variable (for compatibility with exprAux) More...
 
virtual CouNumber Value () const
 value (empty) More...
 
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. More...
 
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. More...
 
int dependsOn (int singleton, enum dig_type type=STOP_AT_AUX)
 version with one index only More...
 
virtual exprAuxstandardize (CouenneProblem *p, bool addAux=true)
 Create standard form of this expression, by: More...
 
virtual int compare (expression &)
 compare expressions More...
 
virtual int compare (exprCopy &)
 compare copies of expressions More...
 
virtual int Multiplicity ()
 multiplicity of a variable More...
 
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. More...
 
virtual void replace (exprVar *, exprVar *)
 replace expression with another More...
 
virtual void realign (const CouenneProblem *p)
 empty function to redirect variables to proper variable vector More...
 
virtual bool isBijective () const
 indicating if function is monotonically increasing More...
 
virtual CouNumber inverse (expression *vardep) const
 compute the inverse function More...
 
virtual void closestFeasible (expression *varind, expression *vardep, CouNumber &left, CouNumber &right) const
 closest feasible points in function in both directions More...
 
virtual bool isCuttable (CouenneProblem *problem, int index) const
 can this expression be further linearized or are we on its concave ("bad") side More...
 
virtual bool isaCopy () const
 return true if this is a copy of something (i.e. an exprCopy) More...
 
virtual expressionCopy () const
 return copy of this expression (only makes sense in exprCopy) More...
 

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...
 
- Protected Attributes inherited from Couenne::exprVar
int varIndex_
 The index of the variable. More...
 
Domaindomain_
 Pointer to a descriptor of the current point/bounds. More...
 

Detailed Description

variable-type operator.

All variables of the expression must be objects of this class

Definition at line 25 of file CouenneExprIVar.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 30 of file CouenneExprIVar.hpp.

Referenced by clone().

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

Copy constructor – must go.

Definition at line 34 of file CouenneExprIVar.hpp.

Member Function Documentation

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

Cloning method.

Reimplemented from Couenne::exprVar.

Definition at line 38 of file CouenneExprIVar.hpp.

References exprIVar().

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

Print.

Reimplemented from Couenne::exprVar.

Definition at line 42 of file CouenneExprIVar.hpp.

References Couenne::exprVar::varIndex_.

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

is this expression defined as an integer?

Reimplemented from Couenne::exprVar.

Definition at line 46 of file CouenneExprIVar.hpp.

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

Is this expression integer?

Reimplemented from Couenne::exprVar.

Definition at line 50 of file CouenneExprIVar.hpp.


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