- naginterfaces.library.opt.nlp2_sparse_option_file(ispecs, comm, io_manager=None)¶
nlp2_sparse_option_filemay be used to supply options to
nlp2_sparse_solve()from an external file. The initialization function
nlp2_sparse_init()must have been called before calling
For full information please refer to the NAG Library document for e04vk
The unit number (see
unit_from_fileobj()) of the option file to be read.
- commdict, communication object, modified in place
This argument must have been initialized by a prior call to
- io_managerFileObjManager, optional
Manager for I/O in this routine.
- (errno )
The initialization function
nlp2_sparse_init()has not been called.
- (errno )
At least one line of the options file is invalid.
- (errno )
Could not read options file on unit .
nlp2_sparse_option_filemay be used to supply values for options to
nlp2_sparse_option_filereads an external file and each line of the file defines a single option. It is only necessary to supply values for those arguments whose values are to be different from their default values.
Each option 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 option. 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 int or float 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
Beginand must finish with
End. An example of a valid options file is:
Begin * Example options file Print level = 5 End
Option settings are preserved following a call to
nlp2_sparse_solve()and so the keyword ‘Defaults’ is provided to allow you to reset all the options to their default values before a subsequent call to
A complete list of options, their abbreviations, synonyms and default values is given in Other Parameters for nlp2_sparse_solve.