OPTPP::NonLinearConstraint Class Reference

#include <NonLinearConstraint.h>

Inheritance diagram for OPTPP::NonLinearConstraint:

OPTPP::ConstraintBase OPTPP::NonLinearEquation OPTPP::NonLinearInequality List of all members.

Public Member Functions

 NonLinearConstraint ()
 NonLinearConstraint (NLP *nlprob, int numconstraints=1)
 NonLinearConstraint (NLP *nlprob, const bool conFlag, int numconstraints=1)
 NonLinearConstraint (NLP *nlprob, const NEWMAT::ColumnVector &rhs, int numconstraints=1)
 NonLinearConstraint (NLP *nlprob, const NEWMAT::ColumnVector &rhs, const bool conFlag=true, int numconstraints=1)
 NonLinearConstraint (NLP *nlprob, const NEWMAT::ColumnVector &lower, const NEWMAT::ColumnVector &upper, int numconstraints=1)
 NonLinearConstraint (NLP *nlprob, const NEWMAT::ColumnVector &lower, const NEWMAT::ColumnVector &upper, int ne, int ni)
virtual ~NonLinearConstraint ()
virtual int getNumOfCons () const
virtual int getNumOfVars () const
virtual NEWMAT::ColumnVector getLower () const
virtual NEWMAT::ColumnVector getUpper () const
virtual NEWMAT::ColumnVector getConstraintValue () const
virtual NEWMAT::ColumnVector getConstraintViolation () const
virtual OptppArray< int > getConstraintMappingIndices () const
virtual NEWMAT::ColumnVector getConstraintType () const
virtual NEWMAT::ColumnVector evalResidual (const NEWMAT::ColumnVector &xc) const
virtual void evalCFGH (const NEWMAT::ColumnVector &xc) const
virtual NEWMAT::Matrix evalGradient (const NEWMAT::ColumnVector &xc) const
virtual NEWMAT::SymmetricMatrix evalHessian (NEWMAT::ColumnVector &xc) const
virtual OptppArray< NEWMAT::SymmetricMatrix > evalHessian (NEWMAT::ColumnVector &xc, int darg) const
virtual bool amIFeasible (const NEWMAT::ColumnVector &xc, double epsilon) const
virtual NEWMAT::ColumnVector evalResidual (const NEWMAT::ColumnVector &xc) const =0
virtual void evalCFGH (const NEWMAT::ColumnVector &xc) const =0
virtual NEWMAT::Matrix evalGradient (const NEWMAT::ColumnVector &xc) const =0
virtual NEWMAT::SymmetricMatrix evalHessian (NEWMAT::ColumnVector &xc) const =0
virtual OptppArray< NEWMAT::SymmetricMatrix > evalHessian (NEWMAT::ColumnVector &xc, int darg) const =0
virtual bool amIFeasible (const NEWMAT::ColumnVector &xc, double epsilon) const =0

Protected Attributes

NLPnlp_
 Pointer to an NLP object.
NEWMAT::ColumnVector lower_
 Lower bounds on the nonlinear constraints.
NEWMAT::ColumnVector upper_
 Upper bounds on the nonlinear constraints.
NEWMAT::ColumnVector cvalue_
 Value of the nonlinear constraints.
NEWMAT::ColumnVector cviolation_
 Nonlinear constraint violation.
int numOfCons_
 Number of nonlinear constraints.
int numOfVars_
 Number of variables.
int nnzl_
 Number of finite lower bounds.
int nnzu_
 Number of finite upper bounds.
OptppArray< int > constraintMappingIndices_
 Indices of finite bounds.
bool stdForm_
 Standard representation of constraint.
NEWMAT::ColumnVector ctype_
 Type of constraint.

Constructor & Destructor Documentation

OPTPP::NonLinearConstraint::NonLinearConstraint (  ) 

Default Constructor

OPTPP::NonLinearConstraint::NonLinearConstraint ( NLP nlprob,
int  numconstraints = 1 
)

