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_sparse_option_double_get (e04vs)

 Contents

    1  Purpose
    2  Syntax
    7  Accuracy
    9  Example

Purpose

nag_opt_nlp2_sparse_option_double_get (e04vs) is used to get the value of a double optional parameter. nag_opt_nlp2_sparse_option_double_get (e04vs) can be used before or after calling nag_opt_nlp2_sparse_solve (e04vh).

Syntax

[rvalue, cw, iw, rw, ifail] = e04vs(string, cw, iw, rw)
[rvalue, cw, iw, rw, ifail] = nag_opt_nlp2_sparse_option_double_get(string, cw, iw, rw)

Description

nag_opt_nlp2_sparse_option_double_get (e04vs) obtains the current value of a double option. For example
[featol, cw, iw, rw, ifail] = e04vr('Feasibility Tolerance', cw, iw, rw);
will result in the value of the optional parameter Feasibility Tolerance being output in featol.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Optional Parameters in nag_opt_nlp2_sparse_solve (e04vh).

References

None.

Parameters

Compulsory Input Parameters

1:     string – string
A single valid keyword of a double optional parameter (as described in Optional Parameters in nag_opt_nlp2_sparse_solve (e04vh)).
2:     cw: – cell array of strings
The dimension of the array cw must be at least lencw (see nag_opt_nlp2_sparse_init (e04vg))
3:     iw: int64int32nag_int array
The dimension of the array iw must be at least leniw (see nag_opt_nlp2_sparse_init (e04vg))
4:     rw: – double array
The dimension of the array rw must be at least lenrw (see nag_opt_nlp2_sparse_init (e04vg))

Optional Input Parameters

None.

Output Parameters

1:     rvalue – double scalar
The double value associated with the keyword in string.
2:     cw: – cell array of strings
The dimension of the array cw will be lencw (see nag_opt_nlp2_sparse_init (e04vg))
3:     iw: int64int32nag_int array
The dimension of the array iw will be leniw (see nag_opt_nlp2_sparse_init (e04vg))
4:     rw: – double array
The dimension of the array rw will be lenrw (see nag_opt_nlp2_sparse_init (e04vg))
5:     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_sparse_init (e04vg) 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 e04vs_example


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

featol = 1e-6;
string = 'Feasibility Tolerance';

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

% Set option
[cw, iw, rw, ifail] = e04vn( ...
                             string, featol, cw, iw, rw);
% Get option
[rvalue, cw, iw, rw, ifail] = e04vs( ...
                                     string, cw, iw, rw);

fprintf('%s has been set to %10.2e\n', string, rvalue);


e04vs example results

Feasibility Tolerance has been set to   1.00e-06

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