NAG FL Interface
e05jhf (bnd_​mcs_​option_​check)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

e05jhf is used to check if you have set an optional parameter of e05jbf. The initialization routine e05jaf must have been called before calling e05jhf.

2 Specification

Fortran Interface
Function e05jhf ( optstr, comm, lcomm, ifail)
Integer :: e05jhf
Integer, Intent (In) :: lcomm
Integer, Intent (Inout) :: ifail
Real (Kind=nag_wp), Intent (In) :: comm(lcomm)
Character (*), Intent (In) :: optstr
C Header Interface
#include <nag.h>
Integer  e05jhf_ (const char *optstr, const double comm[], const Integer *lcomm, Integer *ifail, const Charlen length_optstr)
The routine may be called by the names e05jhf or nagf_glopt_bnd_mcs_option_check.

3 Description

e05jhf 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 e05jbf.

4 References


5 Arguments

1: optstr Character(*) Input
On entry: a string identifying an optional parameter (as described in Section 12 in e05jbf).
2: comm(lcomm) Real (Kind=nag_wp) array Communication Array
On entry: communication data as initialized by e05jaf.
3: lcomm Integer Input
On entry: the dimension of the array comm as declared in the (sub)program from which e05jhf is called.
Constraint: lcomm100.
4: ifail Integer Input/Output
On entry: ifail must be set to 0, -1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of -1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value -1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. When the value -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry ifail=0 or -1, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
Initialization routine e05jaf has not been called.
On entry, lcomm=value.
Constraint: lcomm100.
The supplied optional parameter is invalid. A keyword or keyword combination was not recognized.
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL 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 FL Interface for further information.
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

e05jhf is not threaded in any implementation.

9 Further Comments


10 Example

See e05jcf.