naginterfaces.library.opt.nlp2_​sparse_​option_​double_​get

naginterfaces.library.opt.nlp2_sparse_option_double_get(string, comm, io_manager=None)

nlp2_sparse_option_double_get is used to get the value of a float option. nlp2_sparse_option_double_get can be used before or after calling nlp2_sparse_solve().

Deprecated since version 28.3.0.0: nlp2_sparse_option_double_get 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 e04vs

https://support.nag.com/numeric/nl/nagdoc_30/flhtml/e04/e04vsf.html

Parameters

stringstr

A single valid keyword of a float option (as described in 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.

Returns

rvaluefloat

The float value associated with the keyword in $string$.

Raises

NagValueError

(errno $1$)

The initialization function nlp2_sparse_init() has not been called.

(errno $2$)

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

Notes

nlp2_sparse_option_double_get obtains the current value of a float option.

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