naginterfaces.library.correg.optget

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

optget is used to query the value of options available to supported problem solving functions in submodule correg. Currently, only quantile_linreg() is supported.

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

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/g02/g02zlf.html

Parameters

optstrstr

A string identifying the option whose current value is required. See Other Parameters for quantile_linreg 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 quantile_linreg() or 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$ was not recognized: $optstr=⟨value⟩$.

(errno $61$)

On entry, either the option arrays have not been initialized or they have been corrupted.

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 initalize 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 quantile_linreg.

See also

naginterfaces.library.examples.correg.lmm_init_combine_ex.main()