OPTPP::NLF0 Class Reference

NLF0 is a derived class of NLP0, a nonlinear problem without analytic derivative information. More...

Inheritance diagram for OPTPP::NLF0:

[legend]

Collaboration diagram for OPTPP::NLF0:

[legend]

List of all members.

Public Member Functions
virtual void	eval ()
	Evaluate the function, gradient, and Hessian.
virtual NEWMAT::ColumnVector	evalCF (const NEWMAT::ColumnVector &x)
	Evaluate nonlinear constraints at x.
virtual real	evalF (const NEWMAT::ColumnVector &x)
	Evaluate the function at x.
virtual real	evalF ()
	Evaluate the function.
virtual NEWMAT::ColumnVector	evalG ()
	Evaluate a finite-difference gradient.
virtual real	evalLagrangian (const NEWMAT::ColumnVector &x, NEWMAT::ColumnVector &mult, const NEWMAT::ColumnVector &type)
	Evaluate the Lagrangian at x.
virtual NEWMAT::ColumnVector	evalLagrangianGradient (const NEWMAT::ColumnVector &x, const NEWMAT::ColumnVector &mult, const NEWMAT::ColumnVector &type)
	Evaluate the gradient of the Lagrangian at x.
virtual void	initFcn ()
	Initialize selected function.
	NLF0 (int ndim, USERFCN0V f, INITFCN i, INITCONFCN c, void *v)
	NLF0 (int ndim, USERFCN0V f, INITFCN i, void *v)
	NLF0 (int ndim, USERFCN0V f, INITFCN i, CompoundConstraint *constraint=0, void *v=0)
	Alternate function pointers with user-supplied void function pointer.
	NLF0 (int ndim, int nlncons, USERNLNCON0 f, INITFCN i)
	NLF0 (int ndim, USERFCN0 f, INITFCN i, INITCONFCN c)
	NLF0 (int ndim, USERFCN0 f, INITFCN i, CompoundConstraint *constraint=0)
	NLF0 (int ndim, USERFCN0 f)
	NLF0 (int ndim)
virtual void	reset ()
	Reset parameter values.
Static Protected Member Functions
static void	f_helper (int n, const NEWMAT::ColumnVector &xc, real &f, int &result, void *v)
Protected Attributes
USERNLNCON0	confcn
	User-defined nonlinear constraints.
USERFCN0	fcn
	User-defined objective function.
USERFCN0V	fcn_v
	User-defined objective function w/ void ptr.
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

NLF0 is a derived class of NLP0, a nonlinear problem without analytic derivative information.

The NLF0 class implements function, finite-difference gradient, and finite-difference 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 72 of file NLF.h.

---

Constructor & Destructor Documentation

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

Alternate function pointers with user-supplied void function pointer.

Definition at line 103 of file NLF.h.

References vptr.

---

Member Function Documentation

virtual void OPTPP::NLF0::eval

(

)

[virtual]

Evaluate the function, gradient, and Hessian.

Implements OPTPP::NLP0.

Reimplemented in OPTPP::NLF0APP.

virtual NEWMAT::ColumnVector OPTPP::NLF0::evalCF

(

const NEWMAT::ColumnVector &

x

)

[virtual]

Evaluate nonlinear constraints at x.

Implements OPTPP::NLP0.

Reimplemented in OPTPP::NLF0APP.

virtual real OPTPP::NLF0::evalF

(

const NEWMAT::ColumnVector &

x

)

[virtual]

Evaluate the function at x.

Implements OPTPP::NLP0.

Reimplemented in OPTPP::NLF0APP.

virtual real OPTPP::NLF0::evalF

(

)

[virtual]

Evaluate the function.

Implements OPTPP::NLP0.

Reimplemented in OPTPP::NLF0APP.

virtual NEWMAT::ColumnVector OPTPP::NLF0::evalG

(

)

[virtual]

Evaluate a finite-difference gradient.

Implements OPTPP::NLP0.

Reimplemented in OPTPP::NLF0APP.

virtual real OPTPP::NLF0::evalLagrangian	(	const NEWMAT::ColumnVector &	x,
		NEWMAT::ColumnVector &	mult,
		const NEWMAT::ColumnVector &	type
	)			[virtual]

Evaluate the Lagrangian at x.

Implements OPTPP::NLP0.

Reimplemented in OPTPP::NLF0APP.

virtual NEWMAT::ColumnVector OPTPP::NLF0::evalLagrangianGradient	(	const NEWMAT::ColumnVector &	x,
		const NEWMAT::ColumnVector &	mult,
		const NEWMAT::ColumnVector &	type
	)			[virtual]

Evaluate the gradient of the Lagrangian at x.

Implements OPTPP::NLP0.

Reimplemented in OPTPP::NLF0APP.

virtual void OPTPP::NLF0::initFcn

(

)

[virtual]

Initialize selected function.

Implements OPTPP::NLP0.

Reimplemented in OPTPP::NLF0APP.

virtual void OPTPP::NLF0::reset

(

)

[virtual]

Reset parameter values.

Implements OPTPP::NLP0.

Reimplemented in OPTPP::NLF0APP.

---

Member Data Documentation

USERNLNCON0 OPTPP::NLF0::confcn [protected]

User-defined nonlinear constraints.

Reimplemented in OPTPP::NLF0APP.

Definition at line 76 of file NLF.h.

USERFCN0 OPTPP::NLF0::fcn [protected]

User-defined objective function.

Reimplemented in OPTPP::NLF0APP.

Definition at line 74 of file NLF.h.

USERFCN0V OPTPP::NLF0::fcn_v [protected]

User-defined objective function w/ void ptr.

Definition at line 75 of file NLF.h.

INITCONFCN OPTPP::NLF0::init_confcn [protected]

Initializes the constraints.

Reimplemented in OPTPP::NLF0APP.

Definition at line 78 of file NLF.h.

INITFCN OPTPP::NLF0::init_fcn [protected]

Initializes the objective function.

Reimplemented in OPTPP::NLF0APP.

Definition at line 77 of file NLF.h.

bool OPTPP::NLF0::init_flag [protected]

Has the function been initialized?

Reimplemented in OPTPP::NLF0APP.

Definition at line 79 of file NLF.h.

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

Void pointer.

Definition at line 80 of file NLF.h.

Referenced by NLF0().

---

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

• include/NLF.h