NAG Library Function Document

nag_opt_handle_opt_get (e04znc)

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 whose current value is required. See the documentation of the particular solver for information on valid options.

3:    $\mathbf{ivalue}$ – Integer *Output

On exit: if the optional parameter supplied in optstr is an integer-valued argument, ivalue will hold its current value.

4:    $\mathbf{rvalue}$ – double *Output

On exit: if the optional parameter supplied in optstr is a real-valued argument, rvalue will hold its current value.

5:    $\mathbf{cvalue}$ – char *Output

Note: the string returned in cvalue will never exceed $\min \left(\mathbf{lcvalue},41\right)$ characters in length, including the terminating NULL character.

On exit: if the optional parameter supplied in optstr is a character-valued argument, cvalue will hold its current value.

6:    $\mathbf{lcvalue}$ – IntegerInput

On entry: length of the string cvalue. At most $\mathbf{lcvalue}-1$ non-null characters will be written into cvalue.

Constraint: $\mathbf{lcvalue}>1$.

7:    $\mathbf{optype}$ – Nag_VariableType *Output

On exit: indicates whether the optional parameter supplied in optstr is an integer, real or character-valued argument and hence which of ivalue, rvalue or cvalue holds the current value.

$\mathbf{optype}=\mathrm{Nag\_Integer}$

optstr is an integer-valued optional parameter; its current value has been returned in ivalue.

$\mathbf{optype}=\mathrm{Nag\_Real}$

optstr is a real-valued optional parameter; its current value has been returned in rvalue.

$\mathbf{optype}=\mathrm{Nag\_Character}$

optstr is a character-valued optional parameter; its current value has been returned in cvalue.

8:    $\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_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_INT

On entry, $\mathbf{lcvalue}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{lcvalue}>1$.

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_OPTION

On entry, the option supplied in optstr was not recognized: $\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.

NW_TRUNCATED

On entry, optstr indicates a character optional parameter, but cvalue is too short to hold the stored value. The returned value will be truncated.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example