NAG Library Routine Document

e05jhf  (bnd_mcs_option_check)

 Contents

    1  Purpose
    7  Accuracy
    10  Example

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 nagmk26.h
Integer  e05jhf_ ( const char *optstr, const double comm[], const Integer *lcomm, Integer *ifail, const Charlen length_optstr)

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

None.

5
Arguments

1:     optstr – Character(*)Input
On entry: a string identifying an optional parameter (as described in Section 12 in e05jbf).
2:     commlcomm – Real (Kind=nag_wp) arrayCommunication Array
On entry: communication data as initialized by e05jaf.
3:     lcomm – IntegerInput
On entry: the dimension of the array comm as declared in the (sub)program from which e05jhf is called.
Constraint: lcomm100.
4:     ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1​ or ​1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1​ or ​1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, if you are not familiar with this argument, the recommended value is 0. 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:
ifail=1
Initialization routine e05jaf has not been called.
On entry, lcomm=value.
Constraint: lcomm100.
ifail=2
The supplied optional parameter is invalid. A keyword or keyword combination was not recognized.
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
ifail=-999
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7
Accuracy

Not applicable.

8
Parallelism and Performance

e05jhf is not threaded in any implementation.

9
Further Comments

None.

10
Example

See Section 10 in e05jcf.
© The Numerical Algorithms Group Ltd, Oxford, UK. 2017