Auxiliary for use as a delegate parameter

Syntax

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

Parameters

mode
Type: System..::..Int32%
On entry: indicates which values must be assigned during each call of _confun. Only the following values need be assigned:
mode=0
f.
mode=1
All available elements of fjac.
mode=2
f and all available elements of fjac.
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 constraint functions 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.
ncnln
Type: System..::..Int32
On initial entry: nN, the number of nonlinear constraints.
Constraint: ncnln0.
njnln
Type: System..::..Int32
On entry: n1, the number of nonlinear variables. These must be the first njnln variables in the problem.
nnzjac
Type: System..::..Int32
On entry: the number of nonzero elements in the constraint Jacobian. Note that nnzjac will usually be less than ncnln×njnln.
x
Type: array<System..::..Double>[]()[][]
An array of size [njnln]
On entry: x, the vector of nonlinear Jacobian variables at which the nonlinear constraint functions and/or the available elements of the constraint Jacobian are to be evaluated.
f
Type: array<System..::..Double>[]()[][]
An array of size [ncnln]
On exit: if mode=0 or 2, f[i-1] must contain the value of the ith nonlinear constraint function at x.
fjac
Type: array<System..::..Double>[]()[][]
An array of size [nnzjac]
On entry: the elements of fjac are set to special values which enable e04ug to detect whether they are changed by _confun.
On exit: if mode=1 or 2, fjac must return the available elements of the constraint Jacobian evaluated at x. These elements must be stored in exactly the same positions as implied by the definitions of the arrays _a, _ha and _ka. If optional parameter optparam_derivativelevel=2 or 3, the value of any constant Jacobian element not defined by _confun will be obtained directly from _a. Note that the method does not perform any internal checks for consistency (except indirectly via the optional parameter optparam_verifylevel), so great care is essential.
nstate
Type: System..::..Int32
On entry: if nstate=1, then e04ug is calling _confun for the first time. This parameter setting allows you to save computation time if certain data must be read or calculated only once.
If nstate2, then e04ug is calling _confun for the last time. This parameter setting allows you to perform some additional computation on the final solution. In general, the last call to _confun 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