nag_quad_opt_set (d01zkc) either initializes or resets the optional argument arrays or sets a single optional argument for supported problem solving functions in
Chapter d01. Currently only
nag_quad_1d_gen_vec_multi_rcomm (d01rac) is supported.
nag_quad_opt_set (d01zkc) has three purposes: to initialize optional argument arrays; to reset all optional arguments to their default values; or to set a single optional argument to a user-supplied value.
Optional arguments and their values are, in general, presented as a character string,
optstr, of the form ‘
option ’; alphabetic characters can be supplied in either upper or lower case. Both
option and
may consist of one or more tokens separated by white space. The tokens that comprise
will normally be either an integer, real or character value as defined in the description of the specific optional argument. In addition all optional arguments can take an
DEFAULT which resets the optional argument to its default value.
It is imperative that optional argument arrays are initialized before any options are set, before the relevant problem solving function is called and before any options are queried using
nag_quad_opt_get (d01zlc). To initialize the optional argument arrays
iopts and
opts for a specific problem solving function, the option
Initialize is used with
optval identifying the problem solving function to be called, via its short name. For example, to initialize the optional argument arrays to be passed to
nag_quad_1d_gen_vec_multi_rcomm (d01rac) and its associated function
nag_quad_1d_gen_vec_multi_dimreq (d01rcc), nag_quad_opt_set (d01zkc) is called as follows:
nag_quad_opt_set("Initialize = d01rac", iopts, liopts, opts, lopts, &fail)
The available option names and their corresponding valid values are given in
Section 11 in nag_quad_1d_gen_vec_multi_rcomm (d01rac).
None.
- NE_BAD_PARAM
-
On entry, argument had an illegal value.
- NE_INT
-
On entry, .
Constraint: .
On entry, .
Constraint: .
- NE_INTERNAL_ERROR
-
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact
NAG for assistance.
- NE_INVALID_FORMAT
-
On entry, could not convert the specified optval to an integer:
.
On entry, could not convert the specified optval to a real:
.
On entry, the expected delimiter ‘
’ was not found in
optstr:
.
- NE_INVALID_OPTION
-
On entry, either the option arrays have not been initialized or they have been corrupted.
On entry, the optional argument in
optstr was not recognized:
.
- NE_INVALID_VALUE
-
On entry, the optval supplied for the character optional argument is not valid.
.
On entry, the optval supplied for the integer optional argument is not valid.
.
On entry, the optval supplied for the real optional argument is not valid.
.
- NE_NOT_FUN_NAME
-
On entry, attempting to initialize the optional argument arrays but specified function name was not valid:
.
Not applicable.
Not applicable.
For suites of functions that share the same option arrays, the option arrays must be initialized using the primary (driver) function name.
When encoding integer valued options in
optstr, the integer
must be written as an explicit integer. For example,
"Maximum Subdivisions = 12" is acceptable, whereas
"Maximum Subdivisions = 12.0" and
"Maximum Subdivisions = 0.12e2"
are not.
When encoding real valued options in
optstr, the
may be integral if appropriate. For example,
"Absolute Tolerance = 10",
"Absolute Tolerance = 10.0" and
"Absolute Tolerance = 1.0e1"
are all acceptable.
See the example programs associated with the problem solving function you wish to use for a demonstration of how to use nag_quad_opt_set (d01zkc) to initialize option arrays and set options.