naginterfaces.library.blgm.optget

naginterfaces.library.blgm.optget(handle, optstr)

optget is a general option getting function for submodule blgm. It is used to query the value of options.

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

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/g22/g22znf.html

Parameters

handleHandle

The G22 handle which must have been initialized by one of submodule blgm’s initialization functions.

optstrstr

A string identifying the option and, where required, the instance identifier.

identify

Returns a string description of the G22 handle supplied in $handle$. See Further Comments for more details.

$\text{option}$

Returns the value of $\text{option}$. If there are multiple instances of $\text{option}$, the value of the first is returned. If not all instances of $\text{option}$ have the same value, $errno$ = 124 is returned.

$\text{option}:\text{instance identifier}$

Returns the value of a single instance of $\text{option}$.

$optstr$ is case insensitive and $\text{option}$ and instance identifier may consist of one or more tokens separated by white space.

See the documentation of the individual submodule blgm functions for details of valid values for $\text{option}$ and instance identifier.

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

$handle$ has not been initialized or is corrupt.

(errno $12$)

$handle$ is not a G22 handle.

(errno $21$)

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

(errno $22$)

On entry, $\text{option}$ is not readable: $optstr=⟨value⟩$.

(errno $121$)

Invalid instance identifier for $\text{option}$.

On entry, $optstr=⟨value⟩$.

(errno $122$)

Numeric instance identifier is out of range.

On entry, $\text{instance identifier}=⟨value⟩$.

Constraint: $⟨value⟩\le \text{instance identifier}$ and $\text{instance identifier}\le ⟨value⟩$.

Warns

NagAlgorithmicWarning

(errno $123$)

On entry, $\text{option}$ cannot have an associated instance identifier. The supplied instance identifier was ignored.

$optstr=⟨value⟩$.

(errno $124$)

$\text{option}$ has multiple instances. Information from the first instance has been returned.

Notes

optget can only be called on G22 handles. It can be used to query the current values of options.

The option of interest is presented as a character string of the form ‘$\text{option}$’

In cases where an option may have multiple instances in a particular G22 handle an instance identifier can be specified. This is presented using the form ‘$\text{option}:\text{instance identifier}$’. In such cases, if the instance identifier is omitted, the value of the first instance is returned. If the value of option is not the same for all instances and an instance identifier is omitted, a warning is raised.

Information relating to available option names, their corresponding valid values, whether the use of an instance identifier may be appropriate and what form it can take is given in the individual function documents.