Main Page   Class Hierarchy   Compound List   File List   Compound Members   Related Pages   Examples  

NonLinearEquation Class Reference

#include <NonLinearEquation.h>

Inheritance diagram for NonLinearEquation::

NonLinearConstraint ConstraintBase List of all members.

Public Methods

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

Protected Attributes

ColumnVector b_
 right-hand side of equation.

ColumnVector type_
 type of constraint - NLeqn.

Detailed Description

NonLinearEquation is a derived class of NonLinearConstraint.

Author:
P.J. Williams, Sandia National Laboratories, pwillia@sandia.gov
Date:
Last modified 09/2001

Constructor & Destructor Documentation

NonLinearEquation::NonLinearEquation (  ) 
 

Default Constructor

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

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

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

Constructors

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

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

Destructor

Member Function Documentation

bool NonLinearEquation::amIFeasible (  const 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 NonLinearConstraint.

Matrix NonLinearEquation::evalGradient (  const 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 NonLinearConstraint.

OptppArray< SymmetricMatrix > NonLinearEquation::evalHessian (  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 NonLinearConstraint.

SymmetricMatrix NonLinearEquation::evalHessian (  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 NonLinearConstraint.

ColumnVector NonLinearEquation::evalResidual (  const 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 NonLinearConstraint.

ColumnVector NonLinearEquation::getB (  )  const [inline]
 

Returns:
The right-hand side of the equation.

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

Returns:
Type of constraint - NLeqn

Reimplemented from ConstraintBase.

The documentation for this class was generated from the following files:
Copyright Information
GNU Lesser General Public License

Contact:
Juan Meza meza@ca.sandia.gov



Documentation generated by