NAG FL Interface
c09fbf (dim3_​sngl_​inv)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

1: $\mathbf{m}$ – Integer Input

On entry: the number of rows of each two-dimensional frame.

Constraint: this must be the same as the value m passed to the initialization routine c09acf.

2: $\mathbf{n}$ – Integer Input

On entry: the number of columns of each two-dimensional frame.

Constraint: this must be the same as the value n passed to the initialization routine c09acf.

3: $\mathbf{fr}$ – Integer Input

On entry: the number two-dimensional frames.

Constraint: this must be the same as the value fr passed to the initialization routine c09acf.

4: $\mathbf{lenc}$ – Integer Input

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

Constraint: $\mathbf{lenc}\ge n_{\mathrm{ct}}$, where $n_{\mathrm{ct}}$ is the total number of wavelet coefficients, as returned by c09acf.

5: $\mathbf{c}\left(\mathbf{lenc}\right)$ – Real (Kind=nag_wp) array Input

On entry: the coefficients of the discrete wavelet transform. This will normally be the result of some transformation on the coefficients computed by routine c09faf.

Note that the coefficients in c may be extracted according to type into three-dimensional arrays using c09fyf, and inserted using c09fzf.

6: $\mathbf{b}\left(\mathbf{ldb},\mathbf{sdb},\mathbf{fr}\right)$ – Real (Kind=nag_wp) array Output

On exit: the $m$ by $n$ by $\mathit{fr}$ reconstructed array, $B$, with $B_{ijk}$ stored in $\mathbf{b}\left(i,j,k\right)$. The reconstruction is based on the input wavelet coefficients and the transform options supplied to the initialization routine c09acf.

7: $\mathbf{ldb}$ – Integer Input

On entry: the first dimension of the array b as declared in the (sub)program from which c09fbf is called.

Constraint: $\mathbf{ldb}\ge \mathbf{m}$.

8: $\mathbf{sdb}$ – Integer Input

On entry: the second dimension of the array b as declared in the (sub)program from which c09fbf is called.

Constraint: $\mathbf{sdb}\ge \mathbf{n}$.

9: $\mathbf{icomm}\left(260\right)$ – Integer array Communication Array

On entry: contains details of the discrete wavelet transform and the problem dimension as setup in the call to the initialization routine c09acf.

10: $\mathbf{ifail}$ – Integer Input/Output

On entry: ifail must be set to $0$, $-1$ or $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$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ 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{fr}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{fr}=〈\mathit{\text{value}}〉$, the value of fr on initialization (see c09acf).

On entry, $\mathbf{m}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{m}=〈\mathit{\text{value}}〉$, the value of m on initialization (see c09acf).

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}=〈\mathit{\text{value}}〉$, the value of n on initialization (see c09acf).

$\mathbf{ifail}=2$

On entry, $\mathbf{ldb}=〈\mathit{\text{value}}〉$ and $\mathbf{m}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{ldb}\ge \mathbf{m}$.

On entry, $\mathbf{sdb}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{sdb}\ge \mathbf{n}$.

$\mathbf{ifail}=3$

On entry, $\mathbf{lenc}=〈\mathit{\text{value}}〉$ and $n_{\mathrm{ct}}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{lenc}\ge n_{\mathrm{ct}}$, where $n_{\mathrm{ct}}$ is the number of DWT coefficients returned by c09acf in argument nwct.

$\mathbf{ifail}=6$

Either the communication array icomm has been corrupted or there has not been a prior call to the initialization routine c09acf.

The initialization routine was called with $\mathbf{wtrans}=\text{'M'}$.

$\mathbf{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.

$\mathbf{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.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example