class Group, with constant, linear and nonlinear terms: $a_0 + \sum_{i=1}^n a_i x_i$ More...

#include <CouenneExprGroup.hpp>

Inheritance diagram for Couenne::exprGroup:

Collaboration diagram for Couenne::exprGroup:

Public Types
typedef std::vector< std::pair < exprVar *, CouNumber > >	lincoeff

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...

Public Member Functions
	exprGroup (CouNumber, lincoeff &, expression **=NULL, int=0)
	Constructor. More...

	exprGroup (const exprGroup &src, Domain *d=NULL)
	Copy constructor. More...

virtual	~exprGroup ()
	Destructor – needed to clear bounds. More...

virtual expression *	clone (Domain *d=NULL) const
	Cloning method. More...

CouNumber	getc0 ()
	return constant term More...

lincoeff &	lcoeff () const
	return linear term coefficients More...

virtual void	print (std::ostream &=std::cout, bool=false) const
	Print expression to iostream. More...

virtual CouNumber	operator() ()
	function for the evaluation of the expression More...

virtual CouNumber	gradientNorm (const double *x)
	return l-2 norm of gradient at given point 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 *	differentiate (int index)
	differentiation More...

virtual expression *	simplify ()
	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 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 int	compare (exprGroup &)
	only compare with people of the same kind More...

virtual enum expr_type	code ()
	code for comparisons More...

virtual bool	isInteger ()
	is this expression integer? More...

virtual int	rank ()
	used in rank-based branching variable choice More...

virtual void	fillDepSet (std::set< DepNode , compNode > , DepGraph *)
	update dependence set with index of this variable More...

virtual void	replace (exprVar x, exprVar w)
	replace variable x with new (aux) w More...

virtual void	realign (const CouenneProblem *p)
	redirect variables to proper variable vector More...

Public Member Functions inherited from Couenne::exprSum
	exprSum (expression **=NULL, int=0)
	Constructors, destructor. More...

	exprSum (expression , expression )
	Constructor with two elements. More...

virtual	~exprSum ()
	Empty destructor. More...

std::string	printOp () const
	Print operator. More...

virtual exprAux *	standardize (CouenneProblem *p, bool addAux=true)
	Reduce expression in standard form, creating additional aux variables (and constraints) More...

virtual bool	impliedBound (int, CouNumber , CouNumber , t_chg_bounds *, enum auxSign=expression::AUX_EQ)
	Implied bound. More...

