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::exprCopy Class Reference

#include <CouenneExprCopy.hpp>

Inheritance diagram for Couenne::exprCopy:
Couenne::expression Couenne::exprClone Couenne::exprStore

Public Member Functions

enum nodeType Type () const
 node type More...
 
 exprCopy (expression *copy)
 Empty constructor - used in cloning method of exprClone. More...
 
 exprCopy (const exprCopy &e, Domain *d=NULL)
 Copy constructor. More...
 
virtual ~exprCopy ()
 Destructor – CAUTION: this is the only destructive destructor, exprClone and exprStore do not destroy anything. More...
 
virtual expressionclone (Domain *d=NULL) const
 Cloning method. More...
 
const expressionOriginal () const
 If this is an exprClone of a exprClone of an expr???, point to the original expr??? instead of an exprClone – improves computing efficiency. More...
 
bool isaCopy () const
 return true if this is a copy of something, i.e. More...
 
expressionCopy () const
 return copy of this expression (only makes sense in exprCopy) More...
 
expressionImage () const
 return pointer to corresponding expression (for auxiliary variables only) More...
 
int Index () const
 Get variable index in problem. More...
 
int nArgs () const
 Return number of arguments (when applicable, that is, with N-ary functions) More...
 
expression ** ArgList () const
 return arglist (when applicable, that is, with N-ary functions) More...
 
void ArgList (expression **al)
 set arglist (used in deleting nodes without deleting children) More...
 
expressionArgument () const
 return argument (when applicable, i.e., with univariate functions) More...
 
expression ** ArgPtr ()
 return pointer to argument (when applicable, i.e., with univariate functions) More...
 
virtual void print (std::ostream &out=std::cout, bool descend=false) const
 I/O. More...
 
virtual CouNumber Value () const
 value More...
 
virtual CouNumber operator() ()
 null function for evaluating the expression More...
 
CouNumber gradientNorm (const double *x)
 return l-2 norm of gradient at given point More...
 
expressiondifferentiate (int index)
 differentiation More...
 
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...
 
expressionsimplify ()
 simplify expression (useful for derivatives) More...
 
int Linearity ()
 get a measure of "how linear" the expression is (see CouenneTypes.h) More...
 
bool isInteger ()
 is this expression integer? More...
 
virtual bool isDefinedInteger ()
 is this expression DEFINED as integer? More...
 
void getBounds (expression *&lower, expression *&upper)
 Get lower and upper bound of an expression (if any) More...
 
void getBounds (CouNumber &lower, CouNumber &upper)
 Get value of lower and upper bound of an expression (if any) More...
 
exprAuxstandardize (CouenneProblem *p, bool addAux=true)
 Create standard formulation of this expression. More...
 
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...
 
enum expr_type code ()
 code for comparisons More...
 
enum convexity convexity () const
 either CONVEX, CONCAVE, AFFINE, or NONCONVEX More...
 
int compare (expression &e)
 compare this with other expression More...
 
int rank ()
 used in rank-based branching variable choice More...
 
bool impliedBound (int wind, CouNumber *l, CouNumber *u, t_chg_bounds *chg)
 implied bound processing More...
 
int Multiplicity ()
 multiplicity of a variable: how many times this variable occurs in expressions throughout the problem More...
 
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...
 
void replace (exprVar *, exprVar *)
 replace occurrence of a variable with another variable More...
 
void fillDepSet (std::set< DepNode *, compNode > *dep, DepGraph *g)
 fill in dependence structure More...
 
void realign (const CouenneProblem *p)
 redirect variables to proper variable vector More...
 
bool isBijective () const
 indicating if function is monotonically increasing More...
 
CouNumber inverse (expression *vardep) const
 compute the inverse function More...
 
void closestFeasible (expression *varind, expression *vardep, CouNumber &left, CouNumber &right) const
 closest feasible points in function in both directions More...
 
bool isCuttable (CouenneProblem *problem, int index) const
 can this expression be further linearized or are we on its concave ("bad") side 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 void Image (expression *image)
 set expression associated with this auxiliary variable (for compatibility with exprAux) 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 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 void linkDomain (Domain *d)
 empty function to update domain pointer More...
 

Protected Attributes

expressioncopy_
 the expression this object is a (reference) copy of More...
 
CouNumber value_
 saved value to be used by exprStore expressions 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

Definition at line 25 of file CouenneExprCopy.hpp.

Constructor & Destructor Documentation

Couenne::exprCopy::exprCopy ( expression copy)
inline

Empty constructor - used in cloning method of exprClone.

Constructor

Definition at line 45 of file CouenneExprCopy.hpp.

Referenced by clone().

Couenne::exprCopy::exprCopy ( const exprCopy e,
Domain d = NULL 
)

Copy constructor.

virtual Couenne::exprCopy::~exprCopy ( )
inlinevirtual

