expression clone (points to another expression) More...
#include <CouenneExprClone.hpp>
Inheritance diagram for Couenne::exprClone:
Collaboration diagram for Couenne::exprClone:
Public Member Functions | |
| exprClone (expression *copy) | |
| Constructor. | |
| exprClone (const exprClone &e, Domain *d=NULL) | |
| copy constructor | |
| expression * | clone (Domain *d=NULL) const |
| cloning method | |
| virtual | ~exprClone () |
| Destructor. | |
| virtual void | print (std::ostream &out=std::cout, bool descend=false) const |
| Printing. | |
| CouNumber | Value () const |
| value | |
| CouNumber | operator() () |
| null function for evaluating the expression | |
| Public Member Functions inherited from Couenne::exprCopy | |
| enum nodeType | Type () const |
| node type | |
| exprCopy (expression *copy) | |
| Empty constructor - used in cloning method of exprClone. | |
| exprCopy (const exprCopy &e, Domain *d=NULL) | |
| Copy constructor. | |
| virtual | ~exprCopy () |
| Destructor – CAUTION: this is the only destructive destructor, exprClone and exprStore do not destroy anything. | |
| virtual expression * | clone (Domain *d=NULL) const |
| Cloning method. | |
| const expression * | Original () const |
| If this is an exprClone of a exprClone of an expr???, point to the original expr??? instead of an exprClone – improves computing efficiency. | |
| bool | isaCopy () const |
| return true if this is a copy of something, i.e. | |
| expression * | Copy () const |
| return copy of this expression (only makes sense in exprCopy) | |
| expression * | Image () const |
| return pointer to corresponding expression (for auxiliary variables only) | |
| int | Index () const |
| Get variable index in problem. | |
| int | nArgs () const |
| Return number of arguments (when applicable, that is, with N-ary functions) | |
| expression ** | ArgList () const |
| return arglist (when applicable, that is, with N-ary functions) | |
| void | ArgList (expression **al) |
| set arglist (used in deleting nodes without deleting children) | |
| expression * | Argument () const |
| return argument (when applicable, i.e., with univariate functions) | |
| expression ** | ArgPtr () |
| return pointer to argument (when applicable, i.e., with univariate functions) | |
| virtual void | print (std::ostream &out=std::cout, bool descend=false) const |
| I/O. | |
| virtual CouNumber | Value () const |
| value | |
| virtual CouNumber | operator() () |
| null function for evaluating the expression | |
| CouNumber | gradientNorm (const double *x) |
| return l-2 norm of gradient at given point | |
| expression * | differentiate (int index) |
| differentiation | |
| 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 | |
| expression * | simplify () |
| simplify expression (useful for derivatives) | |
| int | Linearity () |
| get a measure of "how linear" the expression is (see CouenneTypes.h) | |
| bool | isInteger () |
| is this expression integer? | |
| virtual bool | isDefinedInteger () |
| is this expression DEFINED as integer? | |
| void | getBounds (expression *&lower, expression *&upper) |
| Get lower and upper bound of an expression (if any) | |
| void | getBounds (CouNumber &lower, CouNumber &upper) |
| Get value of lower and upper bound of an expression (if any) | |
| exprAux * | standardize (CouenneProblem *p, bool addAux=true) |
| Create standard formulation of this expression. | |
| 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 | |
| enum expr_type | code () |
| code for comparisons | |
| enum convexity | convexity () const |
| either CONVEX, CONCAVE, AFFINE, or NONCONVEX | |
| int | compare (expression &e) |
| compare this with other expression | |
| int | rank () |
| used in rank-based branching variable choice | |
| bool | impliedBound (int wind, CouNumber *l, CouNumber *u, t_chg_bounds *chg) |
| implied bound processing | |
| int | Multiplicity () |
| multiplicity of a variable: how many times this variable occurs in expressions throughout the problem | |
| 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. | |
| void | replace (exprVar *, exprVar *) |
| replace occurrence of a variable with another variable | |
| void | fillDepSet (std::set< DepNode *, compNode > *dep, DepGraph *g) |
| fill in dependence structure | |
| void | realign (const CouenneProblem *p) |
| redirect variables to proper variable vector | |
| bool | isBijective () const |
| indicating if function is monotonically increasing | |
| CouNumber | inverse (expression *vardep) const |
| compute the inverse function | |
| void | closestFeasible (expression *varind, expression *vardep, CouNumber &left, CouNumber &right) const |
| closest feasible points in function in both directions | |
| bool | isCuttable (CouenneProblem *problem, int index) const |
| can this expression be further linearized or are we on its concave ("bad") side | |
| Public Member Functions inherited from Couenne::expression | |
| expression () | |
| Constructor. | |
| expression (const expression &e, Domain *d=NULL) | |
| Copy constructor. | |
| virtual | ~expression () |
| Destructor. | |
| virtual expression * | clone (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 expression * | Argument () 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 expression * | Image () 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 expression * | Original () 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 expression * | differentiate (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 expression * | simplify () |
| 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 exprAux * | standardize (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 expression * | Copy () const |
| return copy of this expression (only makes sense in exprCopy) | |
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::exprCopy | |
| expression * | copy_ |
| the expression this object is a (reference) copy of | |
| CouNumber | value_ |
| saved value to be used by exprStore expressions | |
Detailed Description
expression clone (points to another expression)
Definition at line 24 of file CouenneExprClone.hpp.
Constructor & Destructor Documentation
◆ exprClone() [1/2]
|
inline |
Constructor.
Definition at line 29 of file CouenneExprClone.hpp.
◆ exprClone() [2/2]
copy constructor
Definition at line 33 of file CouenneExprClone.hpp.
◆ ~exprClone()
|
inlinevirtual |
Destructor.
Definition at line 47 of file CouenneExprClone.hpp.
Member Function Documentation
◆ clone()
|
inlinevirtual |
cloning method
Reimplemented from Couenne::exprCopy.
Definition at line 38 of file CouenneExprClone.hpp.
◆ print()
|
virtual |
Printing.
Reimplemented from Couenne::exprCopy.
◆ Value()
|
inlinevirtual |
◆ operator()()
|
inlinevirtual |
null function for evaluating the expression
Reimplemented from Couenne::exprCopy.
Definition at line 62 of file CouenneExprClone.hpp.
The documentation for this class was generated from the following file:
- /builddir/build/BUILD/Couenne-0.5.8/src/expression/CouenneExprClone.hpp