Parameters:
nlprob a pointer to NLP
numconstraints an integer argument

OPTPP::NonLinearConstraint::NonLinearConstraint ( NLP nlprob,
const bool  conFlag,
int  numconstraints = 1 
)

Parameters:
nlprob a pointer to NLP
conFlag a bool
numconstraints an integer argument

OPTPP::NonLinearConstraint::NonLinearConstraint ( NLP nlprob,
const NEWMAT::ColumnVector &  rhs,
int  numconstraints = 1 
)

Parameters:
nlprob a pointer to NLP
rhs ColumnVector
numconstraints an integer argument

OPTPP::NonLinearConstraint::NonLinearConstraint ( NLP nlprob,
const NEWMAT::ColumnVector &  rhs,
const bool  conFlag = true,
int  numconstraints = 1 
)

Parameters:
nlprob a pointer to NLP
rhs ColumnVector
conFlag a bool
numconstraints an integer argument

OPTPP::NonLinearConstraint::NonLinearConstraint ( NLP nlprob,
const NEWMAT::ColumnVector &  lower,
const NEWMAT::ColumnVector &  upper,
int  numconstraints = 1 
)

Parameters:
nlprob a pointer to NLP
lower a ColumnVector
upper a ColumnVector
numconstraints an integer argument

OPTPP::NonLinearConstraint::NonLinearConstraint ( NLP nlprob,
const NEWMAT::ColumnVector &  lower,
const NEWMAT::ColumnVector &  upper,
int  ne,
int  ni 
)

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

Destructor


Member Function Documentation

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

Takes two arguments and returns a bool.

Parameters:
xc a ColumnVector
epsilon a real argument.
Returns:
The feasibility of nonlinear constraints at xc.

Implements OPTPP::ConstraintBase.

Implemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual bool OPTPP::NonLinearConstraint::amIFeasible ( const NEWMAT::ColumnVector &  xc,
double  epsilon 
) const [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.

Implements OPTPP::ConstraintBase.

Reimplemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual void OPTPP::NonLinearConstraint::evalCFGH ( const NEWMAT::ColumnVector &  xc  )  const [pure virtual]

Implements OPTPP::ConstraintBase.

Implemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual void OPTPP::NonLinearConstraint::evalCFGH ( const NEWMAT::ColumnVector &  xc  )  const [virtual]

Implements OPTPP::ConstraintBase.

Reimplemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual NEWMAT::Matrix OPTPP::NonLinearConstraint::evalGradient ( const NEWMAT::ColumnVector &  xc  )  const [pure virtual]

Takes one argument and returns a Matrix.

Parameters:
xc a ColumnVector
Returns:
The gradient of nonlinear constraints evaluated at xc.

Implements OPTPP::ConstraintBase.

Implemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual NEWMAT::Matrix OPTPP::NonLinearConstraint::evalGradient ( const NEWMAT::ColumnVector &  xc  )  const [virtual]

Takes one argument and returns a Matrix.

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

Implements OPTPP::ConstraintBase.

Reimplemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

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

Takes two arguments and returns an array of real SymmetricMatrices.

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

Implements OPTPP::ConstraintBase.

Implemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual NEWMAT::SymmetricMatrix OPTPP::NonLinearConstraint::evalHessian ( NEWMAT::ColumnVector &  xc  )  const [pure virtual]

Takes one argument and returns a SymmetricMatrix

Parameters:
xc a ColumnVector
Returns:
The Hessian of a nonlinear constraint evaluated at xc

Implements OPTPP::ConstraintBase.

Implemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual OptppArray<NEWMAT::SymmetricMatrix> OPTPP::NonLinearConstraint::evalHessian ( NEWMAT::ColumnVector &  xc,
int  darg 
) const [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.

Implements OPTPP::ConstraintBase.

Reimplemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual NEWMAT::SymmetricMatrix OPTPP::NonLinearConstraint::evalHessian ( NEWMAT::ColumnVector &  xc  )  const [virtual]

Takes one arguments and returns a SymmetricMatrix

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

Implements OPTPP::ConstraintBase.

Reimplemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual NEWMAT::ColumnVector OPTPP::NonLinearConstraint::evalResidual ( const NEWMAT::ColumnVector &  xc  )  const [pure virtual]

Takes one argument and returns a ColumnVector.

Parameters:
xc a ColumnVector
Returns:
The residual of nonlinear constraints evaluated at xc.

Implements OPTPP::ConstraintBase.

Implemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual NEWMAT::ColumnVector OPTPP::NonLinearConstraint::evalResidual ( const NEWMAT::ColumnVector &  xc  )  const [virtual]

Takes one argument and returns a ColumnVector.

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

Implements OPTPP::ConstraintBase.

Reimplemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual OptppArray<int> OPTPP::NonLinearConstraint::getConstraintMappingIndices (  )  const [inline, virtual]

Returns:
Indices of constraints with finite bounds.

Implements OPTPP::ConstraintBase.

virtual NEWMAT::ColumnVector OPTPP::NonLinearConstraint::getConstraintType (  )  const [inline, virtual]

Returns:
Type of constraints.

Implements OPTPP::ConstraintBase.

Reimplemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

virtual NEWMAT::ColumnVector OPTPP::NonLinearConstraint::getConstraintValue (  )  const [inline, virtual]

Returns:
The value of the nonlinear constraints.

Implements OPTPP::ConstraintBase.

virtual NEWMAT::ColumnVector OPTPP::NonLinearConstraint::getConstraintViolation (  )  const [inline, virtual]

Returns:
Nonlinear constraint violation.

Implements OPTPP::ConstraintBase.

virtual NEWMAT::ColumnVector OPTPP::NonLinearConstraint::getLower (  )  const [inline, virtual]

Returns:
The lower bounds of the constraints.

Implements OPTPP::ConstraintBase.

virtual int OPTPP::NonLinearConstraint::getNumOfCons (  )  const [inline, virtual]

Returns:
The number of constraints.

Implements OPTPP::ConstraintBase.

virtual int OPTPP::NonLinearConstraint::getNumOfVars (  )  const [inline, virtual]

Returns:
The number of variables.

Implements OPTPP::ConstraintBase.

virtual NEWMAT::ColumnVector OPTPP::NonLinearConstraint::getUpper (  )  const [inline, virtual]

Returns:
The upper bounds of the constraints.

Implements OPTPP::ConstraintBase.


Member Data Documentation

OptppArray<int> OPTPP::NonLinearConstraint::constraintMappingIndices_ [protected]

Indices of finite bounds.

NEWMAT::ColumnVector OPTPP::NonLinearConstraint::ctype_ [protected]

Type of constraint.

Reimplemented in OPTPP::NonLinearEquation, and OPTPP::NonLinearInequality.

NEWMAT::ColumnVector OPTPP::NonLinearConstraint::cvalue_ [mutable, protected]

Value of the nonlinear constraints.

NEWMAT::ColumnVector OPTPP::NonLinearConstraint::cviolation_ [mutable, protected]

Nonlinear constraint violation.

NEWMAT::ColumnVector OPTPP::NonLinearConstraint::lower_ [protected]

Lower bounds on the nonlinear constraints.

NLP* OPTPP::NonLinearConstraint::nlp_ [protected]

Pointer to an NLP object.

int OPTPP::NonLinearConstraint::nnzl_ [protected]

Number of finite lower bounds.

int OPTPP::NonLinearConstraint::nnzu_ [protected]

Number of finite upper bounds.

int OPTPP::NonLinearConstraint::numOfCons_ [protected]

Number of nonlinear constraints.

int OPTPP::NonLinearConstraint::numOfVars_ [protected]

Number of variables.

bool OPTPP::NonLinearConstraint::stdForm_ [protected]

Standard representation of constraint.

NEWMAT::ColumnVector OPTPP::NonLinearConstraint::upper_ [protected]

Upper bounds on the nonlinear constraints.


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.