NAG Library Routine Document

1Purpose

e05jjf is used to get the value of an ‘ON’/‘OFF’-valued character e05jbf optional parameter. e05jjf can be used before or after calling e05jbf, but the initialization routine e05jaf must have been called before calling e05jjf.

2Specification

Fortran Interface
 Subroutine e05jjf ( comm,
 Integer, Intent (In) :: lcomm Integer, Intent (Inout) :: ifail Real (Kind=nag_wp), Intent (In) :: comm(lcomm) Character (*), Intent (In) :: optstr Character (*), Intent (Out) :: cvalue
#include nagmk26.h
 void e05jjf_ (const char *optstr, char *cvalue, const double comm[], const Integer *lcomm, Integer *ifail, const Charlen length_optstr, const Charlen length_cvalue)

3Description

e05jjf obtains the current value of an ‘ON’/‘OFF’-valued character optional parameter. For example
```Call e05jjf ('Local Searches', lcsrch, comm, lcomm, ifail)
```
will result in the ‘ON’/‘OFF’ value of the optional parameter Local Searches being output in LCSRCH.
A complete list of optional parameters, their symbolic names and default values is given in Section 12 in e05jbf.

None.

5Arguments

1:     $\mathbf{optstr}$ – Character(*)Input
On entry: a string defining a single ‘ON’/‘OFF’-valued character optional parameter (as described in Section 12 in e05jbf).
2:     $\mathbf{cvalue}$ – Character(*)Output
On exit: if ${\mathbf{ifail}}={\mathbf{0}}$ on exit, cvalue contains the ‘ON’/‘OFF’ value associated with the keyword in optstr.
3:     $\mathbf{comm}\left({\mathbf{lcomm}}\right)$ – Real (Kind=nag_wp) arrayCommunication Array
On entry: communication data as initialized by e05jaf.
4:     $\mathbf{lcomm}$ – IntegerInput
On entry: the dimension of the array comm as declared in the (sub)program from which e05jjf is called.
Constraint: ${\mathbf{lcomm}}\ge 100$.
5:     $\mathbf{ifail}$ – IntegerInput/Output
On entry: ifail must be set to $0$, $-1\text{​ 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\text{​ 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 $-\mathbf{1}\text{​ or ​}\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

6Error Indicators and Warnings

If on entry ${\mathbf{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:
${\mathbf{ifail}}=1$
Initialization routine e05jaf has not been called.
On entry, ${\mathbf{lcomm}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{lcomm}}\ge 100$.
${\mathbf{ifail}}=2$
The supplied optional parameter is invalid. A keyword or keyword combination was not recognized.
${\mathbf{ifail}}=-99$
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
${\mathbf{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.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

Not applicable.

8Parallelism and Performance

e05jjf is not threaded in any implementation.