exprAux *	createQuadratic (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 enum pos	printPos () const
	print position (PRE, INSIDE, POST) 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	compare (exprOp &)
	compare with other generic exprOp 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 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 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 expression *	Copy () const
	return copy of this expression (only makes sense in exprCopy) More...

Static Public Member Functions
static expression *	genExprGroup (CouNumber, lincoeff &, expression **=NULL, int=0)
	Generalized (static) constructor: check parameters and return a constant, a single variable, or a real exprGroup. More...

Protected Attributes
lincoeff	lcoeff_
	coefficients and indices of the linear term More...

CouNumber	c0_
	constant term 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...

Additional Inherited Members
Protected Member Functions inherited from Couenne::exprSum
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...

Detailed Description

class Group, with constant, linear and nonlinear terms: $a_0 + \sum_{i=1}^n a_i x_i$

Definition at line 25 of file CouenneExprGroup.hpp.

Member Typedef Documentation

typedef std::vector<std::pair <exprVar *, CouNumber> > Couenne::exprGroup::lincoeff

Definition at line 29 of file CouenneExprGroup.hpp.

Constructor & Destructor Documentation

Couenne::exprGroup::exprGroup	(	CouNumber	,
		lincoeff &	,
		expression **	= `NULL`,
		int	= `0`
	)

Constructor.

exprGroup::exprGroup	(	const exprGroup &	src,
		Domain *	d = `NULL`
	)

Copy constructor.

copy constructor

Definition at line 89 of file exprGroup.cpp.

exprGroup::~exprGroup ( )

virtual

Destructor – needed to clear bounds.

Destructor – check if there are exprBounds and delete them.

Definition at line 102 of file exprGroup.cpp.

Member Function Documentation

expression * exprGroup::genExprGroup	(	CouNumber	,
		lincoeff &	,
		expression **	= `NULL`,
		int	= `0`
	)

static

Generalized (static) constructor: check parameters and return a constant, a single variable, or a real exprGroup.

Definition at line 50 of file exprGroup.cpp.

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

inlinevirtual

Cloning method.

Reimplemented from Couenne::exprSum.

Reimplemented in Couenne::exprQuad.

Definition at line 58 of file CouenneExprGroup.hpp.

CouNumber Couenne::exprGroup::getc0 ( )

inline

return constant term

Definition at line 62 of file CouenneExprGroup.hpp.

lincoeff& Couenne::exprGroup::lcoeff ( ) const

inline

return linear term coefficients

Definition at line 63 of file CouenneExprGroup.hpp.

void exprGroup::print	(	std::ostream &	out = `std::cout`,
		bool	descend = `false`
	)		const

virtual

Print expression to iostream.

I/O.

Reimplemented from Couenne::exprOp.

Reimplemented in Couenne::exprQuad.

Definition at line 114 of file exprGroup.cpp.

CouNumber Couenne::exprGroup::operator() ( )

inlinevirtual

function for the evaluation of the expression

compute sum of linear and nonlinear terms

Reimplemented from Couenne::exprSum.

Reimplemented in Couenne::exprQuad.

Definition at line 127 of file CouenneExprGroup.hpp.

CouNumber exprGroup::gradientNorm ( const double * x )

virtual

return l-2 norm of gradient at given point

return l-2 norm of gradient at given point.

Not needed for now, as we only use it with nonlinear operators

Reimplemented from Couenne::expression.

Reimplemented in Couenne::exprQuad.

Definition at line 375 of file exprGroup.cpp.

int exprGroup::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::exprOp.

Reimplemented in Couenne::exprQuad.

Definition at line 263 of file exprGroup.cpp.

expression * exprGroup::differentiate ( int index )

virtual

differentiation

Reimplemented from Couenne::exprSum.

Reimplemented in Couenne::exprQuad.

Definition at line 149 of file exprGroup.cpp.

expression * exprGroup::simplify ( )

virtual

simplification

Reimplemented from Couenne::exprSum.

Reimplemented in Couenne::exprQuad.

Definition at line 406 of file exprGroup.cpp.

int exprGroup::Linearity ( )

virtual

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

Reimplemented from Couenne::exprSum.

Reimplemented in Couenne::exprQuad.

Definition at line 178 of file exprGroup.cpp.

void exprGroup::getBounds	(	expression *&	lb,
		expression *&	ub
	)

virtual

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

Reimplemented from Couenne::exprSum.

Reimplemented in Couenne::exprQuad.

Definition at line 25 of file conv-exprGroup.cpp.

void exprGroup::getBounds	(	CouNumber &	lb,
		CouNumber &	ub
	)

virtual

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

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

Reimplemented from Couenne::exprSum.

Reimplemented in Couenne::exprQuad.

Definition at line 136 of file conv-exprGroup.cpp.

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

virtual

special version for linear constraints

Reimplemented from Couenne::exprSum.

Reimplemented in Couenne::exprQuad.

Definition at line 194 of file conv-exprGroup.cpp.

int exprGroup::compare ( exprGroup & e )

virtual

only compare with people of the same kind

compare affine terms

Definition at line 191 of file exprGroup.cpp.

virtual enum expr_type Couenne::exprGroup::code ( )

inlinevirtual

code for comparisons

Reimplemented from Couenne::exprSum.

Reimplemented in Couenne::exprQuad.

Definition at line 106 of file CouenneExprGroup.hpp.

bool exprGroup::isInteger ( )

virtual

is this expression integer?

is this linear term integer?

Reimplemented from Couenne::exprOp.

Reimplemented in Couenne::exprQuad.

Definition at line 289 of file exprGroup.cpp.

int exprGroup::rank ( )

virtual

used in rank-based branching variable choice

Reimplemented from Couenne::exprOp.

Reimplemented in Couenne::exprQuad.

Definition at line 233 of file exprGroup.cpp.

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

virtual

update dependence set with index of this variable

Reimplemented from Couenne::exprOp.

Reimplemented in Couenne::exprQuad.

Definition at line 252 of file exprGroup.cpp.

void exprGroup::replace	(	exprVar *	x,
		exprVar *	w
	)

virtual

replace variable x with new (aux) w

Reimplemented from Couenne::exprOp.

Reimplemented in Couenne::exprQuad.

Definition at line 324 of file exprGroup.cpp.

void exprGroup::realign ( const CouenneProblem * p )

virtual

redirect variables to proper variable vector

Redirect variables to proper variable vector.

Reimplemented from Couenne::exprOp.

Reimplemented in Couenne::exprQuad.

Definition at line 387 of file exprGroup.cpp.

Member Data Documentation

lincoeff Couenne::exprGroup::lcoeff_

mutableprotected

coefficients and indices of the linear term

Definition at line 33 of file CouenneExprGroup.hpp.

CouNumber Couenne::exprGroup::c0_

protected

constant term

Definition at line 34 of file CouenneExprGroup.hpp.

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

/tmp/OS-2.10.2/Couenne/src/expression/operators/CouenneExprGroup.hpp
/tmp/OS-2.10.2/Couenne/src/convex/operators/conv-exprGroup.cpp
/tmp/OS-2.10.2/Couenne/src/expression/operators/exprGroup.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation