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_lsq_gencon_deriv_option_string (e04ur)

 Contents

    1  Purpose
    2  Syntax
    7  Accuracy
    9  Example

Purpose

To supply individual optional parameters to nag_opt_lsq_gencon_deriv (e04us).

Syntax

[lwsav, iwsav, rwsav, inform] = e04ur(str, lwsav, iwsav, rwsav)
[lwsav, iwsav, rwsav, inform] = nag_opt_lsq_gencon_deriv_option_string(str, lwsav, iwsav, rwsav)

Description

nag_opt_lsq_gencon_deriv_option_string (e04ur) may be used to supply values for optional parameters to nag_opt_lsq_gencon_deriv (e04us). It is only necessary to call nag_opt_lsq_gencon_deriv_option_string (e04ur) for those arguments whose values are to be different from their default values. One call to nag_opt_lsq_gencon_deriv_option_string (e04ur) sets one argument value.
Each optional parameter is defined by a single character string, of up to 72 characters, consisting of one or more items. The items associated with a given option must be separated by spaces, or equals signs =. Alphabetic characters may be upper or lower case. The string
Print Level = 1
is an example of a string used to set an optional parameter. For each option the string contains one or more of the following items:
a mandatory keyword;
a phrase that qualifies the keyword;
a number that specifies an integer or double value. Such numbers may be up to 16 contiguous characters in Fortran's I, F, E or D formats, terminated by a space if this is not the last item on the line.
Blank strings and comments are ignored. A comment begins with an asterisk (*) and all subsequent characters in the string are regarded as part of the comment.
For nag_opt_lsq_gencon_deriv_option_string (e04ur), each user-specified option is normally printed as it is defined, on the current advisory message unit (see nag_file_set_unit_advisory (x04ab)), but this printing may be suppressed using the keyword Nolist. Thus the statement
[lwsav, iwsav, rwsav, inform] = e04ur('Nolist', lwsav, iwsav, rwsav);
suppresses printing of this and subsequent options. Printing will automatically be turned on again after a call to nag_opt_lsq_gencon_deriv (e04us) and may be turned on again at any time using the keyword List.
Optional parameter settings are preserved following a call to nag_opt_lsq_gencon_deriv (e04us) 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_lsq_gencon_deriv (e04us).
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Optional Parameters in nag_opt_lsq_gencon_deriv (e04us).

References

None.

Parameters

Compulsory Input Parameters

1:     str – string
A single valid option string (as described in Description and in Optional Parameters in nag_opt_lsq_gencon_deriv (e04us).
2:     lwsav120 – logical array
3:     iwsav610 int64int32nag_int array
4:     rwsav475 – double array
The arrays lwsav, iwsav and rwsav must not be altered between calls to any of the functions nag_opt_lsq_gencon_deriv_option_string (e04ur), nag_opt_lsq_gencon_deriv_option_string (e04ur).

Optional Input Parameters

None.

Output Parameters

1:     lwsav120 – logical array
2:     iwsav610 int64int32nag_int array
3:     rwsav475 – double array
4:     inform int64int32nag_int scalar
Contains zero if a valid option string has been supplied and a value>0 otherwise (see Error Indicators and Warnings).

Error Indicators and Warnings

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

Accuracy

Not applicable.

Further Comments

None.

Example

function e04ur_example


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

infbd = 1e25;
string = sprintf('Infinite Bound Size = %9.1e',infbd);

% Initialize
[cwsav,lwsav,iwsav,rwsav,ifail] = e04wb( ...
                                         'e04us');
% Put listing on
[lwsav, iwsav, rwsav, inform] = e04ur( ...
                                       'List', lwsav, iwsav, rwsav);
[lwsav, iwsav, rwsav, inform] = e04ur( ...
                                       string, lwsav, iwsav, rwsav);


e04ur example results



 Calls to E04URA
 ---------------

      List
      Infinite Bound Size =   1.0e+25

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