hide long namesshow long names
hide short namesshow short names
Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

PDF version (NAG web site, 64-bit version, 64-bit version)
Chapter Contents
Chapter Introduction
NAG Toolbox

NAG Toolbox: nag_opt_nlp2_option_integer_get (e04wk)

 Contents

    1  Purpose
    2  Syntax
    7  Accuracy
    9  Example

Purpose

nag_opt_nlp2_option_integer_get (e04wk) is used to get the value of an integer optional parameter. nag_opt_nlp2_option_integer_get (e04wk) can be used before or after calling nag_opt_nlp2_solve (e04wd).

Syntax

[ivalue, iw, rw, ifail] = e04wk(string, iw, rw)
[ivalue, iw, rw, ifail] = nag_opt_nlp2_option_integer_get(string, iw, rw)

Description

nag_opt_nlp2_option_integer_get (e04wk) obtains the current value of an integer option. For example
[itnlim, iw, rw, ifail] = e04wk('Iterations', iw, rw);
will result in the value of the optional parameter Major Iterations Limit being output in itnlim.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Optional Parameters in nag_opt_nlp2_solve (e04wd).

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_nlp2_solve (e04wd)).
2:     iw: int64int32nag_int array
The dimension of the array iw must be at least leniw (see nag_opt_nlp2_init (e04wc))
3:     rw: – double array
The dimension of the array rw must be at least lenrw (see nag_opt_nlp2_init (e04wc))

Optional Input Parameters

None.

Output Parameters

1:     ivalue int64int32nag_int scalar
The integer value associated with the keyword in string.
2:     iw: int64int32nag_int array
The dimension of the array iw will be leniw (see nag_opt_nlp2_init (e04wc))
3:     rw: – double array
The dimension of the array rw will be lenrw (see nag_opt_nlp2_init (e04wc))
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_nlp2_init (e04wc) 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

None.

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

PDF version (NAG web site, 64-bit version, 64-bit version)
Chapter Contents
Chapter Introduction
NAG Toolbox

© The Numerical Algorithms Group Ltd, Oxford, UK. 2009–2015