NAG Library Function Document

nag_blgm_optset (g22zmc)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:    $\mathbf{handle}$ – void *Input

On entry: the G22 handle which must have been initialized by one of Chapter g22s initialization functions.

2:    $\mathbf{optstr}$ – const char *Input

On entry: a string identifying the option, its value and, where required, the instance identifier.

$\mathbf{Defaults}$

Resets all options to their default values.

$\mathit{option}=\mathit{optval}$

Sets (all instances) of option to optval.

$\mathit{option}:\mathit{instance\; identifier}=\mathit{optval}$

Sets a single instance of option to optval.

$\mathit{option}=\mathbf{default}$

Resets (all instances) of option to their default value.

$\mathit{option}:\mathit{instance\; identifier}=\mathbf{default}$

Resets a single instance of option to its default value.

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

See the documentation of the individual functions in the g22 Chapter Introduction for details of valid values for option, instance identifier and optval.

3:    $\mathbf{fail}$ – NagError *Input/Output

The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6

Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.

NE_BAD_PARAM

On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.

NE_HANDLE

handle has not been initialized or is corrupt.

handle is not a G22 handle.

NE_INSTANCE

Invalid instance identifier for option.
On entry, $\mathbf{optstr}=〈\mathit{\text{value}}〉$.

Numeric instance identifier is out of range
On entry, $\mathit{instance\; identifier}=〈\mathit{\text{value}}〉$.
Constraint: $〈\mathit{\text{value}}〉\le \mathit{instance\; identifier}$ and $\mathit{instance\; identifier}\le 〈\mathit{\text{value}}〉$.

NE_INTERNAL_ERROR

An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.

NE_INVALID_FORMAT

On entry, could not convert optval to an integer.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

On entry, could not convert optval to a real.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

On entry, the expected delimiter ‘$=$’ was not found.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

NE_INVALID_OPTION

On entry, option was not recognized.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

NE_INVALID_VALUE

On entry, optval is not a valid value for option.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.

NE_WRITE_ERROR

On entry, option is read only.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

NW_INSTANCE

On entry, option cannot have an associated instance identifier. The supplied instance identifier was ignored.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example