NAG FL Interface
e04wkf (nlp2_​option_​integer_​get)

1 Purpose

2 Specification

3 Description

Call e04wkf ('Iterations', itnlim, iw, rw, ifail)

4 References

5 Arguments

1: $\mathbf{string}$ – Character(*) Input

On entry: a single valid keyword of an integer optional parameter (as described in Section 12 in e04wdf).

2: $\mathbf{ivalue}$ – Integer Output

On exit: the integer value associated with the keyword in string.

3: $\mathbf{iw}\left(*\right)$ – Integer array Communication Array

Note: the actual argument supplied must be the array iw supplied to the initialization routine e04wcf.

4: $\mathbf{rw}\left(*\right)$ – Real (Kind=nag_wp) array Communication Array

Note: the actual argument supplied must be the array rw supplied to the initialization routine e04wcf.

5: $\mathbf{ifail}$ – Integer Input/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 4 in the Introduction to the NAG Library FL Interface 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 initialization routine e04wcf has not been called.

$\mathbf{ifail}=2$

The supplied option string is invalid. Check that the keywords are neither ambiguous nor misspelt. The option string is ‘$〈\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