OPTPP::NLF2 Class Reference

NLF2 is a derived class of NLP2, a nonlinear problem with analytic first and second derivatives. More...

Inherits OPTPP::NLP2.

List of all members.

Public Member Functions
virtual void	eval ()
	Evaluate the objective function, gradient, and Hessian.
virtual real	evalF (const NEWMAT::ColumnVector &x)
	Evaluate the objective function at x.
virtual real	evalF ()
	Evaluate the objective function.
virtual NEWMAT::ColumnVector	evalG (const NEWMAT::ColumnVector &x)
	Evaluate the analytic gradient of the objective function at x.
virtual NEWMAT::ColumnVector	evalG ()
	Evaluate the analytic gradient of the objective function.
virtual NEWMAT::SymmetricMatrix	evalH ()
	Evaluate the analytic Hessian of the objective function.
virtual void	initFcn ()
	Initialize function.
	NLF2 (int ndim, USERFCN2V f, INITFCN i, INITCONFCN c, void *v)
	NLF2 (int ndim, USERFCN2V f, INITFCN i, void *v)
	NLF2 (int ndim, USERFCN2V f, INITFCN i, CompoundConstraint *constraint=0, void *v=0)
	Alternate function pointers with user-supplied void function pointer.
	NLF2 (int ndim, int nlncons, USERNLNCON2 f, INITFCN i)
	NLF2 (int ndim, int nlncons, USERNLNCON1 f, INITFCN i)
	NLF2 (int ndim, USERFCN2 f, INITFCN i, INITCONFCN c)
	NLF2 (int ndim, USERFCN2 f, INITFCN i, CompoundConstraint *constraint=0)
	NLF2 (int ndim)
virtual void	reset ()
	Reset parameter values.
Static Protected Member Functions
static void	f_helper (int m, int n, const NEWMAT::ColumnVector &xc, real &f, NEWMAT::ColumnVector &g, NEWMAT::SymmetricMatrix &H, int &result, void *v)
Protected Attributes
USERNLNCON1	confcn1
	User-defined nonlinear constraints.
USERNLNCON2	confcn2
	User-defined nonlinear constraints.
USERFCN2	fcn
	User-defined objective function.
USERFCN2V	fcn_v
	User-defined objective function.
INITCONFCN	init_confcn
	Initializes the constraints.
INITFCN	init_fcn
	Initializes the objective function.
bool	init_flag
	Has the function been initialized?
void *	vptr
	Void pointer.

---

Detailed Description

NLF2 is a derived class of NLP2, a nonlinear problem with analytic first and second derivatives.

The NLF2 class implements function, gradient, and Hessian evaluators.

Author:

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

Note:

Modified by P.J. Williams, Sandia National Laboratories, pwillia@sandia.gov

Date:

Last modified 03/2007

Definition at line 275 of file NLF.h.

---

Constructor & Destructor Documentation

OPTPP::NLF2::NLF2	(	int	ndim,
		USERFCN2V	f,
		INITFCN	i,
		CompoundConstraint *	constraint = 0,
		void *	v = 0
	)			[inline]

Alternate function pointers with user-supplied void function pointer.

Definition at line 310 of file NLF.h.

References vptr.

---

Member Function Documentation

virtual void OPTPP::NLF2::eval

(

)

[virtual]

Evaluate the objective function, gradient, and Hessian.

Implements OPTPP::NLP0.

virtual real OPTPP::NLF2::evalF

(

const NEWMAT::ColumnVector &

x

)

[virtual]

Evaluate the objective function at x.

Implements OPTPP::NLP0.

virtual real OPTPP::NLF2::evalF

(

)

[virtual]

Evaluate the objective function.

Implements OPTPP::NLP0.

virtual NEWMAT::ColumnVector OPTPP::NLF2::evalG

(

const NEWMAT::ColumnVector &

x

)

[virtual]

Evaluate the analytic gradient of the objective function at x.

Implements OPTPP::NLP0.

virtual NEWMAT::ColumnVector OPTPP::NLF2::evalG

(

)

[virtual]

Evaluate the analytic gradient of the objective function.

Implements OPTPP::NLP0.

virtual NEWMAT::SymmetricMatrix OPTPP::NLF2::evalH

(

)

[virtual]

Evaluate the analytic Hessian of the objective function.

Implements OPTPP::NLP0.

virtual void OPTPP::NLF2::initFcn

(

)

[virtual]

Initialize function.

Implements OPTPP::NLP0.

virtual void OPTPP::NLF2::reset

(

)

[virtual]

Reset parameter values.

Implements OPTPP::NLP0.

---

Member Data Documentation

USERNLNCON1 OPTPP::NLF2::confcn1 [protected]

User-defined nonlinear constraints.

Definition at line 279 of file NLF.h.

USERNLNCON2 OPTPP::NLF2::confcn2 [protected]

User-defined nonlinear constraints.

Definition at line 280 of file NLF.h.

USERFCN2 OPTPP::NLF2::fcn [protected]

User-defined objective function.

Definition at line 277 of file NLF.h.

USERFCN2V OPTPP::NLF2::fcn_v [protected]

User-defined objective function.

Definition at line 278 of file NLF.h.

INITCONFCN OPTPP::NLF2::init_confcn [protected]

Initializes the constraints.

Definition at line 282 of file NLF.h.

INITFCN OPTPP::NLF2::init_fcn [protected]

Initializes the objective function.

Definition at line 281 of file NLF.h.

bool OPTPP::NLF2::init_flag [protected]

Has the function been initialized?

Definition at line 283 of file NLF.h.

void* OPTPP::NLF2::vptr [protected]

Void pointer.

Definition at line 284 of file NLF.h.

Referenced by NLF2().

---

The documentation for this class was generated from the following file:

• include/NLF.h