naginterfaces.library.glopt.optget

naginterfaces.library.glopt.optget(optstr, comm)

optget is used to query the value of options available to supported problem solving functions in submodule glopt. Currently the following functions are supported:

bnd_pso(),

nlp_pso(),

nlp_multistart_sqp(),

nlp_multistart_sqp_lsq().

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

https://support.nag.com/numeric/nl/nagdoc_30.2/flhtml/e05/e05zlf.html

Parameters

optstrstr

A string identifying the option whose current value is required. See Other Parameters for bnd_pso and Other Parameters for nlp_pso for information on valid options. In addition, the following is a valid option:

Identify

optget returns the function name supplied to optset() when the option arrays $comm$[‘iopts’] and $comm$[‘opts’] were initialized.

commdict, communication object

Communication structure.

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

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 $11$)

On entry, the $\text{option}$ in $optstr$ has not been recognized.

(errno $61$)

The arrays $comm$[‘iopts’] and $comm$[‘opts’] have either not been initialized, have become corrupted, or are not compatible with this option setting function.

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

optget is used to query the current values of options. It is necessary to initialize option arrays using optset() before any options are queried.

Information on option names and whether these options are real, integer or character can be found in Other Parameters for bnd_pso, Other Parameters for nlp_pso, Other Parameters for nlp_multistart_sqp and Other Parameters for nlp_multistart_sqp_lsq.