NAG Library Routine Document

D01ZKF

1  Purpose

2  Specification

3  Description

call D01ZKF('Initialize = d01raf', IOPTS, LIOPTS, OPTS, LOPTS, IFAIL)

4  References

5  Parameters

1:     $\mathrm{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 associated with the routine of interest.

$\mathbf{Defaults}$

Resets all options to their default values.

$\mathit{option}=\mathit{optval}$

See Section 11 in D01ESF and D01RAF for details of valid values for option and optval. The equals sign ($=$) delimiter must be used to separate the option from its optval value.

OPTSTR is case insensitive. Each token in the option and optval component must be separated by at least one space.

2:     $\mathrm{IOPTS}\left(\mathbf{LIOPTS}\right)$ – 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 D01ZKF, D01ZLF or the selected problem solving routine.

On exit: dependent on the contents of OPTSTR, either an initialized, reset or updated version of the optional parameter array.

3:     $\mathrm{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:     $\mathrm{OPTS}\left(\mathbf{LOPTS}\right)$ – 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 D01ZKF, D01ZLF or the selected problem solving routine.

On exit: dependent on the contents of OPTSTR, either an initialized, reset or updated version of the optional parameter array.

5:     $\mathrm{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:     $\mathrm{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

$\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}}〉$.

$\mathbf{IFAIL}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.8 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.7 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-999$

Dynamic memory allocation failed.

See Section 3.6 in the Essential Introduction for further information.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example