Destructor – CAUTION: this is the only destructive destructor, exprClone and exprStore do not destroy anything.

Definition at line 55 of file CouenneExprCopy.hpp.

References copy_.

Member Function Documentation

enum nodeType Couenne::exprCopy::Type ( ) const
inlinevirtual

node type

Reimplemented from Couenne::expression.

Definition at line 38 of file CouenneExprCopy.hpp.

References copy_.

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

Cloning method.

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprStore, and Couenne::exprClone.

Definition at line 61 of file CouenneExprCopy.hpp.

References exprCopy().

const expression* Couenne::exprCopy::Original ( ) const
inlinevirtual

If this is an exprClone of a exprClone of an expr???, point to the original expr??? instead of an exprClone – improves computing efficiency.

Reimplemented from Couenne::expression.

Definition at line 67 of file CouenneExprCopy.hpp.

References copy_.

bool Couenne::exprCopy::isaCopy ( ) const
inlinevirtual

return true if this is a copy of something, i.e.

if it is an exprCopy or derivates

Reimplemented from Couenne::expression.

Definition at line 72 of file CouenneExprCopy.hpp.

Referenced by Copy().

expression* Couenne::exprCopy::Copy ( ) const
inlinevirtual

return copy of this expression (only makes sense in exprCopy)

Reimplemented from Couenne::expression.

Definition at line 76 of file CouenneExprCopy.hpp.

References copy_, and isaCopy().

expression* Couenne::exprCopy::Image ( ) const
inlinevirtual

return pointer to corresponding expression (for auxiliary variables only)

Reimplemented from Couenne::expression.

Definition at line 80 of file CouenneExprCopy.hpp.

References copy_.

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

Get variable index in problem.

Reimplemented from Couenne::expression.

Definition at line 84 of file CouenneExprCopy.hpp.

References copy_.

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

Return number of arguments (when applicable, that is, with N-ary functions)

Reimplemented from Couenne::expression.

Definition at line 88 of file CouenneExprCopy.hpp.

References copy_.

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

return arglist (when applicable, that is, with N-ary functions)

Reimplemented from Couenne::expression.

Definition at line 92 of file CouenneExprCopy.hpp.

References copy_.

Referenced by ArgList().

void Couenne::exprCopy::ArgList ( expression **  al)
inlinevirtual

set arglist (used in deleting nodes without deleting children)

Reimplemented from Couenne::expression.

Definition at line 96 of file CouenneExprCopy.hpp.

References ArgList(), and copy_.

expression* Couenne::exprCopy::Argument ( ) const
inlinevirtual

return argument (when applicable, i.e., with univariate functions)

Reimplemented from Couenne::expression.

Definition at line 100 of file CouenneExprCopy.hpp.

References copy_.

expression** Couenne::exprCopy::ArgPtr ( )
inlinevirtual

return pointer to argument (when applicable, i.e., with univariate functions)

Reimplemented from Couenne::expression.

Definition at line 104 of file CouenneExprCopy.hpp.

References copy_.

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

I/O.

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprClone, and Couenne::exprStore.

virtual CouNumber Couenne::exprCopy::Value ( ) const
inlinevirtual

value

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprClone.

Definition at line 112 of file CouenneExprCopy.hpp.

References value_.

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

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

null function for evaluating the expression

Implements Couenne::expression.

Reimplemented in Couenne::exprClone, and Couenne::exprStore.

Definition at line 116 of file CouenneExprCopy.hpp.

References copy_, and value_.

CouNumber Couenne::exprCopy::gradientNorm ( const double *  x)
inlinevirtual

return l-2 norm of gradient at given point

Reimplemented from Couenne::expression.

Definition at line 122 of file CouenneExprCopy.hpp.

References copy_.

expression* Couenne::exprCopy::differentiate ( int  index)
inlinevirtual

differentiation

Reimplemented from Couenne::expression.

Definition at line 126 of file CouenneExprCopy.hpp.

References copy_.

int Couenne::exprCopy::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.

Definition at line 131 of file CouenneExprCopy.hpp.

References copy_.

expression* Couenne::exprCopy::simplify ( )
inlinevirtual

simplify expression (useful for derivatives)

Reimplemented from Couenne::expression.

Definition at line 136 of file CouenneExprCopy.hpp.

References copy_.

int Couenne::exprCopy::Linearity ( )
inlinevirtual

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

Reimplemented from Couenne::expression.

Definition at line 140 of file CouenneExprCopy.hpp.

References copy_.

bool Couenne::exprCopy::isInteger ( )
inlinevirtual

is this expression integer?

Reimplemented from Couenne::expression.

Definition at line 143 of file CouenneExprCopy.hpp.

References copy_.

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

is this expression DEFINED as integer?

Reimplemented from Couenne::expression.

Definition at line 147 of file CouenneExprCopy.hpp.

References copy_.

void Couenne::exprCopy::getBounds ( expression *&  lower,
expression *&  upper 
)
inlinevirtual

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

