NAG Library Routine Document

e05jef may be used to supply individual ‘ON’/‘OFF’-valued character optional parameters to e05jbf. The initialization routine e05jaf must have been called before calling e05jef.

2

Specification

Fortran Interface

Subroutine e05jef (

optstr, cvalue, comm, lcomm, ifail)

Integer, Intent (In)	::	lcomm
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (Inout)	::	comm(lcomm)
Character (*), Intent (In)	::	optstr, cvalue

C Header Interface

#include <nagmk26.h>

void	e05jef_ (const char optstr, const char cvalue, double comm[], const Integer lcomm, Integer ifail, const Charlen length_optstr, const Charlen length_cvalue)

3

Description

e05jef may be used to supply values for ‘ON’/‘OFF’-valued character optional parameters to e05jbf. It is only necessary to call e05jef for those arguments whose values are to be different from their default values. One call to e05jef sets one argument value.

Each ‘ON’/‘OFF’-valued character optional parameter is defined by a single character string in optstr and the corresponding value in cvalue. For example, the following allows local searches to be turned off:

lcsrch = 'off'
Call e05jef ('Local Searches', lcsrch, comm, lcomm, ifail)

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 defining a single ‘ON’/‘OFF’-valued character optional parameter (as described in Section 12 in e05jbf).
2: $cvalue$ – Character(*)Input: On entry: the ‘ON’/‘OFF’ value associated with the keyword in optstr.
3: $comm (lcomm)$ – Real (Kind=nag_wp) arrayCommunication Array: On exit: comm must not be altered between calls to any of the routines e05jbf, e05jcf, e05jdf, e05jef, e05jff, e05jgf, e05jhf, e05jjf, e05jkf and e05jlf.
4: $lcomm$ – IntegerInput: On entry: the dimension of the array comm as declared in the (sub)program from which e05jef is called.

Constraint: $lcomm \geq 100$ .
5: $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

- 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: $lcomm \geq 100$ .

$ifail = 2$: The supplied optional parameter is invalid. A keyword or keyword combination was not recognized.

$ifail = 3$: Attempt to assign an illegal value of Local Searches ( $lcsrch$ ): $lcsrch = 〈value〉$ .

Attempt to assign an illegal value of Repeatability ( $repeat$ ): $repeat = 〈value〉$ .

$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

e05jef is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.