NAG FL Interface
e02zkf (opt_​set)

1 Purpose

2 Specification

3 Description

Call e02zkf('Initialize = e02jdf', iopts, liopts, opts, lopts, ifail)

4 References

5 Arguments

1: $\mathbf{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 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 11 in e02jdf for details of valid values for $\mathit{option}$ and $\mathit{optval}$. The equals sign ($=$) delimiter must be used to separate the $\mathit{option}$ from its $\mathit{optval}$.

The processing of optstr does not depend on its case. Each token in the $\mathit{option}$ and $\mathit{optval}$ component must be separated by at least one space.

2: $\mathbf{iopts}\left(\mathbf{liopts}\right)$ – Integer array Communication 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: $\mathbf{liopts}$ – Integer Input

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: $\mathbf{opts}\left(\mathbf{lopts}\right)$ – Real (Kind=nag_wp) array Communication 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: $\mathbf{lopts}$ – Integer Input

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: $\mathbf{ifail}$ – Integer Input/Output

On entry: ifail must be set to $0$, $\mathrm{-1}$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.

A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $\mathrm{-1}$ means that an error message is printed while a value of $1$ means that it is not.

If halting is not appropriate, the value $\mathrm{-1}$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ 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 $\mathit{optval}$ to an integer: $\mathbf{optstr}=⟨\mathit{\text{value}}⟩$.

On entry, could not convert the specified $\mathit{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 $\mathit{optval}$ supplied for the integer optional parameter is not valid.
$\mathbf{optstr}=⟨\mathit{\text{value}}⟩$.

$\mathbf{ifail}=16$

On entry, the $\mathit{optval}$ supplied for the real optional parameter is not valid.
$\mathbf{optstr}=⟨\mathit{\text{value}}⟩$.

$\mathbf{ifail}=17$

On entry, the $\mathit{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 7 in the Introduction to the NAG Library FL Interface for further information.

$\mathbf{ifail}=-399$

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

See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example