OPTPP::Constraint Class Reference

#include <Constraint.h>

List of all members.

Public Member Functions

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

Private Attributes

SmartPtr< ConstraintBaseptr_
 Smart Pointer to ConstraintBase.


Constructor & Destructor Documentation

OPTPP::Constraint::Constraint (  ) 

Default Constructor

See also:
Constraint(ConstraintBase* base)

OPTPP::Constraint::Constraint ( ConstraintBase base  ) 

Parameters:
base pointer to ConstraintBase
See also:
Constraint()


Member Function Documentation

bool OPTPP::Constraint::amIFeasible ( const NEWMAT::ColumnVector &  xcurrent,
double  epsilon 
) const

Takes two arguments and returns a bool.

Parameters:
xcurrent a ColumnVector
epsilon a real argument
Returns:
A bool

void OPTPP::Constraint::evalCFGH ( const NEWMAT::ColumnVector &  xcurrent  )  const

NEWMAT::Matrix OPTPP::Constraint::evalGradient ( const NEWMAT::ColumnVector &  xcurrent  )  const

Takes one argument and returns a real Matrix.

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

OptppArray<NEWMAT::SymmetricMatrix> OPTPP::Constraint::evalHessian ( NEWMAT::ColumnVector &  xcurrent,
int  darg 
) const

Takes two arguments and returns an array of real SymmetricMatrices.

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

NEWMAT::SymmetricMatrix OPTPP::Constraint::evalHessian ( NEWMAT::ColumnVector &  xcurrent  )  const

Takes one argument and returns a SymmetricMatrix

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

NEWMAT::ColumnVector OPTPP::Constraint::evalResidual ( const NEWMAT::ColumnVector &  xcurrent  )  const

Takes one argument and returns a ColumnVector of reals.

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

OptppArray< int > OPTPP::Constraint::getConstraintMappingIndices (  )  const

Returns:
Indices of constraints with finite bounds

ColumnVector OPTPP::Constraint::getConstraintType (  )  const

Returns:
Type of constraint

ColumnVector OPTPP::Constraint::getConstraintValue (  )  const

Returns:
The constraint violation

ColumnVector OPTPP::Constraint::getConstraintViolation (  )  const

Returns:
Value of the constraint

ColumnVector OPTPP::Constraint::getLower (  )  const

Returns:
Lower bounds on the variables.

int OPTPP::Constraint::getNumOfCons (  )  const

Returns:
Number of constraints.

int OPTPP::Constraint::getNumOfVars (  )  const

Returns:
Number of variables.

ColumnVector OPTPP::Constraint::getUpper (  )  const

Returns:
Upper bounds on the variables.


Member Data Documentation

SmartPtr<ConstraintBase> OPTPP::Constraint::ptr_ [private]

Smart Pointer to ConstraintBase.


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