NAG Library Routine Document

D01ZKF

1  Purpose

2  Specification

3  Description

call D01ZKF('Initialize = d01raf', IOPTS, LIOPTS, OPTS, LOPTS, IFAIL)

4  References

5  Parameters

1:     OPTSTR – CHARACTER(*)Input

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

$\mathbf{Initialize}=\mathit{routine\; name}$

Initialize the optional parameter arrays IOPTS and OPTS for use with routine $\mathit{routine\; name}$, where $\mathit{routine\; name}$ is the short name associated with the routine of interest. The associated long name may also be used, however only the short name will be returned if D01ZLF is called with $\mathbf{OPTSTR}=\mathbf{Identify}$.

$\mathbf{Defaults}$

Resets all options to their default values.

$\mathbf{Option}=\mathit{optval}$

See Section 10 in D01RAF 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 arrayCommunication Array

On entry: optional parameter array.

If OPTSTR has the form $\mathbf{Initialize}=\mathit{routine\; name}$, the contents of IOPTS need not be set.

Otherwise, IOPTS must not have been altered since the last call to D01ZKF, D01ZLF or the selected problem solving routine.

On exit: dependent on the contents of OPTSTR, either an initialized, reset or updated version of the optional parameter array.

3:     LIOPTS – INTEGERInput

On entry: the length of the array IOPTS.

Constraint: unless otherwise stated in the documentation for a specific, supported, problem solving routine, $\mathbf{LIOPTS}\ge 100$.

4:     OPTS(LOPTS) – REAL (KIND=nag_wp) arrayCommunication Array

On entry: optional parameter array.

If OPTSTR has the form $\mathbf{Initialize}=\mathit{routine\; name}$, the contents of OPTS need not be set.

Otherwise, OPTS must not have been altered since the last call to D01ZKF, D01ZLF or the selected problem solving routine.

On exit: dependent on the contents of OPTSTR, either an initialized, reset or updated version of the optional parameter array.

5:     LOPTS – INTEGERInput

On entry: the length of the array OPTS.

Constraint: Unless otherwise stated in the documentation for a specific, supported, problem solving routine, $\mathbf{LOPTS}\ge 100$.

6:     IFAIL – INTEGERInput/Output

On entry: IFAIL must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{ or }1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$. When the value $-\mathbf{1}\text{ or }\mathbf{1}$ is used it is essential to test the value of IFAIL on exit.

On exit: $\mathbf{IFAIL}=\mathbf{0}$ unless the routine detects an error or a warning has been flagged (see Section 6).

6  Error Indicators and Warnings

$\mathbf{IFAIL}=11$

On entry, the option in OPTSTR has not been recognized. .

$\mathbf{IFAIL}=12$

On entry, OPTSTR did not contain the delimiter ‘$=$’.

$\mathbf{IFAIL}=13$

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 optval, , associated with OPTSTR was partially recognized as a numerical value. However, it could not be fully interpreted.

$\mathbf{IFAIL}=14$

On entry, the option in OPTSTR has been detected as Initialize, however the optval, , associated with OPTSTR has not been recognized as a valid routine name.

$\mathbf{IFAIL}=15$

On entry, the integer optval associated with the optional parameter is not valid. One of the following may apply:

• On entry, the absolute value of the integer present in OPTSTR is above the maximum allowable value.
  $\left|\mathit{ivalue}\right|=⟨\mathit{\text{value}}⟩$, $\left|\mathit{ivalue}\right|\le ⟨\mathit{\text{value}}⟩$ required.
• On entry, the absolute value of the integer present in OPTSTR is below the minimum required value.
  $\left|\mathit{ivalue}\right|=⟨\mathit{\text{value}}⟩$, $\left|\mathit{ivalue}\right|\ge ⟨\mathit{\text{value}}⟩$ required.
• On entry, the integer value present in OPTSTR is above the maximum allowable value.
  $\mathit{ivalue}=⟨\mathit{\text{value}}⟩$, $\mathit{ivalue}\le ⟨\mathit{\text{value}}⟩$ required.
• On entry, the integer value present in OPTSTR is below the minimum allowable value.
  $\mathit{ivalue}=⟨\mathit{\text{value}}⟩$, $\mathit{ivalue}\ge ⟨\mathit{\text{value}}⟩$ required.
• On entry, the integer value present in OPTSTR is outside of allowable bounds.
  $\mathit{ivalue}=⟨\mathit{\text{value}}⟩$, $⟨\mathit{\text{value}}⟩\le \mathit{ivalue}\le ⟨\mathit{\text{value}}⟩$ required.
• On entry, the integer value present in OPTSTR is outside the allowable set.
  $\mathit{ivalue}=⟨\mathit{\text{value}}⟩$.

$\mathbf{IFAIL}=16$

On entry, the real optval associated with the optional parameter is not valid. One of the following may apply:

• On entry, the magnitude of the real value present in OPTSTR is above the maximum allowable value.
  $\left|\mathit{rvalue}\right|=⟨\mathit{\text{value}}⟩$, $\left|\mathit{rvalue}\right|\le ⟨\mathit{\text{value}}⟩$ required.
• On entry, the magnitude of the real value present in OPTSTR is below the minimum required.
  $\left|\mathit{rvalue}\right|=⟨\mathit{\text{value}}⟩$, $\left|\mathit{rvalue}\right|\ge ⟨\mathit{\text{value}}⟩$ required.
• On entry, the real value present in OPTSTR is above the maximum allowable value.
  $\mathit{rvalue}=⟨\mathit{\text{value}}⟩$ and $\mathit{rvalue}<⟨\mathit{\text{value}}⟩$ required.
• On entry, the real value present in OPTSTR is below the minimum required value.
  $\mathit{rvalue}=⟨\mathit{\text{value}}⟩$, $\mathit{rvalue}>⟨\mathit{\text{value}}⟩$ required.
• On entry, the real value present in OPTSTR is outside allowable bounds.
  $\mathit{rvalue}=⟨\mathit{\text{value}}⟩$, $⟨\mathit{\text{value}}⟩\le \mathit{rvalue}\le ⟨\mathit{\text{value}}⟩$ required.
• On entry, the real value present in OPTSTR is outside the allowable set.
  $\mathit{rvalue}=⟨\mathit{\text{value}}⟩$.

$\mathbf{IFAIL}=17$

On entry, the character optval associated with the optional parameter is not valid. One of the following may apply:

• On entry, the value of optval in OPTSTR is not compatible with the option in OPTSTR. .
• The $\mathbf{option}=\mathit{optval}$ pairing present in OPTSTR is not compatible with the routine for which the option arrays were initialized.

$\mathbf{IFAIL}=21$

Either the option arrays have not been initialized, have been corrupted, or are not compatible with this option setting routine. Either the option arrays have not been initialized, have been corrupted, or are not compatible with this option setting routine.

On entry, the optional parameter arrays IOPTS and OPTS have not been initialized, or have been corrupted.

$\mathbf{IFAIL}=31$

LIOPTS is insufficient for the chosen routine name.
On entry, $\mathbf{LIOPTS}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{LIOPTS}\ge ⟨\mathit{\text{value}}⟩$.

$\mathbf{IFAIL}=51$

LOPTS is insufficient for the chosen routine name.
On entry, $\mathbf{LOPTS}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{LOPTS}\ge ⟨\mathit{\text{value}}⟩$.

$\mathbf{IFAIL}=-999$

Dynamic memory allocation failed.

7  Accuracy

8  Further Comments

9  Example