naginterfaces.library.blgm.optset

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

optset is a general option setting function for functions in submodule blgm. It can set a single option or reset all of them to their default.

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

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/g22/g22zmf.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, its value and, where required, the instance identifier.

Defaults

Resets all options to their default values.

$\text{option}=\text{optval}$

Sets (all instances) of $\text{option}$ to $\text{optval}$.

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

Sets a single instance of $\text{option}$ to $\text{optval}$.

$\text{option}=default$

Resets (all instances) of $\text{option}$ to their default value.

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

Resets a single instance of $\text{option}$ to its default value.

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

See the documentation of the individual functions in the G22 Introduction for details of valid values for $\text{option}$, instance identifier and $\text{optval}$.

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, the expected delimiter ‘$=$’ was not found.

$optstr=⟨value⟩$.

(errno $23$)

On entry, $\text{option}$ is read only.

$optstr=⟨value⟩$.

(errno $24$)

On entry, could not convert $\text{optval}$ to an integer.

$optstr=⟨value⟩$.

(errno $25$)

On entry, could not convert $\text{optval}$ to a real.

$optstr=⟨value⟩$.

(errno $26$)

On entry, $\text{optval}$ is not a valid value for $\text{option}$.

$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⟩$.

Notes

optset can only be called on G22 handles. Its purpose is to reset all options to their default values or set a single option to a user-supplied value.

Options and their values are, in general, presented as a character string of the form ‘$\text{option}=\text{optval}$’; alphabetic characters can be supplied in either upper or lower case. $\text{optval}$ will normally be either an integer, real or character value as defined in the description of the specific option. In addition, all options can take an $\text{optval}$ DEFAULT which resets the option to its default value.

In cases where an option may have multiple instances an instance identifier can be specified. This is presented using the form ‘$\text{option}:\text{instance identifier}=\text{optval}$’. In such cases, if the instance identifier is omitted, the value of all instances are changed.

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.

See also

naginterfaces.library.examples.blgm.lm_formula_ex.main()