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

NLP1 Class Reference

#include <NLP1.h>

Inheritance diagram for NLP1::

NLP0 NLPBase NLP2 List of all members.

Public Methods

 NLP1 ()
 NLP1 (int ndim)
 NLP1 (int ndim, int nlncons)
 NLP1 (int ndim, CompoundConstraint *constraint)
virtual ~NLP1 ()
ColumnVector getGrad () const
int getGevals () const
int AnalyticGrad () const
virtual void initFcn ()=0
 Evaluate the function.

virtual real evalF ()=0
virtual real evalF (const ColumnVector &x)=0
virtual void eval ()=0
virtual ColumnVector evalG ()=0
 Evaluate the gradient.

virtual ColumnVector evalG (const ColumnVector &x)=0
virtual SymmetricMatrix evalH ()=0
 Evaluate a Finite-difference Hessian.

virtual SymmetricMatrix evalH (ColumnVector &x)=0
virtual SymmetricMatrix FDHessian (ColumnVector &x)
virtual real evalLagrangian (const ColumnVector &x, ColumnVector &mult, const ColumnVector &type)=0
 Evaluate the Lagrangian, its gradient and Hessian.

virtual ColumnVector evalLagrangianGradient (const ColumnVector &x, const ColumnVector &mult, const ColumnVector &type)=0
 Evaluate the Lagrangian gradient.

virtual ColumnVector evalCF (const ColumnVector &x)=0
 Evaluate the constraints.

virtual Matrix evalCG (const ColumnVector &x)=0
 Evaluate the constraint gradient at x.

virtual SymmetricMatrix evalCH (ColumnVector &x)=0
virtual OptppArray< SymmetricMatrix > evalCH (ColumnVector &x, int darg)=0
 Evaluate the constraint Hessian at x.

virtual OptppArray< SymmetricMatrix > CONFDHessian (ColumnVector &x)
 Evaluate a Finite-difference Hessian for the nonlinear constraints.

virtual void printState (char *s)
 Print the function.

virtual void fPrintState (ostream *nlpout, char *s)

Protected Attributes

ColumnVector mem_grad
 Gradient of objective function at mem_xc.

int ngevals
 Number of gradient evaluations.

int analytic_grad
 Is an analytic gradient available?

Detailed Description

NLP1: NLP0 + First derivatives NLP1 is derived from the base class NLP0 by adding the necessary information to compute and store the gradient.

Author:
J.C. Meza, Sandia National Laboratories, meza@ca.sandia.gov

Note:
Modified by P. J. Williams to incorporate NLPBase.h
Sandia National Laboratories, pwillia@sandia.gov

Constructor & Destructor Documentation

NLP1::NLP1 (  )  [inline]
 

Default Constructor

See also:
NLP1(int dim) , NLP1(int dim, int nlncons) , NLP1(int dim, CompoundConstraint* constraint)

NLP1::NLP1 (  int dim )  [inline]
 

Parameters:
ndim   an integer argument
See also:
NLP1(int dim, int nlncons) , NLP1(int dim, CompoundConstraint* constraint)

NLP1::NLP1 (  int dim,
int nlncons
)  [inline]
 

Parameters:
ndim   an integer argument
nlncons   an integer argument
See also:
NLP1(int dim) , NLP1(int dim, CompoundConstraint* constraint)

NLP1::NLP1 (  int dim,
CompoundConstraint * constraint
)  [inline]
 

Parameters:
ndim   an integer argument
constraint   pointer to a CompoundConstraint object
See also:
NLP1(int dim) , NLP1(int dim, int nlncons)

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

Destructor

Member Function Documentation

int NLP1::AnalyticGrad (  )  const [inline]
 

Returns:
Is there analytic gradient information available?

int NLP1::getGevals (  )  const [inline]
 

Returns:
Number of gradient evaluations.

ColumnVector NLP1::getGrad (  )  const [inline]
 

Returns:
Gradient of objective function.

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