naginterfaces.library.quad.opt_​get

naginterfaces.library.quad.opt_get(optstr, comm)[source]

opt_get is used to query the current value associated with an option for md_sgq_multi_vec() and dim1_gen_vec_multi_rcomm().

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

https://www.nag.com/numeric/nl/nagdoc_29.2/flhtml/d01/d01zlf.html

Parameters
optstrstr

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

Identify

In which case opt_get returns the character function name supplied to opt_set() when the option arrays [‘iopts’] and [‘opts’] were initialized.

commdict, communication object

Communication structure.

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

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 )

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

Warns
NagAlgorithmicWarning
(errno )

On entry, the option in was not recognized: .

(errno )

On entry, indicates a character option, but is too short to hold the stored value. The returned value will be truncated.

Notes

opt_get is used to query the current value associated with options. It is necessary to initialize option arrays, [‘iopts’] and [‘opts’], using opt_set() 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 md_sgq_multi_vec and Other Parameters for dim1_gen_vec_multi_rcomm.