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

expression class for unary functions (sin, log, etc.) More...

#include <CouenneExprUnary.hpp>

Inheritance diagram for Couenne::exprUnary:
Couenne::expression Couenne::exprAbs Couenne::exprCeil Couenne::exprCos Couenne::exprExp Couenne::exprFloor Couenne::exprInv Couenne::exprLog Couenne::exprOpp Couenne::exprSin

Public Member Functions

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 expression * Argument () 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...
 
expression * simplify ()
 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 exprAux * standardize (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 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 ** 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 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 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 * argument_
 single argument taken by this expression 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

expression class for unary functions (sin, log, etc.)

univariate operator-type expression: requires single argument. All unary functions are derived from this base class, which has a lot of common methods that need not be re-implemented by any univariate class.

Definition at line 33 of file CouenneExprUnary.hpp.

Constructor & Destructor Documentation

Couenne::exprUnary::exprUnary ( expression *  argument)
inline

Constructor.

Definition at line 47 of file CouenneExprUnary.hpp.

virtual Couenne::exprUnary::~exprUnary ( )
inlinevirtual

Destructor.

Definition at line 56 of file CouenneExprUnary.hpp.

References argument_.

Member Function Documentation

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

node type

Reimplemented from Couenne::expression.

Definition at line 43 of file CouenneExprUnary.hpp.

References Couenne::UNARY.

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

virtual unary_function Couenne::exprUnary::F ( )
inlinevirtual

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

Reimplemented in Couenne::exprSin, Couenne::exprInv, Couenne::exprOpp, Couenne::exprExp, Couenne::exprLog, Couenne::exprCeil, Couenne::exprCos, Couenne::exprFloor, and Couenne::exprAbs.

Definition at line 52 of file CouenneExprUnary.hpp.

References Couenne::zero_fun().

Referenced by operator()().

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

return number of arguments

Reimplemented from Couenne::expression.

Definition at line 60 of file CouenneExprUnary.hpp.

virtual expression* Couenne::exprUnary::Argument ( ) const
inlinevirtual

return argument

Reimplemented from Couenne::expression.

Definition at line 64 of file CouenneExprUnary.hpp.

References argument_.

virtual expression** Couenne::exprUnary::ArgPtr ( )
inlinevirtual

return pointer to argument

Reimplemented from Couenne::expression.

Definition at line 68 of file CouenneExprUnary.hpp.

References argument_.

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

print this expression to iostream

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprInv, and Couenne::exprOpp.

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

print position (PRE, INSIDE, POST)

Definition at line 75 of file CouenneExprUnary.hpp.

References Couenne::PRE.

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

print operator

Reimplemented in Couenne::exprSin, Couenne::exprAbs, Couenne::exprExp, Couenne::exprCeil, Couenne::exprCos, Couenne::exprFloor, and Couenne::exprLog.

Definition at line 79 of file CouenneExprUnary.hpp.

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

compute value of unary operator

Implements Couenne::expression.

Definition at line 83 of file CouenneExprUnary.hpp.

References F().

virtual int Couenne::exprUnary::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 88 of file CouenneExprUnary.hpp.

References argument_.

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

simplification

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprOpp.

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

get a measure of "how linear" the expression is (see CouenneTypes.h) for general univariate functions, return nonlinear.

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprInv, and Couenne::exprOpp.

Definition at line 96 of file CouenneExprUnary.hpp.

References Couenne::NONLINEAR.

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

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

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprOpp.

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

type of operator

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprSin, Couenne::exprInv, Couenne::exprOpp, Couenne::exprAbs, Couenne::exprCeil, Couenne::exprCos, Couenne::exprFloor, Couenne::exprExp, and Couenne::exprLog.

Definition at line 104 of file CouenneExprUnary.hpp.

References Couenne::COU_EXPRUNARY.

virtual bool Couenne::exprUnary::isInteger ( )
virtual

is this expression integer?

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprOpp, and Couenne::exprAbs.

Referenced by Couenne::exprCos::impliedBound(), and Couenne::exprSin::impliedBound().

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

compare two unary functions

virtual int Couenne::exprUnary::rank ( )
inlinevirtual

used in rank-based branching variable choice

Reimplemented from Couenne::expression.

Definition at line 114 of file CouenneExprUnary.hpp.

References argument_.

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

fill in dependence structure

Reimplemented from Couenne::expression.

Definition at line 118 of file CouenneExprUnary.hpp.

References argument_.

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

replace variable with other

Reimplemented from Couenne::expression.

virtual void Couenne::exprUnary::realign ( const CouenneProblem *  p)
inlinevirtual

empty function to redirect variables to proper variable vector

Reimplemented from Couenne::expression.

Definition at line 125 of file CouenneExprUnary.hpp.

References argument_.

Member Data Documentation

expression* Couenne::exprUnary::argument_
protected

single argument taken by this expression

Definition at line 38 of file CouenneExprUnary.hpp.

Referenced by ArgPtr(), Argument(), Couenne::exprFloor::clone(), Couenne::exprCeil::clone(), Couenne::exprCos::clone(), Couenne::exprLog::clone(), Couenne::exprExp::clone(), Couenne::exprAbs::clone(), Couenne::exprOpp::clone(), Couenne::exprInv::clone(), Couenne::exprSin::clone(), DepList(), fillDepSet(), Couenne::exprCeil::gradientNorm(), Couenne::exprFloor::gradientNorm(), Couenne::exprCos::gradientNorm(), Couenne::exprExp::gradientNorm(), Couenne::exprAbs::gradientNorm(), Couenne::exprOpp::gradientNorm(), Couenne::exprSin::gradientNorm(), Couenne::exprCos::impliedBound(), Couenne::exprSin::impliedBound(), Couenne::exprAbs::isInteger(), Couenne::exprOpp::isInteger(), Couenne::exprOpp::Linearity(), Couenne::exprInv::Linearity(), rank(), realign(), and ~exprUnary().

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