NAG FL Interface
e04zmf (handle_​opt_​set)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

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

On entry: the handle to the problem. It needs to be initialized (e.g., by e04raf) and must not be changed between calls to the NAG optimization modelling suite.

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

On entry: a string identifying the optional parameter 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 $\mathit{option}$ and $\mathit{optval}$. The equals sign ($=$) delimiter must be used to separate the $\mathit{option}$ from its $\mathit{optval}$ value.

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

Resets the given optional parameter back to its default value.

optstr is case insensitive. Each token in the $\mathit{option}$ and $\mathit{optval}$ component must be separated by at least one space.

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}=1$

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

$\mathbf{ifail}=2$

The options cannot be modified while solver is running.

$\mathbf{ifail}=11$

On entry, the $\mathit{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 $\mathit{optval}$ to an integer: $\mathit{optval}=⟨\mathit{\text{value}}⟩$.

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

$\mathbf{ifail}=15$

On entry, the $\mathit{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 $\mathit{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 $\mathit{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 $\mathit{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 $\mathit{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 $\mathit{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 $\mathit{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 $\mathit{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 $\mathit{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 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