NAG Library Function Document

nag_glopt_opt_set (e05zkc)

1  Purpose

2  Specification

3  Description

nag_glopt_opt_set("Initialize = e05sac", iopts, liopts, opts, lopts, &fail)

4  References

5  Arguments

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

On entry: a string identifying the option to be set.

$\mathbf{Initialize}=\mathit{function\; name}$

Initialize the optional parameter arrays iopts and opts for use with function $\mathit{function\; name}$, where $\mathit{function\; name}$ is the short name associated with the function of interest.

$\mathbf{Defaults}$

Resets all options to their default values.

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

See Section 12 in nag_glopt_bnd_pso (e05sac), nag_glopt_nlp_pso (e05sbc), nag_glopt_nlp_multistart_sqp (e05ucc) and nag_glopt_nlp_multistart_sqp_lsq (e05usc) for details of valid values for option and optval. The equals sign ($=$) delimiter must be used to separate the option from its optval value.

optstr is case insensitive. Each token in the option and optval component must be separated by at least one space.

2:    $\mathbf{iopts}\left[\mathbf{liopts}\right]$ – IntegerCommunication Array

On entry: optional parameter array.

If optstr has the form $\mathbf{Initialize}=\mathit{function\; name}$, the contents of iopts need not be set.

Otherwise, iopts MUST NOT have been altered since the last call to nag_glopt_opt_set (e05zkc), nag_glopt_opt_get (e05zlc) or the selected problem solving function.

On exit: dependent on the contents of optstr, either an initialized, reset or updated version of the optional parameter array.

3:    $\mathbf{liopts}$ – IntegerInput

On entry: the length of the array iopts.

Constraint: unless otherwise stated in the documentation for a specific, supported, problem solving function, $\mathbf{liopts}\ge 100$.

4:    $\mathbf{opts}\left[\mathbf{lopts}\right]$ – doubleCommunication Array

On entry: optional parameter array.

If optstr has the form $\mathbf{Initialize}=\mathit{function\; name}$, the contents of opts need not be set.

Otherwise, opts MUST NOT have been altered since the last call to nag_glopt_opt_set (e05zkc), nag_glopt_opt_get (e05zlc) or the selected problem solving function.

On exit: dependent on the contents of optstr, either an initialized, reset or updated version of the optional parameter array.

5:    $\mathbf{lopts}$ – IntegerInput

On entry: the length of the array opts.

Constraint: unless otherwise stated in the documentation for a specific, supported, problem solving function, $\mathbf{lopts}\ge 100$.

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

The NAG error argument (see Section 2.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_INT

On entry, $\mathbf{liopts}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{liopts}\ge 〈\mathit{\text{value}}〉$.

On entry, $\mathbf{lopts}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{lopts}\ge 〈\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.

An unexpected error has been triggered by this function. Please contact NAG.
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 the specified optval to an integer: $\mathbf{optstr}=〈\mathit{\text{value}}〉$.

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

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

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

NE_INVALID_OPTION

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

On entry, the optional parameter in optstr was not recognized: $\mathbf{optstr}=〈\mathit{\text{value}}〉$.

NE_INVALID_VALUE

On entry, the optval supplied for the character optional parameter is not valid.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

On entry, the optval supplied for the integer optional parameter is not valid.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

On entry, the optval supplied for the real optional parameter is not valid.
$\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_NOT_FUN_NAME

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

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example