e04wk: FL CL CPP AD PY MB

NAG CL Interface
e04wkc (nlp2_option_integer_get)

Keyword Search:

Interfaces: FL CL CPP AD PY MB

e04wk: FL CL CPP AD PY MB

▸▿ Contents

CL Name Style:
Short (a00aac)
Long (impl_details)
Full (nag_info_impl_details)

e04wkc is used to get the value of an Integer optional parameter. e04wkc can be used before or after calling e04wdc.

#include <nag.h>

void	e04wkc (const char string, Integer ivalue, Nag_E04State state, NagError fail)

The function may be called by the names: e04wkc, nag_opt_nlp2_option_integer_get or nag_opt_nlp_option_get_integer.

e04wkc obtains the current value of an Integer option. For example

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

will result in the value of the optional parameter

Major Iterations Limit

being output in itnlim.

A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in e04wdc.

None.

1: $string$ – const char * Input: On entry: a single valid keyword of an Integer optional parameter (as described in Section 12 in 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 7 in the Introduction to the NAG Library CL Interface).

NE_ALLOC_FAIL: Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_BAD_PARAM: On entry, argument $⟨ 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 ‘ $⟨ value ⟩$ ’.
NE_E04WCC_NOT_INIT: The initialization function 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.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_NO_LICENCE: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.