e02zlc is used to query the value of optional parameters available to supported problem solving functions in Chapter E02. Currently, only e02jdc is supported.

2 Specification

#include <nag.h>

void	e02zlc (const char optstr, Integer ivalue, double rvalue, char cvalue, Integer lcvalue, Nag_VariableType optype, const Integer iopts[], const double opts[], NagError fail)

The function may be called by the names: e02zlc or nag_fit_opt_get.

3 Description

e02zlc is used to query the current values of options. It is necessary to initalize optional parameter arrays using e02zkc before any options are queried.

e02zlc will normally return either an integer, real or character value dependent upon the type associated with the optional parameter being queried. Whether the option queried is of integer, real or character type is indicated by the returned value of optype.

Information on optional parameter names and whether these options are real, integer or character can be found in Section 11 in e02jdc.

4 References

None.

5 Arguments

1: $optstr$ – const char * Input

On entry: a string identifying the option whose current value is required. See Section 11 in e02jdc for information on valid options. In addition, the following is a valid option:

$Identify$: e02zlc returns in cvalue the function name supplied to e02zkc when the optional parameter arrays iopts and opts were initialized.

2: $ivalue$ – Integer * Output

On exit: if the optional parameter supplied in optstr is an integer valued parameter, ivalue will hold its current value.

3: $rvalue$ – double * Output

On exit: if the optional parameter supplied in optstr is a real valued parameter, rvalue will hold its current value.

4: $cvalue$ – char * Output

Note: the maximum length (excluding the NULL terminator) of the string returned in cvalue depends on the problem solving routine in use. See Section 11.1 of the relevant solver.

the string returned in cvalue will never exceed lcvalue characters in length (including the NULL terminator).

On exit: if the optional parameter supplied in optstr is a character valued parameter, cvalue will hold its current value, unless Identify is specified (see optstr).

5: $lcvalue$ – Integer Input

On entry: length of cvalue. At most

lcvalue - 1

non-null characters will be written into cvalue.

Constraint:

lcvalue > 1

6: $optype$ – Nag_VariableType * Output

On exit: indicates whether the optional parameter supplied in optstr is an integer, real or character valued parameter and hence which of ivalue, rvalue or cvalue holds the current value.

$optype = Nag_Integer$: optstr is an integer valued optional parameter, its current value has been returned in ivalue.
$optype = Nag_Real$: optstr is a real valued optional parameter, its current value has been returned in rvalue.
$optype = Nag_Character$: optstr is a character valued optional parameter, its current value has been returned in cvalue.

7: $iopts [\dim]$ – const Integer Communication Array

Note: the dimension,

\dim

, of this array is dictated by the requirements of associated functions that must have been previously called. This array MUST be the same array passed as argument iopts in the previous call to e02zkc.

8: $opts [\dim]$ – const double Communication Array

Note: the dimension,

\dim

, of this array is dictated by the requirements of associated functions that must have been previously called. This array MUST be the same array passed as argument opts in the previous call to e02zkc.

9: $fail$ – NagError * Input/Output

The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

NE_ALLOC_FAIL: Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_BAD_PARAM: On entry, argument $⟨ value ⟩$ had an illegal value.
NE_INT: On entry, $lcvalue = ⟨ value ⟩$ .
Constraint: $lcvalue > 1$ .
NE_INTERNAL_ERROR: An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_INVALID_OPTION: On entry, either the option arrays have not been initialized or they have been corrupted.

On entry, the optional parameter in optstr was not recognized: $optstr = ⟨ value ⟩$ .
NE_NO_LICENCE: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.
NW_TRUNCATED: On entry, optstr indicates a character optional parameter, but cvalue is too short to hold the stored value. The returned value will be truncated.