NAG Library Function Document

nag_opt_handle_opt_set (e04zmc)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

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

On entry: the handle to the problem. It needs to be initialized by nag_opt_handle_init (e04rac) and must not be changed.

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

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

$\mathbf{Defaults}$

Resets all options to their default values.

$\mathit{Option}=\mathit{optval}$

See the documentation of the particular solver for details of valid values for option and optval. The equals sign ($=$) delimiter must be used to separate the option from its optval value.

$\mathit{Option}=\mathbf{Default}$

Resets the given option back to its default value.

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

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

The supplied handle does not define a valid handle to the data structure for the NAG optimization modelling suite. It has not been initialized by nag_opt_handle_init (e04rac) or it has been corrupted.

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 the specified optval to an integer: $\mathit{optval}=〈\mathit{\text{value}}〉$.

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

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

NE_INVALID_OPTION

On entry, the option supplied 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.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.

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

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

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

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

On entry, the optval supplied for the real optional parameter is not valid.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.
Constraint: $\mathit{optval}<〈\mathit{\text{value}}〉$.

On entry, the optval supplied for the real optional parameter is not valid.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.
Constraint: $\mathit{optval}>〈\mathit{\text{value}}〉$.

On entry, the optval supplied for the real optional parameter is not valid.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.
Constraint: $\mathit{optval}\le 〈\mathit{\text{value}}〉$.

On entry, the optval supplied for the real optional parameter is not valid.
$\mathit{option}=〈\mathit{\text{value}}〉$, $\mathit{optval}=〈\mathit{\text{value}}〉$.
Constraint: $\mathit{optval}\ge 〈\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_PHASE

The options cannot be modified in this phase.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example