NAG CL Interface
e04wkc (nlp2_​option_​integer_​get)

Settings help

CL Name Style:

1 Purpose

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

2 Specification

#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.

3 Description

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.

4 References


5 Arguments

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).

6 Error Indicators and Warnings

Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
On entry, argument value had an illegal value.
The supplied option string is invalid. Check that the keywords are neither ambiguous nor misspelt. The option string is ‘value’.
The initialization function e04wcc has not been called.
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.
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.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
e04wkc is not threaded in any implementation.

9 Further Comments


10 Example

See e04wec.