naginterfaces.library.opt.handle_​opt_​get

naginterfaces.library.opt.handle_opt_get(handle, optstr)

handle_opt_get is an option getting function for all solvers from the NAG optimization modelling suite. It is used to query the value of options.

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

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

Parameters

handleHandle

The handle to the problem. It needs to be initialized (e.g., by handle_init()) and must not be changed between calls to the NAG optimization modelling suite.

optstrstr

A string identifying the option whose current value is required. See the documentation of the particular solver for information on valid options.

Returns

optvaluedict

The option-value dict, with the following keys:

'value'float, int or str

The value of the requested option.

'annotation'None or str

Possible additional information about the option value.

Raises

NagValueError

(errno $1$)

$handle$ has not been initialized.

(errno $1$)

$handle$ does not belong to the NAG optimization modelling suite, has not been initialized properly or is corrupted.

(errno $1$)

$handle$ has not been initialized properly or is corrupted.

(errno $11$)

On entry, the $\text{option}$ supplied in $optstr$ was not recognized: $optstr=⟨value⟩$.

Warns

NagAlgorithmicWarning

(errno $41$)

On entry, $optstr$ indicates a character option, but $\text{cvalue}$ is too short to hold the stored value. The returned value will be truncated.

Notes

handle_opt_get is used to query the current values of options. It can be especially useful to retrieve the options left for automatic choice by the solver.

Information relating to available option names is given in the documentation of the particular solver. See also the E04 Introduction for more details about the NAG optimization modelling suite.