MINLP::ObjectiveView Class Reference

#include <MINLP.h>

Inheritance diagram for MINLP::ObjectiveView:

[legend]

Collaboration diagram for MINLP::ObjectiveView:

[legend]

List of all members.

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

---

Detailed Description

Definition at line 69 of file MINLP.h.

---

Constructor & Destructor Documentation

MINLP::ObjectiveView::ObjectiveView

(

const MINLPData::Objective &

obj_

)

[inline]

Definition at line 71 of file MINLP.h.

---

Member Function Documentation

int MINLP::ObjectiveView::dim

(

)

const [inline, virtual]

Reimplemented from MINLP::ObjConView< MINLPData::Objective >.

Definition at line 75 of file MINLP.h.

const string& MINLP::ObjectiveView::name

(

)

const [inline, virtual]

Reimplemented from MINLP::ObjConView< MINLPData::Objective >.

Definition at line 76 of file MINLP.h.

SepQcFunc::ftype MINLP::ObjectiveView::functype

(

)

const [inline, virtual]

Reimplemented from MINLP::ObjConView< MINLPData::Objective >.

Definition at line 77 of file MINLP.h.

Func::CurvatureType MINLP::ObjectiveView::curvature

(

)

const [inline, virtual]

Reimplemented from MINLP::ObjConView< MINLPData::Objective >.

Definition at line 78 of file MINLP.h.

double MINLP::ObjectiveView::evaluate

(

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

Reimplemented from MINLP::ObjConView< MINLPData::Objective >.

Definition at line 80 of file MINLP.h.

void MINLP::ObjectiveView::gradient	(	UserVector< double > &	grad,
		const UserVector< double > &	x
	)			const [inline, 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.

Reimplemented from MINLP::ObjConView< MINLPData::Objective >.

Definition at line 83 of file MINLP.h.

double MINLP::ObjectiveView::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 from MINLP::ObjConView< MINLPData::Objective >.

Definition at line 86 of file MINLP.h.

void MINLP::ObjectiveView::hessianmult	(	UserVector< double > &	prod,
		const UserVector< double > &	x,
		const UserVector< double > &	factor
	)			const [inline, 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.

Reimplemented from MINLP::ObjConView< MINLPData::Objective >.

Definition at line 88 of file MINLP.h.

---

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

• MINLP.h