Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Examples

OPTPP::NonLinearEquation Class Reference

#include <NonLinearEquation.h>

Inheritance diagram for OPTPP::NonLinearEquation:

OPTPP::NonLinearConstraint OPTPP::ConstraintBase List of all members.

Public Member Functions

 NonLinearEquation ()
 NonLinearEquation (NLP *nlprob, int numconstraints=1)
 NonLinearEquation (NLP *nlprob, const NEWMAT::ColumnVector &rhs, int numconstraints=1)
virtual ~NonLinearEquation ()
NEWMAT::ColumnVector getConstraintType () const
NEWMAT::ColumnVector getB () const
NEWMAT::ColumnVector evalResidual (const NEWMAT::ColumnVector &xc) const
void evalCFGH (const NEWMAT::ColumnVector &xc) const
NEWMAT::Matrix evalGradient (const NEWMAT::ColumnVector &xc) const
NEWMAT::SymmetricMatrix evalHessian (NEWMAT::ColumnVector &xc) const
OptppArray< NEWMAT::SymmetricMatrix > evalHessian (NEWMAT::ColumnVector &xc, int darg) const
bool amIFeasible (const NEWMAT::ColumnVector &xc, double epsilon) const

Protected Attributes

NEWMAT::ColumnVector b_
 right-hand side of equation
NEWMAT::ColumnVector ctype_
 type of constraint - NLeqn

Constructor & Destructor Documentation

OPTPP::NonLinearEquation::NonLinearEquation (   ) 
 

Default Constructor

See also:
NonLinearEquation(NLP* nlprob, int numconstraints = 1)

NonLinearEquation(NLP* nlprob, const NEWMAT::ColumnVector& rhs, int numconstraints = 1)

OPTPP::NonLinearEquation::NonLinearEquation (  NLP *  nlprob,
int  numconstraints = 1
) 
 

Constructors

Parameters:
nlprob a pointer to an NLP object
numconstraints an integer argument
Note:
Assumes right-hand side = 0

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

Constructors

Parameters:
nlprob a pointer to an NLP object
rhs ColumnVector
numconstraints an integer argument
Note:
Nonzero right-hand side

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

Destructor

Member Function Documentation

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

Takes two arguments and returns a bool.

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

Reimplemented from OPTPP::NonLinearConstraint.

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

Reimplemented from OPTPP::NonLinearConstraint.

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

Takes one argument and returns a Matrix.

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

Reimplemented from OPTPP::NonLinearConstraint.

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

Takes two arguments and returns an array of real SymmetricMatrices.

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

Reimplemented from OPTPP::NonLinearConstraint.

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

Takes one argument and returns a SymmetricMatrix

Parameters:
xc a ColumnVector
Returns:
The Hessian of the nonlinear equations evaluated at xc.

Reimplemented from OPTPP::NonLinearConstraint.

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

Takes one argument and returns a ColumnVector.

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

Reimplemented from OPTPP::NonLinearConstraint.

NEWMAT::ColumnVector OPTPP::NonLinearEquation::getB (   )  const [inline]
 

Returns:
The right-hand side of the equation.

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

Returns:
Type of constraint - NLeqn

Reimplemented from OPTPP::NonLinearConstraint.

Member Data Documentation

NEWMAT::ColumnVector OPTPP::NonLinearEquation::b_ [protected]
 

right-hand side of equation

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

type of constraint - NLeqn

Reimplemented from OPTPP::NonLinearConstraint.

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.