NAG FL Interface
e05jjf (bnd_​mcs_​optget_​char)

1 Purpose

2 Specification

3 Description

Call e05jjf ('Local Searches', lcsrch, comm, lcomm, ifail)

4 References

5 Arguments

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) array Communication Array

On entry: communication data as initialized by e05jaf.

4: $\mathbf{lcomm}$ – Integer Input

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}$ – Integer Input/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 4 in the Introduction to the NAG Library FL Interface 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).

6 Error Indicators and Warnings

$\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$

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.

$\mathbf{ifail}=-399$

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.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example