Auxiliary for use as a delegate parameter

Syntax

C#
public static void e04ugn(
	ref int mode,
	int nonln,
	double[] x,
	ref double objf,
	double[] objgrd,
	int nstate
)
Visual Basic
Public Shared Sub e04ugn ( _
	ByRef mode As Integer, _
	nonln As Integer, _
	x As Double(), _
	ByRef objf As Double, _
	objgrd As Double(), _
	nstate As Integer _
)
Visual C++
public:
static void e04ugn(
	int% mode, 
	int nonln, 
	array<double>^ x, 
	double% objf, 
	array<double>^ objgrd, 
	int nstate
)
F#
static member e04ugn : 
        mode : int byref * 
        nonln : int * 
        x : float[] * 
        objf : float byref * 
        objgrd : float[] * 
        nstate : int -> unit

Parameters

mode
Type: System..::..Int32%
On entry: indicates which values must be assigned during each call of _objfun. Only the following values need be assigned:
mode=0
objf.
mode=1
All available elements of objgrd.
mode=2
objf and all available elements of objgrd.
On exit: you may set to a negative value as follows:
mode≤-2
The solution to the current problem is terminated and in this case e04ug will terminate with _ifail set to mode.
mode=-1
The nonlinear part of the objective function cannot be calculated at the current x. e04ug will then terminate with ifail=-1 unless this occurs during the linesearch; in this case, the linesearch will shorten the step and try again.
nonln
Type: System..::..Int32
On entry: n1′, the number of nonlinear objective variables. These must be the first nonln variables in the problem.
x
Type: array<System..::..Double>[]()[][]
An array of size [nonln]
On entry: x, the vector of nonlinear variables at which the nonlinear part of the objective function and/or all available elements of its gradient are to be evaluated.
objf
Type: System..::..Double%
On exit: if mode=0 or 2, objf must be set to the value of the objective function at x.
objgrd
Type: array<System..::..Double>[]()[][]
An array of size [nonln]
On entry: the elements of objgrd are set to special values which enable e04ug to detect whether they are changed by _objfun.
On exit: if mode=1 or 2, objgrd must return the available elements of the gradient evaluated at x.
nstate
Type: System..::..Int32
On entry: if nstate=1, e04ug is calling _objfun for the first time. This parameter setting allows you to save computation time if certain data must be read or calculated only once.
If nstate≥2, e04ug is calling _objfun for the last time. This parameter setting allows you to perform some additional computation on the final solution. In general, the last call to _objfun is made with nstate=2+_ifail (see [Error Indicators and Warnings]).
Otherwise, nstate=0.

Description

Auxiliary for use as a delegate parameter

References

None.

Error Indicators and Warnings

None.

Accuracy

Not applicable.

Further Comments

None.

Example

None.

See Also