naginterfaces.library.opt.nlp2_​option_​double_​set

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

nlp2_option_double_set may be used to supply individual float options to nlp2_solve(). The initialization function nlp2_init() must have been called before calling nlp2_option_double_set.

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

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

Parameters

stringstr

A single valid keyword of a float option (as described in Other Parameters for nlp2_solve).

rvaluefloat

The value associated with the keyword in $string$.

commdict, communication object, modified in place

Communication structure.

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

io_managerFileObjManager, optional

Manager for I/O in this routine.

Raises

NagValueError

(errno $1$)

The initialization function nlp2_init() has not been called.

(errno $2$)

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

Notes

nlp2_option_double_set may be used to supply values for float options to nlp2_solve(). It is only necessary to call nlp2_option_double_set for those arguments whose values are to be different from their default values. One call to nlp2_option_double_set sets one argument value.

Each float option is defined by a single character string in $string$ and the corresponding value in $rvalue$.

Option settings are preserved following a call to nlp2_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_solve().

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