NAG Library Routine Document

e04vrf (nlp2_sparse_option_integer_get)

1

Purpose

2

Specification

3

Description

Call e04vrf ('Major Iterations', itnlim, cw, 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 e04vhf).

2:     $\mathbf{ivalue}$ – IntegerOutput

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

3:     $\mathbf{cw}\left(*\right)$ – Character(8) arrayCommunication Array

Note: the dimension of the array cw must be at least $\mathbf{lencw}$ (see e04vgf).

4:     $\mathbf{iw}\left(*\right)$ – Integer arrayCommunication Array

Note: the dimension of the array iw must be at least $\mathbf{leniw}$ (see e04vgf).

5:     $\mathbf{rw}\left(*\right)$ – Real (Kind=nag_wp) arrayCommunication Array

Note: the dimension of the array rw must be at least $\mathbf{lenrw}$ (see e04vgf).

6:     $\mathbf{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 initialization routine e04vgf 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 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