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

general n-ary operator-type expression: requires argument list. More...

#include <CouenneExprOp.hpp>

Inheritance diagram for Couenne::exprOp:
Couenne::expression Couenne::exprDiv Couenne::exprIf Couenne::exprLBCos Couenne::exprLBDiv Couenne::exprLBMul Couenne::exprLBSin Couenne::exprMax Couenne::exprMin Couenne::exprMul Couenne::exprNorm Couenne::exprPow Couenne::exprPWLinear Couenne::exprSub Couenne::exprSum Couenne::exprUBCos Couenne::exprUBDiv Couenne::exprUBMul Couenne::exprUBSin

Public Member Functions

virtual enum nodeType Type () const
 Node type. More...
 
 exprOp (expression **arglist, int nargs)
 Constructor. More...
 
 exprOp (expression *arg0, expression *arg1)
 Constructor with two arguments (for convenience) More...
 
virtual ~exprOp ()
 Destructor. More...
 
 exprOp (const exprOp &e, Domain *d=NULL)
 Copy constructor: only allocate space for argument list, which will be copied with clonearglist() More...
 
expression ** ArgList () const
 return argument list More...
 
virtual void ArgList (expression **al)
 set arglist (used in deleting nodes without deleting children) More...
 
int nArgs () const
 return number of arguments More...
 
virtual void print (std::ostream &out=std::cout, bool=false) const
 I/O. More...
 
virtual enum pos printPos () const
 print position (PRE, INSIDE, POST) More...
 
virtual std::string printOp () const
 print operator 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 expression * simplify ()
 simplification More...
 
expression ** clonearglist (Domain *d=NULL) const
 clone argument list (for use with clone method) More...
 
int shrink_arglist (CouNumber, CouNumber)
 compress argument list More...
 
virtual int Linearity ()
 get a measure of "how linear" the expression is (see CouenneTypes.h) More...
 
virtual exprAux * standardize (CouenneProblem *, bool addAux=true)
 generate auxiliary variable More...
 
virtual enum expr_type code ()
 return code to classify type of expression More...
 
virtual bool isInteger ()
 is this expression integer? More...
 
virtual int compare (exprOp &)
 compare with other generic exprOp More...
 
virtual int rank ()
 used in rank-based branching variable choice More...
 
virtual void fillDepSet (std::set< DepNode *, compNode > *dep, DepGraph *g)
 fill in dependence structure update dependence set with index of this variable More...
 
virtual void replace (exprVar *, exprVar *)
 replace variable with other More...
 
virtual void realign (const CouenneProblem *p)
 empty function to redirect variables to proper variable vector 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 expression * clone (Domain *d=NULL) const
 Cloning method. More...
 
virtual int Index () const
 Return index of variable (only valid for exprVar and exprAux) More...
 
virtual expression * Argument () 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 expression * Image () 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 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. More...
 
virtual CouNumber operator() ()=0
 null function for evaluating the expression More...
 
virtual CouNumber gradientNorm (const double *x)
 return l-2 norm of gradient at given point More...
 
virtual expression * differentiate (int)
 differentiation 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 bool isDefinedInteger ()
 is this expression defined as an integer? More...
 
virtual void getBounds (expression *&, expression *&)
 Get lower and upper bound of an expression (if any) More...
 
virtual void getBounds (CouNumber &, CouNumber &)
 Get lower and upper bound of an expression (if any) – real values. More...
 
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 More...
 
virtual enum convexity convexity () const
 either CONVEX, CONCAVE, AFFINE, or NONCONVEX More...
 
virtual int compare (expression &)
 compare expressions More...
 
virtual int compare (exprCopy &)
 compare copies of expressions More...
 
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). 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 linkDomain (Domain *d)
 empty function to update domain pointer 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 expression * Copy () const
 return copy of this expression (only makes sense in exprCopy) More...
 

Protected Attributes

expression ** arglist_
 argument list is an array of pointers to other expressions More...
 
int nargs_
 number of arguments (cardinality of arglist) 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...
 

Detailed Description

general n-ary operator-type expression: requires argument list.

All non-unary and non-leaf operators, i.e., sum, subtraction, multiplication, power, division, max, min, etc. are derived from this class.

Definition at line 31 of file CouenneExprOp.hpp.

Constructor & Destructor Documentation

Couenne::exprOp::exprOp ( expression **  arglist,
int  nargs 
)
inline

Constructor.

Definition at line 45 of file CouenneExprOp.hpp.

