NAG Library Routine Document

h02cgf  (iqp_sparse_optstr)


    1  Purpose
    7  Accuracy
    10  Example


To supply individual optional parameters to h02cef.


Fortran Interface
Subroutine h02cgf ( str)
Character (*), Intent (In):: str
C Header Interface
#include nagmk26.h
void  h02cgf_ ( const char *str, const Charlen length_str)


h02cgf may be used to supply values for optional parameters to h02cef. It is only necessary to call h02cgf for those arguments whose values are to be different from their default values. One call to h02cgf 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 equal 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 real value. Such numbers may be up to 16 contiguous characters in Fortran 77'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.
Normally, each user-specified option is printed as it is defined, on the current advisory message unit (see x04abf), but this printing may be suppressed using the keyword Nolist. Thus the statement
Call h02cgf ('Nolist')
suppresses printing of this and subsequent options. Printing will automatically be turned on again after a call to h02cef, and may be turned on again at any time using the keyword List.
Optional parameter settings are preserved following a call to h02cef, and so the keyword Defaults is provided to allow you to reset all the optional parameters to their default values by the statement
Call h02cgf ('Defaults')
prior to a subsequent call to h02cef.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in h02cef.




1:     str – Character(*)Input
On entry: a single valid option string (as described in Section 3 above and in Section 12 in h02cef).

Error Indicators and Warnings

If a line is not recognized as a valid option, then a warning message is output on the current advisory message unit (see x04abf).


Not applicable.

Parallelism and Performance

h02cgf is not thread safe and should not be called from a multithreaded user program. Please see Section 3.12.1 in How to Use the NAG Library and its Documentation for more information on thread safety.
h02cgf is not threaded in any implementation.

Further Comments

h02cff may also be used to supply optional parameters to h02cef. Note that if e04nkf/e04nka is used in the same program as h02cef, then in general h02cff will also affect the options used by e04nkf/e04nka.


See Section 10 in h02cef.
© The Numerical Algorithms Group Ltd, Oxford, UK. 2017