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

class sum, $ \sum_{i=1}^n f_i(x) $ More...

#include <CouenneExprSum.hpp>

Inheritance diagram for Couenne::exprSum:
Couenne::exprOp Couenne::expression Couenne::exprGroup Couenne::exprQuad

Public Member Functions

 exprSum (expression **=NULL, int=0)
 Constructors, destructor. More...
 
 exprSum (expression *, expression *)
 Constructor with two elements. More...
 
virtual ~exprSum ()
 Empty destructor. More...
 
virtual expressionclone (Domain *d=NULL) const
 Cloning method. More...
 
std::string printOp () const
 Print operator. More...
 
virtual CouNumber operator() ()
 Function for the evaluation of the expression. More...
 
virtual expressiondifferentiate (int index)
 Differentiation. More...
 
virtual expressionsimplify ()
 Simplification. More...
 
virtual int Linearity ()
 Get a measure of "how linear" the expression is: 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) More...
 
virtual exprAuxstandardize (CouenneProblem *p, bool addAux=true)
 Reduce expression in standard form, creating additional aux variables (and constraints) More...
 
virtual void generateCuts (expression *, OsiCuts &, const CouenneCutGenerator *, t_chg_bounds *=NULL, int=-1, CouNumber=-COUENNE_INFINITY, CouNumber=COUENNE_INFINITY)
 Special version for linear constraints. 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. More...
 
exprAuxcreateQuadratic (CouenneProblem *)
 Checks for quadratic terms in the expression and returns an exprQuad if there are enough to create something that can be convexified. More...
 
- Public Member Functions inherited from Couenne::exprOp
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 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...
 
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 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 int Index () const
 Return index of variable (only valid for exprVar and exprAux) 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 CouNumber gradientNorm (const double *x)
 return l-2 norm of gradient at given point 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 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 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 expressionCopy () const
 return copy of this expression (only makes sense in exprCopy) More...
 

Protected Member Functions

int impliedBoundSum (CouNumber wl, CouNumber wu, std::vector< CouNumber > &xl, std::vector< CouNumber > &xu, std::vector< std::pair< int, CouNumber > > &nl, std::vector< std::pair< int, CouNumber > > &nu)
 inferring bounds on factors of a product 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::exprOp
expression ** arglist_
 argument list is an array of pointers to other expressions More...
 
int nargs_
 number of arguments (cardinality of arglist) More...
 

Detailed Description

class sum, $ \sum_{i=1}^n f_i(x) $

Definition at line 22 of file CouenneExprSum.hpp.

Constructor & Destructor Documentation

Couenne::exprSum::exprSum ( expression **  = NULL,
int  = 0 
)

Constructors, destructor.

Referenced by clone().

Couenne::exprSum::exprSum ( expression ,
expression  
)

Constructor with two elements.

virtual Couenne::exprSum::~exprSum ( )
inlinevirtual

Empty destructor.

Definition at line 33 of file CouenneExprSum.hpp.

Member Function Documentation

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

Cloning method.

Reimplemented from Couenne::expression.

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

Definition at line 36 of file CouenneExprSum.hpp.

References Couenne::exprOp::clonearglist(), exprSum(), and Couenne::exprOp::nargs_.

std::string Couenne::exprSum::printOp ( ) const
inlinevirtual

Print operator.

Reimplemented from Couenne::exprOp.

Definition at line 40 of file CouenneExprSum.hpp.

CouNumber Couenne::exprSum::operator() ( )
inlinevirtual

Function for the evaluation of the expression.

compute sum

Implements Couenne::expression.

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

Definition at line 118 of file CouenneExprSum.hpp.

References Couenne::exprOp::arglist_, and Couenne::exprOp::nargs_.

Referenced by Couenne::exprGroup::operator()().

virtual expression* Couenne::exprSum::differentiate ( int  index)
virtual

Differentiation.

Reimplemented from Couenne::expression.

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

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

Simplification.

Reimplemented from Couenne::exprOp.

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

virtual int Couenne::exprSum::Linearity ( )
virtual

Get a measure of "how linear" the expression is:

Reimplemented from Couenne::exprOp.

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

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

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

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

Reimplemented from Couenne::expression.

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

virtual void Couenne::exprSum::getBounds ( CouNumber ,
CouNumber  
)
virtual

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

Reimplemented from Couenne::expression.

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

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

Reduce expression in standard form, creating additional aux variables (and constraints)

Reimplemented from Couenne::exprOp.

virtual void Couenne::exprSum::generateCuts ( expression ,
OsiCuts &  ,
const CouenneCutGenerator ,
t_chg_bounds = NULL,
int  = -1,
CouNumber  = -COUENNE_INFINITY,
CouNumber  = COUENNE_INFINITY 
)
virtual

Special version for linear constraints.

Reimplemented from Couenne::expression.

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

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

Code for comparison.

Reimplemented from Couenne::exprOp.

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

Definition at line 73 of file CouenneExprSum.hpp.

References Couenne::COU_EXPRSUM.

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

Implied bound.

An expression

$w = a0 + \sum_{i\in I1} a_i x_i + \sum_{i\in I2} a_i x_i$

is given such that all $a_i$ are positive for $i \in I1$ and negative for $i \in I2$. If the bounds on $w \in [l,u]$, implied bounds on all $x_i, i\in I1 \cup I2$ are as follows:

$\forall i\in I1$ $x_i \ge (l - a0 - \sum_{j\in I1 | j\neq i} a_j u_j - \sum_{j\in I2} a_j l_j) / a_i$ $x_i \le (u - a0 - \sum_{j\in I1 | j\neq i} a_j l_j - \sum_{j\in I2} a_j u_j) / a_i$

$\forall i\in I2$ $x_i \ge (u - a0 - \sum_{j\in I1} a_j u_j - \sum_{j\in I2 | j\neq i} a_j l_j) / a_i$ $x_i \le (l - a0 - \sum_{j\in I1} a_j l_j - \sum_{j\in I2 | j\neq i} a_j u_j) / a_i$,

where $l_i$ and $u_i$ are lower and upper bound, respectively, of $x_i$. We also have to check if some of these bounds are infinite.

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprQuad.

exprAux* Couenne::exprSum::createQuadratic ( CouenneProblem )

Checks for quadratic terms in the expression and returns an exprQuad if there are enough to create something that can be convexified.

int Couenne::exprSum::impliedBoundSum ( CouNumber  wl,
CouNumber  wu,
std::vector< CouNumber > &  xl,
std::vector< CouNumber > &  xu,
std::vector< std::pair< int, CouNumber > > &  nl,
std::vector< std::pair< int, CouNumber > > &  nu 
)
protected

inferring bounds on factors of a product


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