NAG Library Function Document

nag_opt_nlp_option_get_integer (e04wkc)

1  Purpose

2  Specification

3  Description

e04wkc ("Iterations", &itnlim, &state, &fail);

4  References

5  Arguments

1:     string – const char *Input

On entry: a single valid keyword of an Integer optional argument (as described in Section 12 in nag_opt_nlp_solve (e04wdc)).

2:     ivalue – Integer *Output

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

3:     state – Nag_E04State *Communication Structure

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

4:     fail – NagError *Input/Output

The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

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_E04WCC_NOT_INIT

Initialization function nag_opt_nlp_init (e04wcc) 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.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example