NAG Library Routine Document

E04ZMF

1  Purpose

2  Specification

3  Description

4  References

5  Arguments

1:     $\mathrm{HANDLE}$ – TYPE (C_PTR)Input

On entry: the handle to the problem. It needs to be initialized by E04RAF and must not be changed.

2:     $\mathrm{OPTSTR}$ – CHARACTER(*)Input

On entry: a string identifying the option and its value to be set.

$\mathbf{Defaults}$

Resets all options to their default values.

$\mathit{Option}=\mathit{optval}$

See the documentation of the particular solver for details of valid values for option and optval. The equals sign ($=$) delimiter must be used to separate the option from its optval value.

$\mathit{Option}=\mathbf{Default}$

Resets the given option back to its default value.

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

3:     $\mathrm{IFAIL}$ – INTEGERInput/Output

On entry: IFAIL must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation 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 argument, 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}=1$

The supplied HANDLE does not define a valid handle to the data structure for the NAG optimization modelling suite. It has not been initialized by E04RAF or it has been corrupted.

$\mathbf{IFAIL}=2$

The options cannot be modified in this phase.

$\mathbf{IFAIL}=11$

On entry, the option supplied 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: $\mathit{optval}=〈\mathit{\text{value}}〉$.

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

$\mathbf{IFAIL}=15$

On entry, the optval supplied for the integer optional parameter is not valid.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.
Constraint: $\mathit{optval}<〈\mathit{\text{value}}〉$.

On entry, the optval supplied for the integer optional parameter is not valid.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.
Constraint: $\mathit{optval}>〈\mathit{\text{value}}〉$.

On entry, the optval supplied for the integer optional parameter is not valid.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.
Constraint: $\mathit{optval}\le 〈\mathit{\text{value}}〉$.

On entry, the optval supplied for the integer optional parameter is not valid.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.
Constraint: $\mathit{optval}\ge 〈\mathit{\text{value}}〉$.

$\mathbf{IFAIL}=16$

On entry, the optval supplied for the real optional parameter is not valid.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.
Constraint: $\mathit{optval}<〈\mathit{\text{value}}〉$.

On entry, the optval supplied for the real optional parameter is not valid.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.
Constraint: $\mathit{optval}>〈\mathit{\text{value}}〉$.

On entry, the optval supplied for the real optional parameter is not valid.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.
Constraint: $\mathit{optval}\le 〈\mathit{\text{value}}〉$.

On entry, the optval supplied for the real optional parameter is not valid.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.
Constraint: $\mathit{optval}\ge 〈\mathit{\text{value}}〉$.

$\mathbf{IFAIL}=17$

On entry, the optval supplied for the character optional parameter is not valid.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.

$\mathbf{IFAIL}=-99$

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

See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{IFAIL}=-399$

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

See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{IFAIL}=-999$

Dynamic memory allocation failed.

See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example