nonlin_optimize_fcn Interface

interface
public subroutine nonlin_optimize_fcn(this, fcn, x, fout, ib, err)

Arguments

Type IntentOptional Attributes Name
class(equation_optimizer), intent(inout) :: this

The equation_optimizer object.

class(fcnnvar_helper), intent(in) :: fcn

The fcnnvar_helper object containing the equation to optimize.

real(kind=real64), intent(inout), dimension(:) :: x

On input, the initial guess at the optimal point. On output, the updated optimal point estimate.

real(kind=real64), intent(out), optional :: fout

An optional output, that if provided, returns the value of the function at x.

type(iteration_behavior), optional :: ib

An optional output, that if provided, allows the caller to obtain iteration performance statistics.

class(errors), intent(inout), optional, target :: err

An error handling object.

Description

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