NAG FL Interface
g22zmf (optset)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

1: $\mathbf{handle}$ – Type (c_ptr) Input

On entry: the G22 handle which must have been initialized by one of Chapter G22's initialization routines.

2: $\mathbf{optstr}$ – Character(*) Input

On entry: a string identifying the option, its value and, where required, the instance identifier.

$\mathbf{Defaults}$

Resets all options to their default values.

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

Sets (all instances) of option to optval.

$\mathit{option}:\mathit{instance\; identifier}=\mathit{optval}$

Sets a single instance of option to optval.

$\mathit{option}=\mathbf{default}$

Resets (all instances) of option to their default value.

$\mathit{option}:\mathit{instance\; identifier}=\mathbf{default}$

Resets a single instance of option to its default value.

optstr is case insensitive and option, instance identifier and optval may consist of one or more tokens separated by white space.

See the documentation of the individual routines in the G22 Chapter Introduction for details of valid values for option, instance identifier and optval.

3: $\mathbf{ifail}$ – Integer Input/Output

On entry: ifail must be set to $0$, $-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 $-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 $-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$

handle has not been initialized or is corrupt.

$\mathbf{ifail}=12$

handle is not a G22 handle.

$\mathbf{ifail}=21$

On entry, option was not recognized.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=22$

On entry, the expected delimiter ‘$=$’ was not found.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=23$

On entry, option is read only.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=24$

On entry, could not convert optval to an integer.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=25$

On entry, could not convert optval to a real.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=26$

On entry, optval is not a valid value for option.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=121$

Invalid instance identifier for option.
On entry, $\mathbf{optstr}=〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=122$

Numeric instance identifier is out of range.
On entry, $\mathit{instance\; identifier}=〈\mathit{\text{value}}〉$.
Constraint: $〈\mathit{\text{value}}〉\le \mathit{instance\; identifier}$ and $\mathit{instance\; identifier}\le 〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=123$

On entry, option cannot have an associated instance identifier. The supplied instance identifier was ignored.
$\mathbf{optstr}=〈\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