naginterfaces.library.glopt.optset

naginterfaces.library.glopt.optset(optstr, comm, io_manager=None)

optset either initializes or resets the option arrays or sets a single option for supported problem solving functions in submodule glopt. The following functions are supported:

bnd_pso(),

nlp_pso(),

nlp_multistart_sqp(),

nlp_multistart_sqp_lsq().

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

https://support.nag.com/numeric/nl/nagdoc_30.2/flhtml/e05/e05zkf.html

Parameters

optstrstr

A string identifying the option to be set.

Initialize = $\text{function name}$

Initialize the option arrays $comm$[‘iopts’] and $comm$[‘opts’] for use with function $\text{function name}$, where $\text{function name}$ is the name associated with the function of interest.

Defaults

Resets all options to their default values.

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

See Other Parameters for bnd_pso, Other Parameters for nlp_pso, Other Parameters for nlp_multistart_sqp and Other Parameters for nlp_multistart_sqp_lsq for details of valid values for $\text{option}$ and $\text{optval}$. The equals sign ($=$) delimiter must be used to separate the $\text{option}$ from its $\text{optval}$ value.

$optstr$ is case insensitive.

Each token in the $\text{option}$ and $\text{optval}$ component must be separated by at least one space.

commdict, communication object, modified in place

Communication structure.

On initial entry: need not be set.

io_managerFileObjManager, optional

Manager for I/O in this routine.

Raises

NagValueError

(errno $11$)

On entry, the option in $optstr$ was not recognized: $optstr=⟨value⟩$.

(errno $12$)

On entry, the expected delimiter ‘$=$’ was not found in $optstr$: $optstr=⟨value⟩$.

(errno $13$)

The $\text{option}$ in $optstr$ is associated with a numerical value. However, the $\text{optval}$, $⟨value⟩$, present in $optstr$ could not be fully interpreted.

(errno $13$)

On entry, could not convert the specified $\text{optval}$ to an integer: $optstr=⟨value⟩$.

(errno $13$)

On entry, could not convert the specified $\text{optval}$ to a real: $optstr=⟨value⟩$.

(errno $14$)

On entry, the $\text{option}$ in $optstr$ has been detected as Initialize, however the $\text{optval}$, $⟨value⟩$, associated with $optstr$ has not been recognized as a valid function name.

(errno $15$)

On entry, the $\text{optval}$ supplied for the integer option is not valid.

$optstr=⟨value⟩$.

(errno $16$)

On entry, the $\text{optval}$ supplied for the real option is not valid.

$optstr=⟨value⟩$.

(errno $17$)

On entry, the $\text{optval}$ supplied for the character option is not valid.

$optstr=⟨value⟩$.

(errno $17$)

On entry, the option in $optstr$ was not recognized: $optstr=⟨value⟩$.

(errno $21$)

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

(errno $21$)

On entry, the option in $optstr$ was not recognized: $optstr=⟨value⟩$.

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, $optstr$, of the form ‘$\text{option}=\text{optval}$’; alphabetic characters can be supplied in either upper or lower case. Both $\text{option}$ and $\text{optval}$ may consist of one or more tokens separated by white space. The tokens that comprise $\text{optval}$ 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 $\text{optval}$ 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 bnd_pso, Other Parameters for nlp_pso, Other Parameters for nlp_multistart_sqp and Other Parameters for nlp_multistart_sqp_lsq.

See also

naginterfaces.library.examples.glopt.nlp_multistart_sqp_lsq_ex.main()