E04URF/E04URA (PDF version)
E04 Chapter Contents
E04 Chapter Introduction
NAG Library Manual

NAG Library Routine Document

E04URF/E04URA

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

 Contents

    1  Purpose
    7  Accuracy
    10  Example

1  Purpose

To supply individual optional parameters to E04USF/E04USA. More precisely, E04URF must be used to supply optional parameters to E04USF and E04URA must be used to supply optional parameters to E04USA.
E04URA is a version of E04URF that has additional arguments in order to make it safe for use in multithreaded applications (see Section 5). The initialization routine E04WBF must have been called before calling E04URA.

2  Specification

2.1  Specification for E04URF

SUBROUTINE E04URF ( STR)
CHARACTER(*)  STR

2.2  Specification for E04URA

SUBROUTINE E04URA ( STR, LWSAV, IWSAV, RWSAV, INFORM)
INTEGER  IWSAV(610), INFORM
REAL (KIND=nag_wp)  RWSAV(475)
LOGICAL  LWSAV(120)
CHARACTER(*)  STR

3  Description

E04URF/E04URA may be used to supply values for optional parameters to E04USF/E04USA. It is only necessary to call E04URF/E04URA for those arguments whose values are to be different from their default values. One call to E04URF/E04URA sets one argument value.
Each optional parameter is defined by a single character string, of up to 72 characters, consisting of one or more items. The items associated with a given option must be separated by spaces, or equals signs =. Alphabetic characters may be upper or lower case. The string
Print Level = 1
is an example of a string used to set an optional parameter. For each option the string contains one or more of the following items:
a mandatory keyword;
a phrase that qualifies the keyword;
a number that specifies an integer or real value. Such numbers may be up to 40 contiguous characters in Fortran's I, F, E or D formats, terminated by a space if this is not the last item on the line.
Blank strings and comments are ignored. A comment begins with an asterisk (*) and all subsequent characters in the string are regarded as part of the comment.
For E04URF, each user-specified option is normally printed as it is defined, on the current advisory message unit (see X04ABF), but this printing may be suppressed using the keyword Nolist. Thus the statement
 CALL E04URF ('Nolist')
suppresses printing of this and subsequent options. Printing will automatically be turned on again after a call to E04USF and may be turned on again at any time using the keyword List.
For E04URA printing is turned off by default, but may be turned on at any time using the keyword List.
Optional parameter settings are preserved following a call to E04USF/E04USA and so the keyword Defaults is provided to allow you to reset all the optional parameters to their default values before a subsequent call to E04USF/E04USA.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in E04USF/E04USA.

4  References

None.

5  Arguments

1:     STR – CHARACTER(*)Input
On entry: a single valid option string (as described in Section 3 and in Section 12 in E04USF/E04USA.
Note: the following are additional arguments for specific use with E04URA. Users of E04URF therefore need not read the remainder of this description.
2:     LWSAV120 – LOGICAL arrayCommunication Array
3:     IWSAV610 – INTEGER arrayCommunication Array
4:     RWSAV475 – REAL (KIND=nag_wp) arrayCommunication Array
The arrays LWSAV, IWSAV and RWSAV must not be altered between calls to any of the routines E04URA, E04UQA or E04URA.
5:     INFORM – INTEGEROutput
On exit: contains zero if a valid option string has been supplied and a value>0 otherwise (see Section 6).

6  Error Indicators and Warnings

INFORM=5
The supplied option is invalid. Check that the keywords are neither ambiguous nor misspelt.

7  Accuracy

Not applicable.

8  Parallelism and Performance

E04URF/E04URA is not threaded in any implementation.

9  Further Comments

E04UQF/E04UQA may also be used to supply optional parameters to E04USF/E04USA.

10  Example

See Section 10 in E04UQF/E04UQA.

E04URF/E04URA (PDF version)
E04 Chapter Contents
E04 Chapter Introduction
NAG Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2016