NAG C Library Function Document

nag_opt_handle_set_get_real (e04rxc)

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 between calls to the NAG optimization modelling suite.

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

On entry: a string which identifies the item within the handle to be read or written. The string is case insensitive and space tolerant.

Constraint: $\mathbf{cmdstr}='\mathrm{Primal\; Variables}','\mathrm{Dual\; Variables}','\mathrm{X}'\text{ or }'\mathrm{U}'$.

3:    $\mathbf{ioflag}$ – IntegerInput

On entry: indicates the direction of the communication.

$\mathbf{ioflag}\ne 0$

nag_opt_handle_set_get_real (e04rxc) will extract the requested information from the handle to rarr.

$\mathbf{ioflag}=0$

The writing mode will apply and the content of rarr will be copied to the handle.

4:    $\mathbf{lrarr}$ – Integer *Input/Output

On entry: the dimension of the array rarr.

On exit: the correct expected dimension of rarr if lrarr does not match the item identified by cmdstr (in this case nag_opt_handle_set_get_real (e04rxc) returns $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_DIM_MATCH).

5:    $\mathbf{rarr}\left[\mathbf{lrarr}\right]$ – doubleInput/Output

On entry: if $\mathbf{ioflag}=0$ (write mode), rarr must contain the information to be written to the handle; otherwise it does not need to be set.

On exit: if $\mathbf{ioflag}\ne 0$ (read mode), rarr contains the information requested by cmdstr; otherwise rarr is unchanged.

6:    $\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_DIM_MATCH

On entry, $\mathbf{lrarr}=〈\mathit{\text{value}}〉$, expected $\mathrm{value}=〈\mathit{\text{value}}〉$.
Constraint: lrarr must match the size of the data identified in cmdstr.

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_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 request cannot be processed at this phase.

The requested information is not available.

NE_READ_ERROR

Reading mode is not supported for the given cmdstr.

NE_STATE

The request cannot be processed by the current solver.

NE_STR_UNKNOWN

The provided cmdstr is not recognised.

NE_WRITE_ERROR

Writing mode is not supported for the given cmdstr.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (e04rxce.c)

10.2

Program Data

Program Data (e04rxce.d)

10.3

Program Results

Program Results (e04rxce.r)