Describes the interface of a routine for optimizing an equation of N variables. More...

Public Member Functions
subroutine	nonlin_optimize_fcn (this, fcn, x, fout, ib, err)

Detailed Description

Describes the interface of a routine for optimizing an equation of N variables.

Parameters

[in,out]	this	The equation_optimizer-based object.
[in]	fcn	The fcnnvar_helper object containing the equation to optimize.
[in,out]	x	On input, the initial guess at the optimal point. On output, the updated optimal point estimate.
[out]	fout	An optional output, that if provided, returns the value of the function at `x`.
[out]	ib	An optional output, that if provided, allows the caller to obtain iteration performance statistics.
[out]	err	An optional errors-based object that if provided can be used to retrieve information relating to any errors encountered during execution. If not provided, a default implementation of the errors class is used internally to provide error handling. The possible error codes returned will likely vary from solver to solver.

Definition at line 1969 of file nonlin_core.f90.

Constructor & Destructor Documentation

subroutine nonlin_core::nonlin_optimize_fcn::nonlin_optimize_fcn	(	class(equation_optimizer), intent(inout)	this,
		class(fcnnvar_helper), intent(in)	fcn,
		real(real64), dimension(:), intent(inout)	x,
		real(real64), intent(out), optional	fout,
		type(iteration_behavior), optional	ib,
		class(errors), intent(inout), optional, target	err )

Definition at line 1969 of file nonlin_core.f90.

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