This was an option setting routine for e04ugf/e04uga which has been superseded by e04srf. e04srf is part of the NAG optimization modelling suite (see Section 3.1 in the E04 Chapter Introduction) which uses the option setting facilities common to that suite.
To supply optional parameters to e04ugf/e04uga from an external file. More precisely, e04uhf must be used to supply optional parameters to e04ugf and e04uha must be used to supply optional parameters to e04uga.
e04uha is a version of e04uhf that has additional arguments in order to make it safe for use in multithreaded applications (see Section 5). The initialization routine e04wbfmust have been called before calling e04uha.
e04uhf/e04uha may be used to supply values for optional parameters to e04ugf/e04uga. e04uhf/e04uha reads an external file and each line of the file defines a single optional parameter. It is only necessary to supply values for those arguments whose values are to be different from their default values.
Each optional parameter is defined by a single character string,
of up to 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 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.
The file containing the options must start with Begin and must finish with End. An example of a valid options file is:
Begin * Example options file
Print level = 5
For e04uhf each line of the file is normally printed as it is read, on the current advisory message unit (see x04abf), but printing may be suppressed using the keyword Nolist. To suppress printing of Begin, Nolist must be the first option supplied as in the file:
Print level = 5
Printing will automatically be turned on again after a call to e04ugf or e04uhf and may be turned on again at any time using the keyword List.
For e04uha 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 e04ugf/e04uga 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 e04ugf/e04uga.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in e04ugf/e04uga.
Hock W and Schittkowski K (1981) Test Examples for Nonlinear Programming Codes. Lecture Notes in Economics and Mathematical Systems187 Springer–Verlag
1: – IntegerInput
On entry: the unit number of the options file to be read.
2: – IntegerOutput
Note:for e04uha, inform does not occur in this position in the argument list. See the additional arguments described below.
On exit: contains zero if the options file has been successfully read and a ; otherwise, (see Section 6).
Note: the following are additional arguments for specific use with e04uha. Users of e04uhf therefore need not read the remainder of this description.
In this example the options file read by e04uhf/e04uha is appended to the data file for the program (see Section 10.2). It would usually be more convenient in practice to keep the data file and the options file separate.
Note:the following programs illustrate the use of e04uhf and e04uha.