This was an option setting routine for e04vhf 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.
The routine may be called by the names e04vkf or nagf_opt_nlp2_sparse_option_file.
e04vkf may be used to supply values for optional parameters to e04vhf. e04vkf reads an external file
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 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
Optional parameter settings are preserved following a call to e04vhf 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 e04vhf.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in e04vhf.
1: – IntegerInput
On entry: the unit number of the option file to be read.
ispecs is a valid unit open for reading.
2: – Character(8) arrayCommunication Array
Note: the actual argument supplied must be the array cw supplied to the initialization routine e04vgf.
3: – Integer arrayCommunication Array
Note: the actual argument supplied must be the array iw supplied to the initialization routine e04vgf.
4: – Real (Kind=nag_wp) arrayCommunication Array
Note: the actual argument supplied must be the array rw supplied to the initialization routine e04vgf.
5: – IntegerInput/Output
On entry: ifail must be set to , or to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of means that an error message is printed while a value of means that it is not.
If halting is not appropriate, the value or is recommended. If message printing is undesirable, then the value is recommended. Otherwise, the value is recommended. When the value or is used it is essential to test the value of ifail on exit.
On exit: unless the routine detects an error or a warning has been flagged (see Section 6).
6Error Indicators and Warnings
If on entry or , 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 e04vgf has not been called.
At least one line of the options file is invalid.
Could not read options file on unit .
Could not read options file on unit ispecs. This may be due to: