NAG Library Routine Document

C06PVF

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

▸▿ 10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1 Purpose

C06PVF computes the two-dimensional discrete Fourier transform of a bivariate sequence of real data values.

2 Specification

SUBROUTINE C06PVF (

M, N, X, Y, IFAIL)

INTEGER	M, N, IFAIL
REAL (KIND=nag_wp)	X(M*N)
COMPLEX (KIND=nag_wp)	Y((M/2+1)*N)

3 Description

C06PVF computes the two-dimensional discrete Fourier transform of a bivariate sequence of real data values

x_{j_{1} j_{2}}

, for

j_{1} = 0, 1, \dots, m - 1

and

j_{2} = 0, 1, \dots, n - 1

The discrete Fourier transform is here defined by

{\hat{z}}_{k_{1} k_{2}} = \frac{1}{\sqrt{m n}} \sum_{j_{1} = 0}^{m - 1} \sum_{j_{2} = 0}^{n - 1} x_{j_{1} j_{2}} \times \exp (- 2 π i (\frac{j_{1} k_{1}}{m} + \frac{j_{2} k_{2}}{n})),

where

k_{1} = 0, 1, \dots, m - 1

and

k_{2} = 0, 1, \dots, n - 1

. (Note the scale factor of

\frac{1}{\sqrt{m n}}

in this definition.)

The transformed values

{\hat{z}}_{k_{1} k_{2}}

are complex. Because of conjugate symmetry (i.e.,

{\hat{z}}_{k_{1} k_{2}}

is the complex conjugate of

{\hat{z}}_{(m - k_{1}) k_{2}}

), only slightly more than half of the Fourier coefficients need to be stored in the output.

A call of C06PVF followed by a call of C06PWF will restore the original data.

This routine calls C06PQF and C06PRF to perform multiple one-dimensional discrete Fourier transforms by the fast Fourier transform (FFT) algorithm in Brigham (1974) and Temperton (1983).

4 References

Brigham E O (1974) The Fast Fourier Transform Prentice–Hall

Temperton C (1983) Fast mixed-radix real Fourier transforms J. Comput. Phys. 52 340–350

5 Parameters

1: $M$ – INTEGERInput: On entry: $m$ , the first dimension of the transform.

Constraint: $M \geq 1$ .
2: $N$ – INTEGERInput: On entry: $n$ , the second dimension of the transform.

Constraint: $N \geq 1$ .
3: $X (M \times N)$ – REAL (KIND=nag_wp) arrayInput: On entry: the real input dataset $x$ , where $x_{j_{1} j_{2}}$ is stored in $X (j_{2} \times m + j_{1})$ , for $j_{1} = 0, 1, \dots, m - 1$ and $j_{2} = 0, 1, \dots, n - 1$ . That is, if X is regarded as a two-dimensional array of dimension $(0 : M - 1, 0 : N - 1)$ , then $X (j_{1}, j_{2})$ must contain $x_{j_{1} j_{2}}$ .
4: $Y ((M / 2 + 1) \times N)$ – COMPLEX (KIND=nag_wp) arrayOutput: On exit: the complex output dataset $\hat{z}$ , where ${\hat{z}}_{k_{1} k_{2}}$ is stored in $Y (k_{2} \times (m / 2 + 1) + k_{1})$ , for $k_{1} = 0, 1, \dots, m / 2$ and $k_{2} = 0, 1, \dots, n - 1$ . That is, if Y is regarded as a two-dimensional array of dimension $(0 : M / 2, 0 : N - 1)$ , then $Y (k_{1}, k_{2})$ contains ${\hat{z}}_{k_{1} k_{2}}$ . Note the first dimension is cut roughly by half to remove the redundant information due to conjugate symmetry.
5: $IFAIL$ – INTEGERInput/Output: On entry: IFAIL must be set to $0$ , $- 1 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 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 $- 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 = 1$: On entry, $M = 〈value〉$ .
Constraint: $M \geq 1$ .

$IFAIL = 2$: On entry, $N = 〈value〉$ .
Constraint: $N \geq 1$ .

$IFAIL = 3$: An internal error has occurred in this routine. Check the routine call and any array sizes. If the call is correct then please contact NAG for assistance.

$IFAIL = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.8 in the Essential Introduction for further information.

$IFAIL = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.

$IFAIL = - 999$: Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

7 Accuracy

Some indication of accuracy can be obtained by performing a forward transform using C06PVF and a backward transform using C06PWF, and comparing the results with the original sequence (in exact arithmetic they would be identical).

8 Parallelism and Performance

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

C06PVF makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.

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

The time taken by C06PVF is approximately proportional to

m n \log (m n)

, but also depends on the factors of

m

and

n

. C06PVF is fastest if the only prime factors of

m

and

n

are

2

3

and

5

, and is particularly slow if

m

n

is a large prime, or has large prime factors.

Workspace is internally allocated by C06PVF. The total size of these arrays is approximately proportional to

m n

10 Example

This example reads in a bivariate sequence of real data values and prints their discrete Fourier transforms as computed by C06PVF. Inverse transforms are then calculated by calling C06PWF showing that the original sequences are restored.

NAG Library Routine DocumentC06PVF