Couenne 0.5.8
Public Member Functions | List of all members
Couenne::exprSin Class Reference

class for $ \sin f(x)$ More...

#include <CouenneExprSin.hpp>

+ Inheritance diagram for Couenne::exprSin:
+ Collaboration diagram for Couenne::exprSin:

Public Member Functions

 exprSin (expression *al)
 Constructors, destructor. More...
 
expressionclone (Domain *d=NULL) const
 cloning method More...
 
unary_function F ()
 the operator itself (e.g. sin, log...) More...
 
std::string printOp () const
 print operator More...
 
CouNumber gradientNorm (const double *x)
 return l-2 norm of gradient at given point More...
 
expressiondifferentiate (int index)
 differentiation More...
 
void getBounds (expression *&, expression *&)
 Get lower and upper bound of an expression (if any) More...
 
void getBounds (CouNumber &lb, CouNumber &ub)
 Get value of lower and upper bound of an expression (if any) More...
 
void generateCuts (expression *w, OsiCuts &cs, const CouenneCutGenerator *cg, t_chg_bounds *=NULL, int=-1, CouNumber=-COUENNE_INFINITY, CouNumber=COUENNE_INFINITY)
 generate equality between *this and *w More...
 
virtual enum expr_type code ()
 code for comparisons More...
 
bool impliedBound (int index, CouNumber *l, CouNumber *u, t_chg_bounds *chg, enum auxSign=expression::AUX_EQ)
 implied bound processing 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 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...
 
- Public Member Functions inherited from Couenne::exprUnary
virtual enum nodeType Type () const
 node type More...
 
 exprUnary (expression *argument)
 Constructor. More...
 
virtual unary_function F ()
 the operator itself (e.g. sin, log...) More...
 
virtual ~exprUnary ()
 Destructor. More...
 
int nArgs () const
 return number of arguments More...
 
virtual expressionArgument () const
 return argument More...
 
virtual expression ** ArgPtr ()
 return pointer to argument More...
 
virtual void print (std::ostream &out=std::cout, bool=false) const
 print this expression to iostream More...
 
virtual enum pos printPos () const
 print position (PRE, INSIDE, POST) More...
 
virtual std::string printOp () const
 print operator More...
 
virtual CouNumber operator() ()
 compute value of unary 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...
 
expressionsimplify ()
 simplification More...
 
virtual int Linearity ()
 get a measure of "how linear" the expression is (see CouenneTypes.h) for general univariate functions, return nonlinear. More...
 
virtual exprAuxstandardize (CouenneProblem *, bool addAux=true)
 reduce expression in standard form, creating additional aux variables (and constraints) More...
 
virtual enum expr_type code ()
 type of operator More...
 
virtual bool isInteger ()
 is this expression integer? More...
 
virtual int compare (exprUnary &)
 compare two unary functions 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 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 expressionclone (Domain *d=NULL) const
 Cloning method. More...
 
virtual int Index () const
 Return index of variable (only valid for exprVar and exprAux) 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 enum nodeType Type () const
 node type 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 void print (std::ostream &s=std::cout, bool=false) const
 print expression to iostream 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 expressiondifferentiate (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 int DepList (std::set< int > &deplist, enum dig_type type=ORIG_ONLY)
 fill std::set with indices of variables on which this expression depends. More...
 
virtual expressionsimplify ()
 simplify expression (useful for derivatives) More...
 
virtual int Linearity ()
 get a measure of "how linear" the expression is (see CouenneTypes.h) More...
 
virtual bool isDefinedInteger ()
 is this expression defined as an integer? More...
 
virtual bool isInteger ()
 is this expression 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 exprAuxstandardize (CouenneProblem *p, bool addAux=true)
 Create standard form of this expression, by: 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 expr_type code ()
 return integer for comparing expressions (used to recognize common expression) 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 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}. 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 replace (exprVar *, exprVar *)
 replace expression with another More...
 
virtual void fillDepSet (std::set< DepNode *, compNode > *, DepGraph *)
 update dependence set with index of variables on which this expression depends More...
 
virtual void linkDomain (Domain *d)
 empty function to update domain pointer 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::exprUnary
expressionargument_
 single argument taken by this expression More...
 

Detailed Description

class for $ \sin f(x)$

Definition at line 47 of file CouenneExprSin.hpp.

Constructor & Destructor Documentation

◆ exprSin()

Couenne::exprSin::exprSin ( expression al)
inline

Constructors, destructor.

Definition at line 52 of file CouenneExprSin.hpp.

Member Function Documentation

◆ clone()

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

cloning method

Reimplemented from Couenne::expression.

Definition at line 56 of file CouenneExprSin.hpp.

◆ F()

unary_function Couenne::exprSin::F ( )
inlinevirtual

the operator itself (e.g. sin, log...)

Reimplemented from Couenne::exprUnary.

Definition at line 60 of file CouenneExprSin.hpp.

◆ printOp()

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

print operator

Reimplemented from Couenne::exprUnary.

Definition at line 64 of file CouenneExprSin.hpp.

◆ gradientNorm()

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

return l-2 norm of gradient at given point

Reimplemented from Couenne::expression.

Definition at line 68 of file CouenneExprSin.hpp.

◆ differentiate()

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

differentiation

Reimplemented from Couenne::expression.

◆ getBounds() [1/2]

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

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

Reimplemented from Couenne::expression.

◆ getBounds() [2/2]

void Couenne::exprSin::getBounds ( CouNumber lb,
CouNumber ub 
)
virtual

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

Reimplemented from Couenne::expression.

◆ generateCuts()

void Couenne::exprSin::generateCuts ( expression w,
OsiCuts cs,
const CouenneCutGenerator cg,
t_chg_bounds = NULL,
int  = -1,
CouNumber  = -COUENNE_INFINITY,
CouNumber  = COUENNE_INFINITY 
)
virtual

generate equality between *this and *w

Reimplemented from Couenne::expression.

◆ code()

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

code for comparisons

Reimplemented from Couenne::exprUnary.

Definition at line 90 of file CouenneExprSin.hpp.

◆ impliedBound()

bool Couenne::exprSin::impliedBound ( int  index,
CouNumber l,
CouNumber u,
t_chg_bounds chg,
enum  auxSign = expression::AUX_EQ 
)
inlinevirtual

implied bound processing

Reimplemented from Couenne::expression.

Definition at line 94 of file CouenneExprSin.hpp.

◆ selectBranch()

virtual CouNumber Couenne::exprSin::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.

Reimplemented from Couenne::expression.

Definition at line 111 of file CouenneExprSin.hpp.

◆ closestFeasible()

virtual void Couenne::exprSin::closestFeasible ( expression varind,
expression vardep,
CouNumber left,
CouNumber right 
) const
virtual

closest feasible points in function in both directions

Reimplemented from Couenne::expression.

◆ isCuttable()

virtual bool Couenne::exprSin::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 127 of file CouenneExprSin.hpp.


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