NAG Library Routine Document

c09ddf  (dim1_mxolap_multi_inv)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{nwlinv}$ – IntegerInput

On entry: the number of levels to be used in the inverse multi-level transform. The number of levels must be less than or equal to $n_{\mathrm{fwd}}$, which has the value of argument nwl as used in the computation of the wavelet coefficients using c09dcf. The data will be reconstructed to level $\left(\mathbf{nwl}-\mathbf{nwlinv}\right)$, where level $0$ is the original input dataset provided to c09dcf.

Constraint: $1\le \mathbf{nwlinv}\le \mathbf{nwl}$, where nwl is the value used in a preceding call to c09dcf.

2:     $\mathbf{keepa}$ – Character(1)Input

On entry: determines whether the approximation coefficients are stored in array c for every level of the computed transform or else only for the final level. In both cases, the detail coefficients are stored in c for every level computed.

$\mathbf{keepa}=\text{'A'}$

Retain approximation coefficients for all levels computed.

$\mathbf{keepa}=\text{'F'}$

Retain approximation coefficients for only the final level computed.

Constraint: $\mathbf{keepa}=\text{'A'}$ or $\text{'F'}$.

3:     $\mathbf{lenc}$ – IntegerInput

On entry: the dimension of the array c as declared in the (sub)program from which c09ddf is called.

Constraints:

• if $\mathbf{keepa}=\text{'F'}$, $\mathbf{lenc}\ge \left(n_{\mathrm{l}}+1\right)\times n_a$;
• if $\mathbf{keepa}=\text{'A'}$, $\mathbf{lenc}\ge 2\times n_l\times n_a$, where $n_a$ is the number of approximation or detail coefficients at each level and is unchanged from the preceding call to c09dcf.

4:     $\mathbf{c}\left(\mathbf{lenc}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: the coefficients of a multi-level wavelet transform of the dataset.

The coefficients are stored in c as follows:

If $\mathbf{keepa}=\text{'F'}$,

$\mathbf{c}\left(1:n_a\right)$

Contains the level $n_l$ approximation coefficients;

$\mathbf{c}\left(n_a+\left(i-1\right)\times n_d+1:n_a+i\times n_d\right)$

Contains the level $\left(n_l-\mathit{i}+1\right)$ detail coefficients, for $\mathit{i}=1,2,\dots ,n_l$;

If $\mathbf{keepa}=\text{'A'}$,

$\mathbf{c}\left(\left(i-1\right)\times n_a+1:i\times n_a\right)$

Contains the level $\left(n_l-\mathit{i}+1\right)$ approximation coefficients, for $\mathit{i}=1,2,\dots ,n_l$;

$\mathbf{c}\left(n_l\times n_a+\left(i-1\right)\times n_d+1:n_l\times n_a+i\times n_d\right)$

Contains the level $\mathit{i}$ detail coefficients, for $\mathit{i}=1,2,\dots ,n_l$.

The values $n_a$ and $n_d$ denote the numbers of approximation and detail coefficients respectively, which are equal. This number is returned as output in na from a preceding call to c09dcf. See c09dcf for details.

5:     $\mathbf{n}$ – IntegerInput

On entry: $n$, the length of the data array, $y$, to be reconstructed.

Constraint: This must be the same as the value n passed to the initialization routine c09aaf.

6:     $\mathbf{y}\left(\mathbf{n}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the dataset reconstructed from the multi-level wavelet transform coefficients and the transformation options supplied to the initialization routine c09aaf.

7:     $\mathbf{icomm}\left(100\right)$ – Integer arrayCommunication Array

On entry: contains details of the discrete wavelet transform and the problem dimension for the forward transform previously computed by c09dcf.

8:     $\mathbf{ifail}$ – IntegerInput/Output

On entry: ifail must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation 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 argument, 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}=1$

On entry, $\mathbf{nwlinv}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{nwlinv}\ge 1$.

On entry, nwlinv is larger than the number of levels computed by the preceding call to c09dcf: $\mathbf{nwlinv}=〈\mathit{\text{value}}〉$, expected $〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=2$

On entry, $\mathbf{keepa}=〈\mathit{\text{value}}〉$ was an illegal value.

$\mathbf{ifail}=3$

On entry, lenc is set too small: $\mathbf{lenc}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{lenc}\ge 〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=5$

On entry, n is inconsistent with the value passed to the initialization routine: $\mathbf{n}=〈\mathit{\text{value}}〉$, n should be $〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=7$

On entry, the initialization routine c09aaf has not been called first or it has not been called with $\mathbf{wtrans}=\text{'U'}$, or the communication array icomm has become corrupted.

$\mathbf{ifail}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example