NAG CL Interface
e05jkc (bnd_​mcs_​optget_​int)

Note: this function is deprecated. There is no replacement for this function.
Settings help

CL Name Style:

1 Purpose

e05jkc is used to get the value of an integer e05jbc optional parameter. e05jkc can be used before or after calling e05jbc, but the initialization function e05jac must have been called before calling e05jkc.

2 Specification

#include <nag.h>
void  e05jkc (const char *optstr, Integer *ivalue, Nag_E05State *state, NagError *fail)
The function may be called by the names: e05jkc or nag_glopt_bnd_mcs_optget_int.

3 Description

e05jkc obtains the current value of an integer-valued optional parameter. For example
e05jkc ('Local Searches Limit', &loclim, &state, &fail);
will result in the value of the optional parameter Local Searches Limit being output in loclim.
The default values of the optional parameters Function Evaluations Limit, Splits Limit and Static Limit depend on the problem parameter nr (the number of non-fixed variables). A default value for each of these optional parameters will be set in the first call to the solver e05jbc: before that time, getting the value of any of these optional parameters using e05jkc will not return a meaningful result.
A complete list of optional parameters, their symbolic names and default values is given in Section 12 in e05jbc.

4 References


5 Arguments

1: optstr const char * Input
On entry: a string identifying an integer-valued optional parameter (as described in Section 12 in e05jbc).
2: ivalue Integer * Output
On exit: if fail.code= NE_NOERROR on exit, ivalue contains the integer value associated with the optional parameter in optstr.
3: state Nag_E05State * Communication Structure
state contains information required by other functions in this suite. You must not modify it directly 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.
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.
Initialization function e05jac has not been called.
The supplied optional parameter is invalid. A keyword or keyword combination was not recognized.

7 Accuracy

Not applicable.

8 Parallelism and Performance

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

9 Further Comments


10 Example

See e05jcc.