nag_opt_handle_opt_set_file (e04zpc) is an option setting function for solvers from the NAG optimization modelling suite, namely nag_opt_handle_solve_ipopt (e04stc)
and nag_opt_handle_solve_pennon (e04svc)
. It can set one or more optional parameters from an external file.
nag_opt_handle_opt_set_file (e04zpc) may be used to supply values for optional parameters to
the solver from an external file. It can only be called on handles which have been initialized by nag_opt_handle_init (e04rac)
and before the call to the solver. nag_opt_handle_opt_set_file (e04zpc) looks in the file for a specific section containing the optional parameters. The section must start with a line Begin
and must finish with a line End
. Anything outside the section is ignored. If there is more than one section like this, only the first one is processed. Any line within the section is either blank or a comment which is ignored or defines a single optional parameter as if it had been set by nag_opt_handle_opt_set (e04zmc)
. The implied data type (character, integer or real) of each value to be set must
match that expected by the corresponding optional parameter. It is only necessary to supply values for those arguments whose values are to be different from their default values. A comment begins with an asterisk (*) and all subsequent characters to the end of the line are ignored. Comments can also be placed after the optional parameter. The file is case insensitive.
Note that the optional parameters printed by the solver or by nag_opt_handle_print (e04ryc)
are in the compatible format. An example of a valid options file is:
Begin * Example options file
Print Level = 3
Monitoring Level = 5 * output all details
Monitoring File = 42 * to this file
nag_opt_handle_opt_set_file (e04zpc) is not threaded in any implementation.
See Section 10
in nag_opt_handle_init (e04rac) for links to all examples in the suite.