Couenne::exprOp::exprOp ( expression *  arg0,
expression *  arg1 
)
inline

Constructor with two arguments (for convenience)

Definition at line 51 of file CouenneExprOp.hpp.

References arglist_.

virtual Couenne::exprOp::~exprOp ( )
virtual

Destructor.

Couenne::exprOp::exprOp ( const exprOp &  e,
Domain *  d = NULL 
)
inline

Copy constructor: only allocate space for argument list, which will be copied with clonearglist()

Definition at line 61 of file CouenneExprOp.hpp.

Member Function Documentation

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

Node type.

Reimplemented from Couenne::expression.

Definition at line 41 of file CouenneExprOp.hpp.

References Couenne::N_ARY.

Referenced by Couenne::exprDiv::Linearity().

expression** Couenne::exprOp::ArgList ( ) const
inlinevirtual

return argument list

Reimplemented from Couenne::expression.

Definition at line 66 of file CouenneExprOp.hpp.

References arglist_.

virtual void Couenne::exprOp::ArgList ( expression **  al)
inlinevirtual

set arglist (used in deleting nodes without deleting children)

Reimplemented from Couenne::expression.

Definition at line 70 of file CouenneExprOp.hpp.

References arglist_.

int Couenne::exprOp::nArgs ( ) const
inlinevirtual

return number of arguments

Reimplemented from Couenne::expression.

Definition at line 74 of file CouenneExprOp.hpp.

References nargs_.

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

I/O.

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprQuad, and Couenne::exprGroup.

virtual enum pos Couenne::exprOp::printPos ( ) const
inlinevirtual

print position (PRE, INSIDE, POST)

Reimplemented in Couenne::exprUBMul, Couenne::exprUBCos, Couenne::exprUBSin, Couenne::exprUBDiv, Couenne::exprLBMul, Couenne::exprLBDiv, Couenne::exprPow, Couenne::exprMax, Couenne::exprLBCos, and Couenne::exprLBSin.

Definition at line 82 of file CouenneExprOp.hpp.

References Couenne::INSIDE.

virtual std::string Couenne::exprOp::printOp ( ) const
inlinevirtual

print operator

Reimplemented in Couenne::exprUBMul, Couenne::exprUBDiv, Couenne::exprUBCos, Couenne::exprUBSin, Couenne::exprLBMul, Couenne::exprLBDiv, Couenne::exprPow, Couenne::exprLBCos, Couenne::exprLBSin, Couenne::exprDiv, Couenne::exprSum, Couenne::exprMul, Couenne::exprOddPow, and Couenne::exprSub.

Definition at line 86 of file CouenneExprOp.hpp.

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

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

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprQuad, and Couenne::exprGroup.

virtual expression* Couenne::exprOp::simplify ( )
virtual

simplification

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprQuad, Couenne::exprGroup, Couenne::exprPow, Couenne::exprMin, Couenne::exprMax, Couenne::exprDiv, Couenne::exprMul, Couenne::exprSum, Couenne::exprSub, Couenne::exprBinProd, and Couenne::exprMultiLin.

expression** Couenne::exprOp::clonearglist ( Domain *  d = NULL) const
inline

clone argument list (for use with clone method)

Definition at line 97 of file CouenneExprOp.hpp.

References arglist_, Couenne::expression::clone(), and nargs_.

Referenced by Couenne::exprTrilinear::clone(), Couenne::exprOddPow::clone(), Couenne::exprMul::clone(), Couenne::exprSub::clone(), Couenne::exprSum::clone(), Couenne::exprDiv::clone(), Couenne::exprMax::clone(), Couenne::exprEvenPow::clone(), Couenne::exprMin::clone(), Couenne::exprLBDiv::clone(), Couenne::exprPow::clone(), Couenne::exprLBMul::clone(), Couenne::exprUBDiv::clone(), and Couenne::exprUBMul::clone().

int Couenne::exprOp::shrink_arglist ( CouNumber  ,
CouNumber   
)

compress argument list

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

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

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprQuad, Couenne::exprGroup, Couenne::exprPow, Couenne::exprDiv, Couenne::exprMul, Couenne::exprSum, Couenne::exprSub, Couenne::exprBinProd, and Couenne::exprMultiLin.

Definition at line 110 of file CouenneExprOp.hpp.

References Couenne::NONLINEAR.

virtual exprAux* Couenne::exprOp::standardize ( CouenneProblem *  ,
bool  addAux = true 
)
virtual

generate auxiliary variable

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprPow, Couenne::exprDiv, Couenne::exprSub, Couenne::exprMul, Couenne::exprSum, Couenne::exprEvenPow, Couenne::exprOddPow, Couenne::exprBinProd, and Couenne::exprMultiLin.

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

return code to classify type of expression

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprQuad, Couenne::exprGroup, Couenne::exprPow, Couenne::exprMin, Couenne::exprMax, Couenne::exprDiv, Couenne::exprSub, Couenne::exprMul, Couenne::exprSum, Couenne::exprEvenPow, Couenne::exprOddPow, Couenne::exprBinProd, Couenne::exprMultiLin, and Couenne::exprTrilinear.

Definition at line 117 of file CouenneExprOp.hpp.

References Couenne::COU_EXPROP.

virtual bool Couenne::exprOp::isInteger ( )
virtual

is this expression integer?

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprQuad, Couenne::exprGroup, Couenne::exprDiv, and Couenne::exprPow.

virtual int Couenne::exprOp::compare ( exprOp &  )
virtual

compare with other generic exprOp

virtual int Couenne::exprOp::rank ( )
virtual

used in rank-based branching variable choice

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprQuad, and Couenne::exprGroup.

virtual void Couenne::exprOp::fillDepSet ( std::set< DepNode *, compNode > *  dep,
DepGraph *  g 
)
inlinevirtual

fill in dependence structure update dependence set with index of this variable

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprQuad, and Couenne::exprGroup.

Definition at line 131 of file CouenneExprOp.hpp.

References arglist_, and nargs_.

virtual void Couenne::exprOp::replace ( exprVar *  ,
exprVar *   
)
virtual

replace variable with other

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprQuad, and Couenne::exprGroup.

virtual void Couenne::exprOp::realign ( const CouenneProblem *  p)
virtual

empty function to redirect variables to proper variable vector

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprQuad, and Couenne::exprGroup.

Member Data Documentation

expression** Couenne::exprOp::arglist_
protected

argument list is an array of pointers to other expressions

Definition at line 35 of file CouenneExprOp.hpp.

Referenced by ArgList(), Couenne::exprLBCos::clone(), Couenne::exprLBSin::clone(), Couenne::exprUBCos::clone(), Couenne::exprUBSin::clone(), clonearglist(), Couenne::exprLBCos::exprLBCos(), Couenne::exprLBSin::exprLBSin(), Couenne::exprMax::exprMax(), Couenne::exprMin::exprMin(), exprOp(), Couenne::exprUBCos::exprUBCos(), Couenne::exprUBSin::exprUBSin(), fillDepSet(), Couenne::exprEvenPow::getFixVar(), Couenne::exprOddPow::getFixVar(), Couenne::exprPow::getFixVar(), Couenne::exprSub::Linearity(), Couenne::exprDiv::Linearity(), Couenne::exprEvenPow::operator()(), Couenne::exprSub::operator()(), Couenne::exprMul::operator()(), Couenne::exprOddPow::operator()(), Couenne::exprLBSin::operator()(), Couenne::exprSum::operator()(), Couenne::exprLBCos::operator()(), Couenne::exprDiv::operator()(), Couenne::exprMax::operator()(), Couenne::exprLBDiv::operator()(), Couenne::exprLBMul::operator()(), Couenne::exprMin::operator()(), Couenne::exprPow::operator()(), Couenne::exprUBSin::operator()(), Couenne::exprUBCos::operator()(), Couenne::exprUBDiv::operator()(), and Couenne::exprUBMul::operator()().

int Couenne::exprOp::nargs_
protected

number of arguments (cardinality of arglist)

Definition at line 36 of file CouenneExprOp.hpp.

Referenced by Couenne::exprTrilinear::clone(), Couenne::exprMul::clone(), Couenne::exprSub::clone(), Couenne::exprOddPow::clone(), Couenne::exprSum::clone(), Couenne::exprDiv::clone(), Couenne::exprMax::clone(), Couenne::exprEvenPow::clone(), Couenne::exprMin::clone(), Couenne::exprLBDiv::clone(), Couenne::exprPow::clone(), Couenne::exprLBMul::clone(), Couenne::exprUBDiv::clone(), Couenne::exprUBMul::clone(), clonearglist(), fillDepSet(), nArgs(), Couenne::exprMul::operator()(), Couenne::exprSum::operator()(), Couenne::exprMax::operator()(), and Couenne::exprMin::operator()().

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5