OPTPP::FDNLF1APP Class Reference

These classes and typedefs are used for Application Launching where an AppLauncher Object is also required so that the launcher specific data can be used for the function evaluation. More...

Inheritance diagram for OPTPP::FDNLF1APP:

[legend]

Collaboration diagram for OPTPP::FDNLF1APP:

[legend]

List of all members.

Public Member Functions
virtual void	eval ()
	Evaluate everything.
virtual NEWMAT::ColumnVector	evalCF (const NEWMAT::ColumnVector &x)
	Evaluate constraint at x.
virtual NEWMAT::Matrix	evalCG (const NEWMAT::ColumnVector &x)
	Evaluate constraint gradient at x.
virtual real	evalF (const NEWMAT::ColumnVector &x)
	Evaluate f at x.
virtual real	evalF ()
	Evaluate f.
virtual NEWMAT::ColumnVector	evalG (const NEWMAT::ColumnVector &x)
	Evaluate gradient at x.
virtual NEWMAT::ColumnVector	evalG ()
	Evaluate gradient.
virtual NEWMAT::SymmetricMatrix	evalH ()
	Evaluate hessian.
virtual real	evalLagrangian (const NEWMAT::ColumnVector &x, NEWMAT::ColumnVector &mult, const NEWMAT::ColumnVector &type)
	Evaluate the Lagrangian, its gradient and Hessian.
virtual NEWMAT::ColumnVector	evalLagrangianGradient (const NEWMAT::ColumnVector &x, const NEWMAT::ColumnVector &mult, const NEWMAT::ColumnVector &type)
	Evaluate the gradient of the Lagrangian at x.
NEWMAT::SymmetricMatrix	FDHessian (NEWMAT::ColumnVector &x)
	Evaluate Hessian.
	FDNLF1APP (int ndim, int nlncons, USERNLNCON0APP f, INITFCNAPP i, AppLauncher *launcher)
	FDNLF1APP (int ndim, USERFCN0APP f, INITFCNAPP i, INITCONFCN c)
	FDNLF1APP (int ndim, int nlncons, USERNLNCON0APP f, INITFCNAPP i)
	FDNLF1APP (int ndim, USERFCN0APP f, INITFCNAPP i, AppLauncher *launcher, CompoundConstraint *constraint=0)
	FDNLF1APP (int ndim)
virtual void	fPrintState (ostream *, char *)
	Print out current state: x, gradient, and function value to a file.
virtual void	initFcn ()
	Initialize function.
virtual void	printState (char *)
	Print out current state: x, gradient, and function value to the screen.
virtual void	reset ()
	Reset the parameter values.
Protected Attributes
USERNLNCON0APP	confcn
	User-defined nonlinear constraints.
USERFCN0APP	fcn
	User-defined objective function.
INITCONFCN	init_confcn
	Initializes the constraints.
INITFCNAPP	init_fcn
	Initializes the objective function.
bool	init_flag
	Has the function been initialized?
AppLauncher *	launcher_

---

Detailed Description

These classes and typedefs are used for Application Launching where an AppLauncher Object is also required so that the launcher specific data can be used for the function evaluation.

Definition at line 112 of file NLFAPP.h.

---

Member Function Documentation

virtual void OPTPP::FDNLF1APP::eval

(

)

[virtual]

Evaluate everything.

Reimplemented from OPTPP::FDNLF1.

virtual NEWMAT::ColumnVector OPTPP::FDNLF1APP::evalCF

(

const NEWMAT::ColumnVector &

x

)

[virtual]

Evaluate constraint at x.

Reimplemented from OPTPP::FDNLF1.

virtual NEWMAT::Matrix OPTPP::FDNLF1APP::evalCG

(

const NEWMAT::ColumnVector &

x

)

[virtual]

Evaluate constraint gradient at x.

Reimplemented from OPTPP::FDNLF1.

virtual real OPTPP::FDNLF1APP::evalF

(

const NEWMAT::ColumnVector &

x

)

[virtual]

Evaluate f at x.

Reimplemented from OPTPP::FDNLF1.

virtual real OPTPP::FDNLF1APP::evalF

(

)

[virtual]

Evaluate f.

Reimplemented from OPTPP::FDNLF1.

virtual NEWMAT::ColumnVector OPTPP::FDNLF1APP::evalG

(

const NEWMAT::ColumnVector &

x

)

[virtual]

Evaluate gradient at x.

Reimplemented from OPTPP::FDNLF1.

virtual NEWMAT::ColumnVector OPTPP::FDNLF1APP::evalG

(

)

[virtual]

Evaluate gradient.

Reimplemented from OPTPP::FDNLF1.

virtual NEWMAT::SymmetricMatrix OPTPP::FDNLF1APP::evalH

(

)

[virtual]

Evaluate hessian.

Reimplemented from OPTPP::FDNLF1.

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

Evaluate the Lagrangian, its gradient and Hessian.

Reimplemented from OPTPP::FDNLF1.

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

Evaluate the gradient of the Lagrangian at x.

Reimplemented from OPTPP::FDNLF1.

NEWMAT::SymmetricMatrix OPTPP::FDNLF1APP::FDHessian

(

NEWMAT::ColumnVector &

x

)

Evaluate Hessian.

Reimplemented from OPTPP::FDNLF1.

virtual void OPTPP::FDNLF1APP::fPrintState	(	ostream *	,
		char *
	)			[virtual]

Print out current state: x, gradient, and function value to a file.

Reimplemented from OPTPP::FDNLF1.

virtual void OPTPP::FDNLF1APP::initFcn

(

)

[virtual]

Initialize function.

Reimplemented from OPTPP::FDNLF1.

virtual void OPTPP::FDNLF1APP::printState

(

char *

)

[virtual]

Print out current state: x, gradient, and function value to the screen.

Reimplemented from OPTPP::FDNLF1.

virtual void OPTPP::FDNLF1APP::reset

(

)

[virtual]

Reset the parameter values.

Reimplemented from OPTPP::FDNLF1.

---

Member Data Documentation

USERNLNCON0APP OPTPP::FDNLF1APP::confcn [protected]

User-defined nonlinear constraints.

Reimplemented from OPTPP::FDNLF1.

Definition at line 115 of file NLFAPP.h.

USERFCN0APP OPTPP::FDNLF1APP::fcn [protected]

User-defined objective function.

Reimplemented from OPTPP::FDNLF1.

Definition at line 114 of file NLFAPP.h.

INITCONFCN OPTPP::FDNLF1APP::init_confcn [protected]

Initializes the constraints.

Reimplemented from OPTPP::FDNLF1.

Definition at line 117 of file NLFAPP.h.

INITFCNAPP OPTPP::FDNLF1APP::init_fcn [protected]

Initializes the objective function.

Reimplemented from OPTPP::FDNLF1.

Definition at line 116 of file NLFAPP.h.

bool OPTPP::FDNLF1APP::init_flag [protected]

Has the function been initialized?

Reimplemented from OPTPP::FDNLF1.

Definition at line 119 of file NLFAPP.h.

---

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

• include/NLFAPP.h