E04WLF (PDF version)
E04 Chapter Contents
E04 Chapter Introduction
NAG Library Manual

NAG Library Routine Document

E04WLF

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

E04WLF is used to get the value of a real optional parameter. E04WLF can be used before or after calling E04WDF.

2  Specification

SUBROUTINE E04WLF ( STRING, RVALUE, IW, RW, IFAIL)
INTEGER  IW(*), IFAIL
REAL (KIND=nag_wp)  RVALUE, RW(*)
CHARACTER(*)  STRING

3  Description

E04WLF obtains the current value of a real option. For example
CALL E04WLF ('LU Factor Tolerance', FACTOL, IW, RW, IFAIL)
will result in the value of the optional parameter LU Factor Tolerance being output in FACTOL.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in E04WDF.

4  References

None.

5  Arguments

1:     STRING – CHARACTER(*)Input
On entry: a single valid keyword of a real optional parameter (as described in Section 12 in E04WDF).
2:     RVALUE – REAL (KIND=nag_wp)Output
On exit: the real value associated with the keyword in STRING.
3:     IW* – INTEGER arrayCommunication Array
Note: the dimension of the array IW must be at least LENIW (see E04WCF).
4:     RW* – REAL (KIND=nag_wp) arrayCommunication Array
Note: the dimension of the array RW must be at least LENRW (see E04WCF).
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 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
The initialization routine E04WCF has not been called.
IFAIL=2
The supplied option is invalid. Check that the keywords are neither ambiguous nor misspelt.
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

E04WLF is not threaded in any implementation.

9  Further Comments

None.

10  Example

See Section 10 in E04WEF.

E04WLF (PDF version)
E04 Chapter Contents
E04 Chapter Introduction
NAG Library Manual

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