Reimplemented from Couenne::expression.

Definition at line 151 of file CouenneExprCopy.hpp.

References copy_.

Referenced by getBounds().

void Couenne::exprCopy::getBounds ( CouNumber lower,
CouNumber upper 
)
inlinevirtual

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

Reimplemented from Couenne::expression.

Definition at line 155 of file CouenneExprCopy.hpp.

References copy_, and getBounds().

exprAux* Couenne::exprCopy::standardize ( CouenneProblem p,
bool  addAux = true 
)
inlinevirtual

Create standard formulation of this expression.

Reimplemented from Couenne::expression.

Definition at line 160 of file CouenneExprCopy.hpp.

References copy_.

void Couenne::exprCopy::generateCuts ( expression w,
OsiCuts &  cs,
const CouenneCutGenerator cg,
t_chg_bounds chg = NULL,
int  wind = -1,
CouNumber  lb = -COUENNE_INFINITY,
CouNumber  ub = COUENNE_INFINITY 
)
inlinevirtual

generate convexification cut for constraint w = this

Reimplemented from Couenne::expression.

Definition at line 164 of file CouenneExprCopy.hpp.

References copy_.

enum expr_type Couenne::exprCopy::code ( )
inlinevirtual

code for comparisons

Reimplemented from Couenne::expression.

Definition at line 173 of file CouenneExprCopy.hpp.

References copy_.

enum convexity Couenne::exprCopy::convexity ( ) const
inlinevirtual

either CONVEX, CONCAVE, AFFINE, or NONCONVEX

Reimplemented from Couenne::expression.

Definition at line 177 of file CouenneExprCopy.hpp.

References copy_.

int Couenne::exprCopy::compare ( expression e)
inlinevirtual

compare this with other expression

Reimplemented from Couenne::expression.

Definition at line 181 of file CouenneExprCopy.hpp.

References copy_.

int Couenne::exprCopy::rank ( )
inlinevirtual

used in rank-based branching variable choice

Reimplemented from Couenne::expression.

Definition at line 185 of file CouenneExprCopy.hpp.

References copy_.

bool Couenne::exprCopy::impliedBound ( int  wind,
CouNumber l,
CouNumber u,
t_chg_bounds chg 
)
inline

implied bound processing

Definition at line 189 of file CouenneExprCopy.hpp.

References copy_.

int Couenne::exprCopy::Multiplicity ( )
inlinevirtual

multiplicity of a variable: how many times this variable occurs in expressions throughout the problem

Reimplemented from Couenne::expression.

Definition at line 194 of file CouenneExprCopy.hpp.

References copy_.

CouNumber Couenne::exprCopy::selectBranch ( const CouenneObject obj,
const OsiBranchingInformation *  info,
expression *&  var,
double *&  brpts,
double *&  brDist,
int &  way 
)
inlinevirtual

Set up branching object by evaluating many branching points for each expression's arguments.

Return estimated improvement in objective function

Reimplemented from Couenne::expression.

Definition at line 199 of file CouenneExprCopy.hpp.

References copy_.

void Couenne::exprCopy::replace ( exprVar ,
exprVar  
)
virtual

replace occurrence of a variable with another variable

Reimplemented from Couenne::expression.

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

fill in dependence structure

Reimplemented from Couenne::expression.

Definition at line 213 of file CouenneExprCopy.hpp.

References copy_.

void Couenne::exprCopy::realign ( const CouenneProblem p)
virtual

redirect variables to proper variable vector

Reimplemented from Couenne::expression.

bool Couenne::exprCopy::isBijective ( ) const
inlinevirtual

indicating if function is monotonically increasing

Reimplemented from Couenne::expression.

Definition at line 221 of file CouenneExprCopy.hpp.

References copy_.

CouNumber Couenne::exprCopy::inverse ( expression vardep) const
inlinevirtual

compute the inverse function

Reimplemented from Couenne::expression.

Definition at line 225 of file CouenneExprCopy.hpp.

References copy_.

void Couenne::exprCopy::closestFeasible ( expression varind,
expression vardep,
CouNumber left,
CouNumber right 
) const
inlinevirtual

closest feasible points in function in both directions

Reimplemented from Couenne::expression.

Definition at line 229 of file CouenneExprCopy.hpp.

References copy_.

bool Couenne::exprCopy::isCuttable ( CouenneProblem problem,
int  index 
) const
inlinevirtual

can this expression be further linearized or are we on its concave ("bad") side

Reimplemented from Couenne::expression.

Definition at line 235 of file CouenneExprCopy.hpp.

References copy_.

Member Data Documentation

expression* Couenne::exprCopy::copy_
protected
CouNumber Couenne::exprCopy::value_
protected

saved value to be used by exprStore expressions

Definition at line 33 of file CouenneExprCopy.hpp.

Referenced by operator()(), and Value().


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