NAG Library Function Document

nag_opt_sparse_nlp_option_get_integer (e04vrc)

1

Purpose

2

Specification

3

Description

e04vrc ("Major Iterations", &itnlim, &state, &fail);

4

References

5

Arguments

1:    $\mathbf{string}$ – const char *Input

On entry: a single valid keyword of an Integer optional parameter (as described in Section 12 in nag_opt_sparse_nlp_solve (e04vhc)).

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

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

3:    $\mathbf{state}$ – Nag_E04State *Communication Structure

state contains internal information required for functions in this suite. It must not be modified in any way.

4:    $\mathbf{fail}$ – NagError *Input/Output

The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6

Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.

NE_BAD_PARAM

On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.

NE_E04_OPTION_INVALID

The supplied option string is invalid. Check that the keywords are neither ambiguous nor misspelt. The option string is ‘$〈\mathit{\text{value}}〉$’.

NE_E04VGC_NOT_INIT

The initialization function nag_opt_sparse_nlp_init (e04vgc) has not been called.

NE_INTERNAL_ERROR

An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example