NAG Toolbox: nag_opt_nlp2_sparse_option_integer_get (e04vr)

Purpose

Syntax

Description

[itnlim, cw, iw, rw, ifail] = e04vr('Major Iterations', cw, iw, rw);

References

Parameters

Compulsory Input Parameters

1:     $\mathrm{string}$ – string

A single valid keyword of an integer optional parameter (as described in Optional Parameters in nag_opt_nlp2_sparse_solve (e04vh)).

2:     $\mathrm{cw}\left(:\right)$ – cell array of strings

The dimension of the array cw must be at least $\mathbf{lencw}$ (see nag_opt_nlp2_sparse_init (e04vg))

3:     $\mathrm{iw}\left(:\right)$ – int64int32nag_int array

The dimension of the array iw must be at least $\mathbf{leniw}$ (see nag_opt_nlp2_sparse_init (e04vg))

4:     $\mathrm{rw}\left(:\right)$ – double array

The dimension of the array rw must be at least $\mathbf{lenrw}$ (see nag_opt_nlp2_sparse_init (e04vg))

Optional Input Parameters

None.

Output Parameters

1:     $\mathrm{ivalue}$ – int64int32nag_int scalar

The integer value associated with the keyword in string.

2:     $\mathrm{cw}\left(:\right)$ – cell array of strings

The dimension of the array cw will be $\mathbf{lencw}$ (see nag_opt_nlp2_sparse_init (e04vg))

3:     $\mathrm{iw}\left(:\right)$ – int64int32nag_int array

The dimension of the array iw will be $\mathbf{leniw}$ (see nag_opt_nlp2_sparse_init (e04vg))

4:     $\mathrm{rw}\left(:\right)$ – double array

The dimension of the array rw will be $\mathbf{lenrw}$ (see nag_opt_nlp2_sparse_init (e04vg))

5:     $\mathrm{ifail}$ – int64int32nag_int scalar

$\mathbf{ifail}=\mathbf{0}$ unless the function detects an error (see Error Indicators and Warnings).

Error Indicators and Warnings

   $\mathbf{ifail}=1$

The initialization function nag_opt_nlp2_sparse_init (e04vg) has not been called.

   $\mathbf{ifail}=2$

The supplied option is invalid. Check that the keywords are neither ambiguous nor misspelt.

   $\mathbf{ifail}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

   $\mathbf{ifail}=-399$

Your licence key may have expired or may not have been installed correctly.

   $\mathbf{ifail}=-999$

Dynamic memory allocation failed.

Accuracy

Further Comments

Example

Open in the MATLAB editor: e04vr_example

function e04vr_example


fprintf('e04vr example results\n\n');

string = 'Elastic mode';
elmode = int64(1);

% Initialize
[cw, iw, rw, ifail] = e04vg;

% Set option
[cw, iw, rw, ifail] = e04vm( ...
                             string, elmode, cw, iw, rw);
% Get option value
[ivalue, cw, iw, rw, ifail] = e04vr( ...
                                     string, cw, iw, rw);

fprintf('%s has been set to %5d\n', string, ivalue);

e04vr example results

Elastic mode has been set to     1