NAG Library Routine Document

c09cdf  (dim1_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 c09ccf. The data will be reconstructed to level $\left(\mathbf{nwl}-\mathbf{nwlinv}\right)$, where level $0$ is the original input dataset provided to c09ccf.

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

2:     $\mathbf{lenc}$ – IntegerInput

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

Constraint: $\mathbf{lenc}\ge n_c$, where $n_c$ is the total number of coefficients that correspond to a transform with nwlinv levels and is unchanged from the preceding call to c09ccf.

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

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

Let $q\left(\mathit{i}\right)$ be the number of coefficients (of each type) at level $\mathit{i}$, for $\mathit{i}=n_{\mathrm{fwd}},n_{\mathrm{fwd}}-1,\dots ,1$. Then, setting $k_1=q\left(n_{\mathrm{fwd}}\right)$ and $k_{\mathit{j}+1}=k_{\mathit{j}}+q\left(n_{\mathrm{fwd}}-\mathit{j}+1\right)$, for $\mathit{j}=1,2,\dots ,n_{\mathrm{fwd}}$, the coefficients are stored in c as follows:

$\mathbf{c}\left(\mathit{i}\right)$, for $\mathit{i}=1,2,\dots ,k_1$

Contains the level $n_{\mathrm{fwd}}$ approximation coefficients, $a_{n_{\mathrm{fwd}}}$.

$\mathbf{c}\left(\mathit{i}\right)$, for $\mathit{i}=k_1+1,\dots ,k_2$

Contains the level $n_{\mathrm{fwd}}$ detail coefficients $d_{n_{\mathrm{fwd}}}$.

$\mathbf{c}\left(\mathit{i}\right)$, for $\mathit{i}=k_j+1,\dots ,k_{j+1}$

Contains the level $n_{\mathrm{fwd}}-\mathit{j}+1$ detail coefficients, for $\mathit{j}=2,3,\dots ,n_{\mathrm{fwd}}$.

The values $q\left(\mathit{i}\right)$, for $\mathit{i}=n_{\mathrm{fwd}},n_{\mathrm{fwd}}-1,\dots ,1$, are contained in dwtlev which is produced as output by a preceding call to c09ccf. See c09ccf for details.

4:     $\mathbf{n}$ – IntegerInput

On entry: $n$, the length of the data array, $y$, to be reconstructed. For a full reconstruction of nwl levels, where nwl is as supplied to c09ccf, this must be the same as argument n used in the call to c09ccf. For a partial reconstruction of $\mathbf{nwlinv}<\mathbf{nwl}$, this must be equal to $\mathbf{dwtlev}\left(\mathbf{nwlinv}+2\right)$, as returned from c09ccf.

5:     $\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.

6:     $\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 c09ccf.

7:     $\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 c09ccf: $\mathbf{nwlinv}=〈\mathit{\text{value}}〉$, expected $=〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=2$

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

$\mathbf{ifail}=4$

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}=6$

Either the initialization routine has not been called first or array icomm has been corrupted.

Either the initialization routine was called with $\mathbf{wtrans}=\text{'S'}$ or array icomm has been 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