naginterfaces.library.opt.nlp2_​sparse_​option_​string

naginterfaces.library.opt.nlp2_sparse_option_string(string, comm, io_manager=None)[source]

nlp2_sparse_option_string may be used to supply individual options to nlp2_sparse_solve(). The initialization function nlp2_sparse_init() must have been called before calling nlp2_sparse_option_string.

Deprecated since version 28.3.0.0: nlp2_sparse_option_string is deprecated. Please use handle_solve_ssqp() instead. See also the Replacement Calls document.

For full information please refer to the NAG Library document for e04vl

https://www.nag.com/numeric/nl/nagdoc_29.3/flhtml/e04/e04vlf.html

Parameters
stringstr

A single valid option string (see Notes in nlp2_sparse_option_string and Other Parameters for nlp2_sparse_solve).

commdict, communication object, modified in place

Communication structure.

This argument must have been initialized by a prior call to nlp2_sparse_init().

io_managerFileObjManager, optional

Manager for I/O in this routine.

Raises
NagValueError
(errno )

The initialization function nlp2_sparse_init() has not been called.

(errno )

The supplied option is invalid. Check that the keywords are neither ambiguous nor misspelt. The option string is .

Notes

nlp2_sparse_option_string may be used to supply values for options to nlp2_sparse_solve(). It is only necessary to call nlp2_sparse_option_string for those arguments whose values are to be different from their default values. One call to nlp2_sparse_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.

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 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 nlp2_sparse_solve().

A complete list of options, their abbreviations, synonyms and default values is given in Other Parameters for nlp2_sparse_solve.