NAG Toolbox: nag_opt_nlp2_option_integer_get (e04wk)

Purpose

Syntax

Description

[itnlim, iw, rw, ifail] = e04wk('Iterations', 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_solve (e04wd)).

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

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

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

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

Optional Input Parameters

None.

Output Parameters

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

The integer value associated with the keyword in string.

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

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

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

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

4:     $\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_init (e04wc) 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: e04wk_example

function e04wk_example


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

string = 'Iterations';
itmax = int64(100);

% Initialize
[iw, rw, ifail] = e04wc;
% Set option
[iw, rw, ifail] = e04wg( ...
                         string, itmax, iw, rw);
% Get option value
[ivalue, iw, rw, ifail] = e04wk( ...
                                 string, iw, rw);

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

e04wk example results

Iterations has been set to   100