naginterfaces.library.correg.optset

naginterfaces.library.correg.optset(optstr, comm)[source]

optset either initializes or resets the option arrays or sets a single option for supported problem solving functions in submodule correg. Currently, only quantile_linreg() is supported.

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

https://www.nag.com/numeric/nl/nagdoc_27.1/flhtml/g02/g02zkf.html

Parameters
optstrstr

A string identifying the option to be set.

Initialize =

Initialize the option arrays [‘iopts’] and [‘opts’] for use with function , where is the name of the problem solving function you wish to use.

Defaults

Resets all options to their default values.

See Other Parameters for quantile_linreg for details of valid values for and . The equals sign () delimiter must be used to separate the from its value.

is case insensitive.

Each token in the and component must be separated by at least one space.

commdict, communication object, modified in place

Communication structure.

Raises
NagValueError
(errno )

On entry, the supplied in was not recognized: .

(errno )

On entry, the expected delimiter ‘’ was not found in : .

(errno )

On entry, could not convert the specified to an integer: .

(errno )

On entry, could not convert the specified to a real: .

(errno )

On entry, attempting to initialize the option arrays but specified function name was not valid: .

(errno )

On entry, the supplied for the integer option is not valid.

.

(errno )

On entry, the supplied for the real option is not valid.

.

(errno )

On entry, the supplied for the character option is not valid.

.

(errno )

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

Notes

optset has three purposes: to initialize option arrays, to reset all options to their default values or to set a single option to a user-supplied value.

Options and their values are, in general, presented as a character string, , of the form ‘’; alphabetic characters can be supplied in either upper or lower case. Both and may consist of one or more tokens separated by white space. The tokens that comprise will normally be either an integer, real or character value as defined in the description of the specific optional argument. In addition all options can take an DEFAULT which resets the option to its default value.

It is imperative that option arrays are initialized before any options are set, before the relevant problem solving function is called and before any options are queried using optget().

Information relating to available option names and their corresponding valid values is given in Other Parameters for quantile_linreg.