OPTPP::ConstraintBase Class Reference

#include <ConstraintBase.h>

Inheritance diagram for OPTPP::ConstraintBase:

OPTPP::BoundConstraint OPTPP::CompoundConstraint OPTPP::LinearConstraint OPTPP::NonLinearConstraint OPTPP::LinearEquation OPTPP::LinearInequality OPTPP::NonLinearEquation OPTPP::NonLinearInequality List of all members.

Public Member Functions

virtual ~ConstraintBase ()
virtual int getNumOfCons () const =0
virtual int getNumOfVars () const =0
virtual NEWMAT::ColumnVector getLower () const =0
virtual NEWMAT::ColumnVector getUpper () const =0
virtual NEWMAT::ColumnVector getConstraintType () const =0
virtual NEWMAT::ColumnVector getConstraintValue () const =0
virtual NEWMAT::ColumnVector getConstraintViolation () const =0
virtual OptppArray< int > getConstraintMappingIndices () const =0
virtual NEWMAT::ColumnVector evalResidual (const NEWMAT::ColumnVector &xcurrent) const =0
virtual void evalCFGH (const NEWMAT::ColumnVector &xcurrent) const =0
virtual NEWMAT::Matrix evalGradient (const NEWMAT::ColumnVector &xcurrent) const =0
virtual NEWMAT::SymmetricMatrix evalHessian (NEWMAT::ColumnVector &xcurrent) const =0
virtual OptppArray< NEWMAT::SymmetricMatrix > evalHessian (NEWMAT::ColumnVector &xcurrent, int darg) const =0
virtual bool amIFeasible (const NEWMAT::ColumnVector &xcurrent, double epsilon) const =0

Constructor & Destructor Documentation

virtual OPTPP::ConstraintBase::~ConstraintBase (  )  [inline, virtual]

Destructor


Member Function Documentation

virtual bool OPTPP::ConstraintBase::amIFeasible ( const NEWMAT::ColumnVector &  xcurrent,
double  epsilon 
) const [pure virtual]

Takes two arguments and returns a bool.

Parameters:
xcurrent a ColumnVector
epsilon a real argument.
Returns:
The feasibility of the nonlinear equations at xcurrent.

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, OPTPP::LinearEquation, OPTPP::LinearInequality, OPTPP::NonLinearConstraint, OPTPP::NonLinearConstraint, OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual void OPTPP::ConstraintBase::evalCFGH ( const NEWMAT::ColumnVector &  xcurrent  )  const [pure virtual]

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, OPTPP::LinearEquation, OPTPP::LinearInequality, OPTPP::NonLinearConstraint, OPTPP::NonLinearConstraint, OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual NEWMAT::Matrix OPTPP::ConstraintBase::evalGradient ( const NEWMAT::ColumnVector &  xcurrent  )  const [pure virtual]

Takes one argument and returns a Matrix.

Parameters:
xcurrent a ColumnVector
Returns:
The gradient of the constraints evaluated at xcurrent.

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, OPTPP::LinearEquation, OPTPP::LinearInequality, OPTPP::NonLinearConstraint, OPTPP::NonLinearConstraint, OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual OptppArray<NEWMAT::SymmetricMatrix> OPTPP::ConstraintBase::evalHessian ( NEWMAT::ColumnVector &  xcurrent,
int  darg 
) const [pure virtual]

Takes two arguments and returns an array of real SymmetricMatrices.

Parameters:
xcurrent a ColumnVector
darg an integer argument
Returns:
An array of constraint Hessians.

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, OPTPP::NonLinearConstraint, OPTPP::NonLinearConstraint, OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual NEWMAT::SymmetricMatrix OPTPP::ConstraintBase::evalHessian ( NEWMAT::ColumnVector &  xcurrent  )  const [pure virtual]

Takes one arguments and returns a SymmetricMatrix

Parameters:
xcurrent a ColumnVector
Returns:
The constraint Hessian evaluated at xcurrent.

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, OPTPP::NonLinearConstraint, OPTPP::NonLinearConstraint, OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual NEWMAT::ColumnVector OPTPP::ConstraintBase::evalResidual ( const NEWMAT::ColumnVector &  xcurrent  )  const [pure virtual]

Takes one argument and returns a ColumnVector.

Parameters:
xcurrent a ColumnVector
Returns:
The gradient of the constraints evaluated at xcurrent.

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, OPTPP::LinearEquation, OPTPP::LinearInequality, OPTPP::NonLinearConstraint, OPTPP::NonLinearConstraint, OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual OptppArray<int> OPTPP::ConstraintBase::getConstraintMappingIndices (  )  const [pure virtual]

Returns:
Indices of constraints with finite bounds.

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, and OPTPP::NonLinearConstraint.

virtual NEWMAT::ColumnVector OPTPP::ConstraintBase::getConstraintType (  )  const [pure virtual]

Returns:
Type of constraints.

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, OPTPP::LinearEquation, OPTPP::LinearInequality, OPTPP::NonLinearConstraint, OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual NEWMAT::ColumnVector OPTPP::ConstraintBase::getConstraintValue (  )  const [pure virtual]

Returns:
Value of constraints.

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, and OPTPP::NonLinearConstraint.

virtual NEWMAT::ColumnVector OPTPP::ConstraintBase::getConstraintViolation (  )  const [pure virtual]

Returns:
The constraint violation.

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, and OPTPP::NonLinearConstraint.

virtual NEWMAT::ColumnVector OPTPP::ConstraintBase::getLower (  )  const [pure virtual]

Returns:
Lower bounds on the constraints

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, and OPTPP::NonLinearConstraint.

virtual int OPTPP::ConstraintBase::getNumOfCons (  )  const [pure virtual]

Returns:
Number of constraints.

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, and OPTPP::NonLinearConstraint.

virtual int OPTPP::ConstraintBase::getNumOfVars (  )  const [pure virtual]

Returns:
Number of variables.

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, and OPTPP::NonLinearConstraint.

virtual NEWMAT::ColumnVector OPTPP::ConstraintBase::getUpper (  )  const [pure virtual]

Returns:
Upper bounds on the constraints

Implemented in OPTPP::BoundConstraint, OPTPP::CompoundConstraint, OPTPP::LinearConstraint, and OPTPP::NonLinearConstraint.


The documentation for this class was generated from the following file:
Bug Reports    OPT++ Developers    Copyright Information    GNU Lesser General Public License
Documentation, generated by , last revised August 30, 2006.