MINLP::ObjConView< ObjOrCon > Class Template Reference

Inheritance diagram for MINLP::ObjConView< ObjOrCon >:
Inheritance graph
[legend]
Collaboration diagram for MINLP::ObjConView< ObjOrCon >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ObjConView (const ObjOrCon &objcon_)
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.

Protected Attributes

const ObjOrCon & objcon

Detailed Description

template<class ObjOrCon>
class MINLP::ObjConView< ObjOrCon >

Definition at line 18 of file MINLP.h.


Constructor & Destructor Documentation

template<class ObjOrCon>
MINLP::ObjConView< ObjOrCon >::ObjConView ( const ObjOrCon &  objcon_  )  [inline]

Definition at line 22 of file MINLP.h.


Member Function Documentation

template<class ObjOrCon>
int MINLP::ObjConView< ObjOrCon >::dim (  )  const [inline, virtual]

Implements MINLPView::ObjConView.

Reimplemented in MINLP::ConstraintView, and MINLP::ObjectiveView.

Definition at line 26 of file MINLP.h.

template<class ObjOrCon>
const string& MINLP::ObjConView< ObjOrCon >::name (  )  const [inline, virtual]

Implements MINLPView::ObjConView.

Reimplemented in MINLP::ConstraintView, and MINLP::ObjectiveView.

Definition at line 27 of file MINLP.h.

template<class ObjOrCon>
SepQcFunc::ftype MINLP::ObjConView< ObjOrCon >::functype (  )  const [inline, virtual]

Implements MINLPView::ObjConView.

Reimplemented in MINLP::ConstraintView, and MINLP::ObjectiveView.

Definition at line 28 of file MINLP.h.

template<class ObjOrCon>
Func::CurvatureType MINLP::ObjConView< ObjOrCon >::curvature (  )  const [inline, virtual]

Implements MINLPView::ObjConView.

Reimplemented in MINLP::ConstraintView, and MINLP::ObjectiveView.

Definition at line 29 of file MINLP.h.

template<class ObjOrCon>
double MINLP::ObjConView< ObjOrCon >::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.

Implements MINLPView::ObjConView.

Reimplemented in MINLP::ConstraintView, and MINLP::ObjectiveView.

Definition at line 31 of file MINLP.h.

template<class ObjOrCon>
void MINLP::ObjConView< ObjOrCon >::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.

Implements MINLPView::ObjConView.

Reimplemented in MINLP::ConstraintView, and MINLP::ObjectiveView.

Definition at line 35 of file MINLP.h.

template<class ObjOrCon>
double MINLP::ObjConView< ObjOrCon >::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 MINLPView::ObjConView.

Reimplemented in MINLP::ConstraintView, and MINLP::ObjectiveView.

Definition at line 39 of file MINLP.h.

template<class ObjOrCon>
void MINLP::ObjConView< ObjOrCon >::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.

Implements MINLPView::ObjConView.

Reimplemented in MINLP::ConstraintView, and MINLP::ObjectiveView.

Definition at line 41 of file MINLP.h.


Member Data Documentation

template<class ObjOrCon>
const ObjOrCon& MINLP::ObjConView< ObjOrCon >::objcon [protected]

Definition at line 20 of file MINLP.h.


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

Generated on 10 Mar 2013 for LaGO by  doxygen 1.6.1