NAG FL Interface
e04wff (nlp2_​option_​string)

1 Purpose

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:
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


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 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of -1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value -1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. 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:
The initialization routine e04wcf has not been called.
The supplied option is invalid. Check that the keywords are neither ambiguous nor misspelt. The option string is ‘value’.
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.
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.
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.