naginterfaces.library.opt.lsq_lincon_option_string¶
- naginterfaces.library.opt.lsq_lincon_option_string(optstr, comm, io_manager=None)[source]¶
lsq_lincon_option_string
may be used to supply individual options tolsq_lincon_solve()
.For full information please refer to the NAG Library document for e04ne
https://support.nag.com/numeric/nl/nagdoc_30.1/flhtml/e04/e04nef.html
- Parameters
- optstrstr
A single valid option string (as described in Notes and in Other Parameters for lsq_lincon_solve).
- commdict, communication object, modified in place
Communication structure.
This argument must have been initialized by a prior call to
nlp1_init()
.- io_managerFileObjManager, optional
Manager for I/O in this routine.
- Raises
- NagValueError
- (errno )
The supplied option string is invalid. Supplied value was: .
- Notes
No equivalent traditional C interface for this routine exists in the NAG Library.
lsq_lincon_option_string
may be used to supply values for options tolsq_lincon_solve()
. It is only necessary to calllsq_lincon_option_string
for those arguments whose values are to be different from their default values. One call tolsq_lincon_option_string
sets one argument value.Each option 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 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.
Printing of user-specified options is turned off by default. It may be turned on at any time using the keyword ‘List’.
Option settings are preserved following a call to
lsq_lincon_solve()
and so the keyword ‘Defaults’ is provided to allow you to reset all the options to their default values before a subsequent call tolsq_lincon_solve()
.A complete list of options, their abbreviations, synonyms and default values is given in Other Parameters for lsq_lincon_solve.