h02zkf either initializes or resets the optional parameter arrays or sets a single optional parameter for supported problem solving routines in Chapter H.

Currently, only h02daf is supported.

2 Specification

Fortran Interface

Subroutine h02zkf (

optstr, iopts, liopts, opts, lopts, ifail)

Integer, Intent (In)	::	liopts, lopts
Integer, Intent (Inout)	::	iopts(liopts), ifail
Real (Kind=nag_wp), Intent (Inout)	::	opts(lopts)
Character (*), Intent (In)	::	optstr

C Header Interface

#include <nag.h>

void	h02zkf_ (const char optstr, Integer iopts[], const Integer liopts, double opts[], const Integer lopts, Integer ifail, const Charlen length_optstr)

The routine may be called by the names h02zkf or nagf_mip_optset.

3 Description

h02zkf has three purposes: to initialize optional parameter arrays; to reset all optional parameters to their default values; or to set a single optional parameter to a user-supplied value.

Optional parameters and their values are, in general, presented as a character string, optstr, of the form ‘

option = optval

’; alphabetic characters can be supplied in either upper or lower case. Both

option

and

optval

may consist of one or more tokens separated by white space. The tokens that comprise

optval

will normally be either an integer, real or character value as defined in the description of the specific optional argument. In addition all optional parameters can take an

optval

DEFAULT which resets the optional parameter to its default value.

It is imperative that optional parameter arrays are initialized before any options are set, before the relevant problem solving routine is called and before any options are queried using h02zlf. To initialize the optional parameter arrays iopts and opts for a specific problem solving routine, the option Initialize is used with

optval

identifying the problem solving routine to be called. For example, to initialize optional parameter arrays to be passed to h02daf, h02zkf is called as follows:

Call h02zkf('Initialize = h02daf', iopts, liopts, opts, lopts, ifail)

Note that the routine name may be abbreviated to just the first five letters of the ‘short’ name, or by omitting the nagf_ or mip_ prefixes of the ‘long’ name. So the above may be equivalently specified as 'Initialize = h02da' or 'Initialize = sqp'.

Information relating to available option names and their corresponding valid values is given in Section 11 in h02daf.

4 References

None.

5 Arguments

1: $optstr$ – Character(*) Input

On entry: a string identifying the option to be set.

$Initialize = routine name$: Initialize the optional parameter arrays iopts and opts for use with routine $routine name$ , where $routine name$ is the name associated with the routine of interest.
$Defaults$: Resets all options to their default values.

$option = optval$: See Section 11 in h02daf for details of valid values for $option$ and $optval$ . The equals sign ( $=$ ) delimiter must be used to separate the $option$ from its $optval$ value.

optstr is case insensitive. Each token in the

option

and

optval

component must be separated by at least one space.

2: $iopts (liopts)$ – Integer array Communication Array

3: $liopts$ – Integer Input

On entry: the length of the array iopts.

Constraint: unless otherwise stated in the documentation for a specific, supported, problem solving routine,

liopts \geq 200

4: $opts (lopts)$ – Real (Kind=nag_wp) array Communication Array

5: $lopts$ – Integer Input

On entry: the length of the array opts.

Constraint: unless otherwise stated in the documentation for a specific, supported, problem solving routine,

lopts \geq 100

6: $ifail$ – Integer Input/Output

On entry: ifail must be set to

0

−1

1

to set behaviour on detection of an error; these values have no effect when no error is detected.

A value of

0

causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of

−1

means that an error message is printed while a value of

1

means that it is not.

If halting is not appropriate, the value

−1

1

is recommended. If message printing is undesirable, then the value

1

is recommended. Otherwise, the value

0

is recommended. When the value $- 1$ or $1$ is used it is essential to test the value of ifail on exit.

On exit:

ifail = 0

unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

ifail = 0

−1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 11$: On entry, the optional parameter in optstr was not recognized: $optstr = ⟨ value ⟩$ .

$ifail = 12$: On entry, the expected delimiter ‘ $=$ ’ was not found in optstr: $optstr = ⟨ value ⟩$ .

$ifail = 13$: On entry, could not convert the specified $optval$ to an integer: $optstr = ⟨ value ⟩$ .

On entry, could not convert the specified $optval$ to a real: $optstr = ⟨ value ⟩$ .

$ifail = 14$: On entry, attempting to initialize the optional parameter arrays but specified routine name was not valid: $name = ⟨ value ⟩$ .

$ifail = 15$: On entry, the $optval$ supplied for the integer optional parameter is not valid.
$optstr = ⟨ value ⟩$ .

$ifail = 16$: On entry, the $optval$ supplied for the real optional parameter is not valid.
$optstr = ⟨ value ⟩$ .

$ifail = 17$: On entry, the $optval$ supplied for the character optional parameter is not valid.
$optstr = ⟨ value ⟩$ .

$ifail = 21$: On entry, either the option arrays have not been initialized or they have been corrupted.

$ifail = 31$: On entry, $liopts = ⟨ value ⟩$ .
Constraint: $liopts \geq ⟨ value ⟩$ .

$ifail = 51$: On entry, $lopts = ⟨ value ⟩$ .
Constraint: $lopts \geq ⟨ value ⟩$ .

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

h02zkf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

None.

10 Example

See the example programs associated with the problem solving routine you wish to use for a demonstration of how to use h02zkf to initialize option arrays and set options.

NAG Library Manual, Mark 28.6

Interfaces: FL CL CPP AD PY MB

NAG FL Interface Introduction

H (Mip) Chapter Contents

H (Mip) Chapter Introduction

h02zk: FL CL CPP AD PY MB

NAG FL Interfaceh02zkf (optset)

▸▿ Contents

1 Purpose