e04wff may be used to supply individual optional parameters to e04wdf. The initialization routine e04wcf must have been called before calling e04wff.

2 Specification

Fortran Interface

Subroutine e04wff (

string, iw, rw, ifail)

Integer, Intent (Inout)	::	iw(*), ifail
Real (Kind=nag_wp), Intent (Inout)	::	rw(*)
Character (*), Intent (In)	::	string

C Header Interface

#include <nag.h>

void	e04wff_ (const char st, Integer iw[], double rw[], Integer ifail, const Charlen length_st)

The routine may be called by the names e04wff or nagf_opt_nlp2_option_string.

3 Description

e04wff may be used to supply values for optional parameters to e04wdf. It is only necessary to call e04wff for those arguments whose values are to be different from their default values. One call to e04wff 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.

For e04wff, each user-specified option is not normally printed as it is defined, but this printing may be turned on using the keyword List. Thus the statement

Call e04wff ('List', iw, rw, ifail)

turns on printing of this and subsequent options. Printing may be turned off again using the keyword Nolist.

Optional parameter settings are preserved following a call to e04wdf 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 e04wdf.

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 option string (see Section 3 in e04wff and Section 12 in e04wdf).
2: $iw (*)$ – Integer array Communication Array: Note: the actual argument supplied must be the array iw supplied to the initialization routine e04wcf.
3: $rw (*)$ – Real (Kind=nag_wp) array Communication Array: Note: the actual argument supplied must be the array rw supplied to the initialization routine e04wcf.
4: $ifail$ – Integer Input/Output: On entry: ifail must be set to $0$ , $- 1 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 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$: The initialization routine e04wcf has not been called.

$ifail = 2$: The supplied option is invalid. Check that the keywords are neither ambiguous nor misspelt. The option string is ‘ $〈value〉$ ’.

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

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

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

e04wff is not threaded in any implementation.

9 Further Comments

e04wef, e04wgf or e04whf may also be used to supply optional parameters to e04wdf.

10 Example

See Section 10 in e04wef.

NAG Library Manual, Mark 27

Interfaces: FL CL AD

NAG FL Interface Introduction

E04 (Opt) Chapter Contents

E04 (Opt) Chapter Introduction

e04wf: FL CL AD

NAG FL Interfacee04wff (nlp2_​option_​string)

▸▿ Contents

1 Purpose