nag_opt_qpconvex2_sparse_option_integer_set (e04nt) may be used to supply individual integer optional parameters to nag_opt_qpconvex2_sparse_solve (e04nq). The initialization function nag_opt_qpconvex2_sparse_init (e04np) must have been called before calling nag_opt_qpconvex2_sparse_option_integer_set (e04nt).

Syntax

[cw, iw, rw, ifail] = e04nt(string, ivalue, cw, iw, rw)

[cw, iw, rw, ifail] = nag_opt_qpconvex2_sparse_option_integer_set(string, ivalue, cw, iw, rw)

Description

nag_opt_qpconvex2_sparse_option_integer_set (e04nt) may be used to supply values for integer optional parameters to nag_opt_qpconvex2_sparse_solve (e04nq). It is only necessary to call nag_opt_qpconvex2_sparse_option_integer_set (e04nt) for those arguments whose values are to be different from their default values. One call to nag_opt_qpconvex2_sparse_option_integer_set (e04nt) sets one argument value.

Each integer optional parameter is defined by a single character string in string and the corresponding value in ivalue. For example, the following allows the iteration limit to be defined:

itnlim = 1000;
if (m > 500)
  itnlim = 500;
end
[cw, iw, rw, ifail] = e04nt('Iterations', itnlim, cw, iw, rw);

Optional parameter settings are preserved following a call to nag_opt_qpconvex2_sparse_solve (e04nq) and so the keyword Defaults is provided to allow you to reset all the optional parameters to their default values before a subsequent call to nag_opt_qpconvex2_sparse_solve (e04nq).

A complete list of optional parameters, their abbreviations, synonyms and default values is given in Optional Parameters in nag_opt_qpconvex2_sparse_solve (e04nq).

References

None.

Parameters

Compulsory Input Parameters

1: $string$ – string: A single valid keyword of an integer optional parameter (as described in Optional Parameters in nag_opt_qpconvex2_sparse_solve (e04nq)).
2: $ivalue$ – int64int32nag_int scalar: An integer value associated with the keyword in string.
3: $cw (:)$ – cell array of strings: The dimension of the array cw must be at least $lencw$ (see nag_opt_qpconvex2_sparse_init (e04np))
4: $iw (:)$ – int64int32nag_int array: The dimension of the array iw must be at least $leniw$ (see nag_opt_qpconvex2_sparse_init (e04np))
5: $rw (:)$ – double array: The dimension of the array rw must be at least $lenrw$ (see nag_opt_qpconvex2_sparse_init (e04np))

Optional Input Parameters

None.

Output Parameters

1: $cw (:)$ – cell array of strings: The dimension of the array cw will be $lencw$ (see nag_opt_qpconvex2_sparse_init (e04np))
2: $iw (:)$ – int64int32nag_int array: The dimension of the array iw will be $leniw$ (see nag_opt_qpconvex2_sparse_init (e04np))
3: $rw (:)$ – double array: The dimension of the array rw will be $lenrw$ (see nag_opt_qpconvex2_sparse_init (e04np))
4: $ifail$ – int64int32nag_int scalar: $ifail = 0$ unless the function detects an error (see Error Indicators and Warnings).

Error Indicators and Warnings

Errors or warnings detected by the function:

$ifail = 1$: The initialization function nag_opt_qpconvex2_sparse_init (e04np) has not been called.

$ifail = 2$: The supplied option is invalid. Check that the keywords are neither ambiguous nor misspelt.

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.

$ifail = - 999$: Dynamic memory allocation failed.

Accuracy

Not applicable.

Further Comments

nag_opt_qpconvex2_sparse_option_string (e04ns) may also be used to supply integer optional parameters to nag_opt_qpconvex2_sparse_solve (e04nq).

Example

Open in the MATLAB editor: e04nt_example

function e04nt_example


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

% Initialize communication arrays
[cw, iw, rw, ifail] = e04np;

% Set option "Print file" to 6
string = 'Print file';
ivalue = int64(6);
[cw, iw, rw, ifail] = e04nt( ...
			     string, ivalue, cw, iw, rw);

% Get value of option "Print file"
[ivalue, cw, iw, rw, ifail] =  ...
  e04nx(string, cw, iw, rw);

fprintf('The value of option ''Print file'' is %3d\n', ivalue);

e04nt example results

The value of option 'Print file' is   6

PDF version (NAG web site, 64-bit version, 64-bit version)

Chapter Contents

Chapter Introduction

NAG Toolbox