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

NonLinearInequality Class Reference

#include <NonLinearInequality.h>

Inheritance diagram for NonLinearInequality::

NonLinearConstraint ConstraintBase List of all members.

Public Methods

 NonLinearInequality ()
 NonLinearInequality (NLP *nlprob, int numconstraints=1)
 NonLinearInequality (NLP *nlprob, const ColumnVector &rhs, int numconstraints=1)
 NonLinearInequality (NLP *nlprob, const bool flag, int numconstraints=1)
 NonLinearInequality (NLP *nlprob, const ColumnVector &rhs, const bool flag, int numconstraints=1)
 NonLinearInequality (NLP *nlprob, const ColumnVector &lower, const ColumnVector &upper, int numconstraints=1)
virtual ~NonLinearInequality ()
ColumnVector getConstraintType () 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 type_
 Type of constraint - NLineq.

const bool oneSided_
 Denotes whether we have a 1-sided constraint.

Detailed Description

NonLinearInequality is a derived class of NonLinearConstraint. Standard Form g(x) >= 0

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

Constructor & Destructor Documentation

NonLinearInequality::NonLinearInequality (  ) 
 

Default Constructor

NonLinearInequality::NonLinearInequality (  NLP * nlprob,
int numconstraints = 1
) 
 

Parameters:
nlprob   a pointer to an NLP object
numconstraints   an integer argument
Note:
Assumes the right-hand side = 0 and the inequality is in standard form

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

Parameters:
nlprob   a pointer to an NLP object
rhs   ColumnVector
numconstraints   an integer argument
Note:
Assumes nonzero right-hand side and the inequality is in standard form

NonLinearInequality::NonLinearInequality (  NLP * nlprob,
const bool flag,
int numconstraints = 1
) 
 

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

NonLinearInequality::NonLinearInequality (  NLP * nlprob,
const ColumnVector & b,
const bool flag,
int numconstraints = 1
) 
 

Parameters:
nlprob   a pointer to an NLP object
rhs   ColumnVector
numconstraints   an integer argument
flag   a bool argument
Note:
Assumes nonzero right-hand side

NonLinearInequality::NonLinearInequality (  NLP * nlprob,
const ColumnVector & lower,
const ColumnVector & upper,
int numconstraints = 1
) 
 

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

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

Destructor

Member Function Documentation

bool NonLinearInequality::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 inequalities at xc.

Reimplemented from NonLinearConstraint.

Matrix NonLinearInequality::evalGradient (  const ColumnVector & xc )  const [virtual]
 

Takes one argument and returns a Matrix.

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

Reimplemented from NonLinearConstraint.

OptppArray< SymmetricMatrix > NonLinearInequality::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 NonLinearInequality::evalHessian (  ColumnVector & xc )  const [virtual]
 

Takes one argument and returns a SymmetricMatrix

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

Reimplemented from NonLinearConstraint.

ColumnVector NonLinearInequality::evalResidual (  const ColumnVector & xc )  const [virtual]
 

Takes one argument and returns a ColumnVector.

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

Reimplemented from NonLinearConstraint.

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

Returns:
Type of constraint - NLineq

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