MINLPView::ObjConView Class Reference

Defines a view on a objective or constraint of a MINLP. More...

#include <MINLPView.h>

Inheritance diagram for MINLPView::ObjConView:

[legend]

List of all members.

Public Member Functions
virtual	~ObjConView ()
virtual int	dim () const =0
virtual const string &	name () const =0
virtual SepQcFunc::ftype	functype () const =0
virtual Func::CurvatureType	curvature () const =0
virtual double	evaluate (const UserVector< double > &x) const =0
	Evaluates the constraint.
virtual double	evaluate (const double *x) const
	Evaluates the constraint.
virtual void	gradient (UserVector< double > &grad, const UserVector< double > &x) const =0
	Computes the gradient of the constraint.
virtual void	gradient (double *grad, const double *x) const
	Computes the gradient of the constraint.
virtual double	gradientmult (const UserVector< double > &x, const UserVector< double > &factor) const
	Computes the product of the gradient of the constraint with a vector.
virtual double	evaluate_and_gradient (UserVector< double > &grad, const UserVector< double > &x) const
	Evaluates the constraint and computes is gradient.
virtual void	hessianmult (UserVector< double > &prod, const UserVector< double > &x, const UserVector< double > &factor) const =0
	Computes the product of the hessian with a vector.

---

Detailed Description

Defines a view on a objective or constraint of a MINLP.

Definition at line 20 of file MINLPView.h.

---

Constructor & Destructor Documentation

virtual MINLPView::ObjConView::~ObjConView

(

)

[inline, virtual]

Definition at line 22 of file MINLPView.h.

---

Member Function Documentation

virtual int MINLPView::ObjConView::dim

(

)

const [pure virtual]

Implemented in MINLP::ObjConView< ObjOrCon >, MINLP::ConstraintView, MINLP::ObjectiveView, MINLP::ObjConView< MINLPData::Objective >, and MINLP::ObjConView< MINLPData::Constraint >.

virtual const string& MINLPView::ObjConView::name

(

)

const [pure virtual]

Implemented in MINLP::ObjConView< ObjOrCon >, MINLP::ConstraintView, MINLP::ObjectiveView, MINLP::ObjConView< MINLPData::Objective >, and MINLP::ObjConView< MINLPData::Constraint >.

virtual SepQcFunc::ftype MINLPView::ObjConView::functype

(

)

const [pure virtual]

Implemented in MINLP::ObjConView< ObjOrCon >, MINLP::ConstraintView, MINLP::ObjectiveView, MINLP::ObjConView< MINLPData::Objective >, and MINLP::ObjConView< MINLPData::Constraint >.

virtual Func::CurvatureType MINLPView::ObjConView::curvature

(

)

const [pure virtual]

Implemented in MINLP::ObjConView< ObjOrCon >, MINLP::ConstraintView, MINLP::ObjectiveView, MINLP::ObjConView< MINLPData::Objective >, and MINLP::ObjConView< MINLPData::Constraint >.

virtual double MINLPView::ObjConView::evaluate

(

const UserVector< double > &

x

)

const [pure virtual]

Evaluates the constraint.

TODO: Can throw an evaluation exception.

Parameters:

x

The point where to evaluate the constraint.

Returns:

The value of the constraint in x.

Implemented in MINLP::ObjConView< ObjOrCon >, MINLP::ConstraintView, MINLP::ObjectiveView, MINLP::ObjConView< MINLPData::Objective >, and MINLP::ObjConView< MINLPData::Constraint >.

virtual double MINLPView::ObjConView::evaluate

(

const double *

x

)

const [inline, virtual]

Evaluates the constraint.

TODO: Can throw an evaluation exception.

Parameters:

x

The point where to evaluate the constraint.

Returns:

The value of the constraint in x.

Definition at line 41 of file MINLPView.h.

virtual void MINLPView::ObjConView::gradient	(	UserVector< double > &	grad,
		const UserVector< double > &	x
	)			const [pure virtual]

Computes the gradient of the constraint.

TODO: Can throw an evaluation exception.

Parameters:

	grad	The vector to store the gradient in.
	x	The point where to compute the gradient.

Implemented in MINLP::ObjConView< ObjOrCon >, MINLP::ConstraintView, MINLP::ObjectiveView, MINLP::ObjConView< MINLPData::Objective >, and MINLP::ObjConView< MINLPData::Constraint >.

virtual void MINLPView::ObjConView::gradient	(	double *	grad,
		const double *	x
	)			const [virtual]

Computes the gradient of the constraint.

TODO: Can throw an evaluation exception.

Parameters:

	grad	The vector to store the gradient in.
	x	The point where to compute the gradient.

virtual double MINLPView::ObjConView::gradientmult	(	const UserVector< double > &	x,
		const UserVector< double > &	factor
	)			const [virtual]

Computes the product of the gradient of the constraint with a vector.

TODO: Can throw an evaluation exception.

Parameters:

	x	The point where to compute the gradient.
	factor	The vector to multiply with.

Returns:

The product between gradient evaluated in x and the factor.

virtual double MINLPView::ObjConView::evaluate_and_gradient	(	UserVector< double > &	grad,
		const UserVector< double > &	x
	)			const [inline, virtual]

Evaluates the constraint and computes is gradient.

TODO: Can throw an evaluation exception.

Parameters:

	grad	The vector where the gradient is stored.
	x	The point where to evaluate the constraint and to compute the gradient.

Returns:

The value of the constraint.

Reimplemented in MINLP::ObjConView< ObjOrCon >, MINLP::ConstraintView, MINLP::ObjectiveView, MINLP::ObjConView< MINLPData::Objective >, and MINLP::ObjConView< MINLPData::Constraint >.

Definition at line 71 of file MINLPView.h.

virtual void MINLPView::ObjConView::hessianmult	(	UserVector< double > &	prod,
		const UserVector< double > &	x,
		const UserVector< double > &	factor
	)			const [pure virtual]

Computes the product of the hessian with a vector.

TODO: Can throw an evaluation exception.

Parameters:

	prod	The vector to store the product in.
	x	The point where to evaluate the constraint.
	factor	The vector to multiply the hessian with.

Implemented in MINLP::ObjConView< ObjOrCon >, MINLP::ConstraintView, MINLP::ObjectiveView, MINLP::ObjConView< MINLPData::Objective >, and MINLP::ObjConView< MINLPData::Constraint >.

---

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

• MINLPView.h