E02 Chapter Contents
E02 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentE02ZKF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

## 1  Purpose

E02ZKF either initializes or resets the optional parameter arrays or sets a single optional parameter for supported problem solving routines in Chapter E02. Currently, only E02JDF is supported.

## 2  Specification

 SUBROUTINE E02ZKF ( OPTSTR, IOPTS, LIOPTS, OPTS, LOPTS, IFAIL)
 INTEGER IOPTS(LIOPTS), LIOPTS, LOPTS, IFAIL REAL (KIND=nag_wp) OPTS(LOPTS) CHARACTER(*) OPTSTR

## 3  Description

E02ZKF has three purposes: to initialize optional parameter arrays, to reset all optional parameters to their default values or to set a single optional parameter to a user-supplied value.
Optional parameters and their values are, in general, presented as a character string, OPTSTR, of the form ‘option $\text{}=\mathit{optval}$’; alphabetic characters can be supplied in either upper or lower case. Both option and $\mathit{optval}$ may consist of one or more tokens separated by white space. The tokens that comprise $\mathit{optval}$ will normally be either an integer, real or character value as defined in the description of the specific optional argument. In addition all optional parameters can take an $\mathit{optval}$ ‘DEFAULT’ which resets the optional parameter to its default value.
It is imperative that optional parameter arrays are initialized before any options are set, before the relevant problem solving routine is called and before any options are queried using E02ZLF. To initialize the optional parameter arrays IOPTS and OPTS for a specific problem solving routine, the option Initialize is used with $\mathit{optval}$ identifying the problem solving routine to be called, via its short name. For example, to initialize optional parameter arrays to be passed to E02JDF, E02ZKF is called as follows:
```CALL E02ZKF('Initialize = e02jdf', IOPTS, LIOPTS, OPTS, LOPTS, IFAIL)
```
Information relating to available option names and their corresponding valid values is given in Section 10 in E02JDF.

None.

## 5  Parameters

1:     OPTSTR – CHARACTER(*)Input
On entry: a string identifying the option to be set.
$\mathbf{Initialize}=\mathit{routine name}$
Initialize the optional parameter arrays IOPTS and OPTS for use with routine $\mathit{routine name}$, where $\mathit{routine name}$ is the short name of the problem solving routine you wish to use.
$\mathbf{Defaults}$
Resets all options to their default values.
$\mathit{option}=\mathit{optval}$
See Section 10 in E02JDF for details of valid values for option and optval. The equals sign ($=$) delimiter must be used to separate the option from its optval.
The processing of OPTSTR does not depend on its case. Each token in the option and optval component must be separated by at least one space.
2:     IOPTS(LIOPTS) – INTEGER arrayCommunication Array
On entry: optional parameter array.
If OPTSTR has the form ${\mathbf{Initialize}}=\mathit{routine name}$, the contents of IOPTS need not be set.
Otherwise, IOPTS must not have been altered since the last call to E02ZKF, E02ZLF or the selected problem solving routine or suite of routines.
On exit: dependent on the contents of OPTSTR, either an initialized, reset or updated version of the optional parameter array.
3:     LIOPTS – INTEGERInput
On entry: the length of the array IOPTS.
Constraint: unless otherwise stated in the documentation for a specific, supported, problem solving routine, ${\mathbf{LIOPTS}}\ge 100$.
4:     OPTS(LOPTS) – REAL (KIND=nag_wp) arrayCommunication Array
On entry: optional parameter array.
If OPTSTR has the form ${\mathbf{Initialize}}=\mathit{routine name}$, the contents of OPTS need not be set.
Otherwise, OPTS must not have been altered since the last call to E02ZKF, E02ZLF or the selected problem solving routine or suite of routines.
On exit: dependent on the contents of OPTSTR, either an initialized, reset or updated version of the optional parameter array.
5:     LOPTS – INTEGERInput
On entry: the length of the array OPTS.
Constraint: unless otherwise stated in the documentation for a specific, supported, problem solving routine, ${\mathbf{LOPTS}}\ge 100$.
6:     IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to $0$, $-1\text{​ or ​}1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{​ or ​}1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$. When the value $-\mathbf{1}\text{​ or ​}\mathbf{1}$ is used it is essential to test the value of IFAIL on exit.
On exit: ${\mathbf{IFAIL}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6  Error Indicators and Warnings

If on entry ${\mathbf{IFAIL}}={\mathbf{0}}$ or $-{\mathbf{1}}$, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
${\mathbf{IFAIL}}=11$
On entry, the optional parameter in OPTSTR was not recognized: ${\mathbf{OPTSTR}}="⟨\mathit{\text{value}}⟩"$.
${\mathbf{IFAIL}}=12$
On entry, the expected delimiter ‘$=$’ was not found in OPTSTR: ${\mathbf{OPTSTR}}="⟨\mathit{\text{value}}⟩"$.
${\mathbf{IFAIL}}=13$
On entry, could not convert the specified optval to an integer: ${\mathbf{OPTSTR}}="⟨\mathit{\text{value}}⟩"$.
On entry, could not convert the specified optval to a real: ${\mathbf{OPTSTR}}="⟨\mathit{\text{value}}⟩"$.
${\mathbf{IFAIL}}=14$
On entry, attempting to initialize the optional parameter arrays but specified routine name was not valid: $\text{name}="⟨\mathit{\text{value}}⟩"$.
${\mathbf{IFAIL}}=15$
On entry, the optval supplied for the integer optional parameter is not valid.
${\mathbf{OPTSTR}}="⟨\mathit{\text{value}}⟩"$.
${\mathbf{IFAIL}}=16$
On entry, the optval supplied for the real optional parameter is not valid.
${\mathbf{OPTSTR}}="⟨\mathit{\text{value}}⟩"$.
${\mathbf{IFAIL}}=17$
On entry, the optval supplied for the character optional parameter is not valid.
${\mathbf{OPTSTR}}="⟨\mathit{\text{value}}⟩"$.
${\mathbf{IFAIL}}=21$
On entry, either the option arrays have not been initialized or they have been corrupted.
${\mathbf{IFAIL}}=31$
On entry, ${\mathbf{LIOPTS}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{LIOPTS}}\ge ⟨\mathit{\text{value}}⟩$.
${\mathbf{IFAIL}}=51$
On entry, ${\mathbf{LOPTS}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{LOPTS}}\ge ⟨\mathit{\text{value}}⟩$.

Not applicable.