NAG CL Interface
e05jhc (bnd_​mcs_​option_​check)

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

CL Name Style:


1 Purpose

e05jhc is used to check if you have set an optional parameter of e05jbc. The initialization function e05jac must have been called before calling e05jhc.

2 Specification

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

3 Description

e05jhc returns 1 if you have previously set the optional parameter contained in optstr, otherwise it returns 0.
A complete list of optional parameters, their symbolic names and default values is given in Section 12 in e05jbc.

4 References

None.

5 Arguments

1: optstr const char * Input
On entry: a string identifying an optional parameter (as described in Section 12 in e05jbc).
2: state Nag_E05State * Communication Structure
state contains information required by other functions in this suite. You must not modify it directly in any way.
3: 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

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_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.
NE_NOT_INIT
Initialization function e05jac has not been called.
NE_OPT_NOT_READ
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.
e05jhc is not threaded in any implementation.

9 Further Comments

None.

10 Example

See e05jcc.