NAG Library Routine Document
C06PQF
1 Purpose
C06PQF computes the discrete Fourier transforms of m sequences, each containing n real data values or a Hermitian complex sequence stored column-wise in a complex storage format.
2 Specification
INTEGER |
N, M, IFAIL |
REAL (KIND=nag_wp) |
X((N+2)*M), WORK(*) |
CHARACTER(1) |
DIRECT |
|
3 Description
Given
m sequences of
n real data values
xjp
, for
j=0,1,…,n-1 and
p= 1,2,…,m, C06PQF simultaneously calculates the Fourier transforms of all the sequences defined by
The transformed values
z^
k
p
are complex, but for each value of p the
z^
k
p
form a Hermitian sequence (i.e.,
z^
n-k
p
is the complex conjugate of
z^
k
p
), so they are completely determined by
mn
real numbers (since
z^0p
is real, as is
z^
n/2
p
for n even).
Alternatively, given
m Hermitian sequences of
n complex data values
zjp
, this routine simultaneously calculates their inverse (
backward) discrete Fourier transforms defined by
The transformed values
x^kp
are real.
(Note the scale factor
1n
in the above definition.)
A call of C06PQF with DIRECT='F' followed by a call with DIRECT='B' will restore the original data.
The routine uses a variant of the fast Fourier transform (FFT) algorithm (see
Brigham (1974)) known as the Stockham self-sorting algorithm, which is described in
Temperton (1983). Special coding is provided for the factors
2,
3,
4 and
5.
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: DIRECT – CHARACTER(1)Input
On entry: if the forward transform as defined in
Section 3 is to be computed, then
DIRECT must be set equal to 'F'.
If the backward transform is to be computed then
DIRECT must be set equal to 'B'.
Constraint:
DIRECT='F' or 'B'.
- 2: N – INTEGERInput
On entry: n, the number of real or complex values in each sequence.
Constraint:
N≥1.
- 3: M – INTEGERInput
On entry: m, the number of sequences to be transformed.
Constraint:
M≥1.
- 4: X(
N+2×M
) – REAL (KIND=nag_wp) arrayInput/Output
On entry: the data must be stored in
X as if in a two-dimensional array of dimension
0:N+1,1:M; each of the
m sequences is stored in a
column of the array. In other words, if the data values of the
pth sequence to be transformed are denoted by
xjp, for
j=0,1,…,n-1, then:
- if DIRECT='F',
Xp-1×N+2+j must contain xjp, for j=0,1,…,n-1 and p=1,2,…,m;
-
if DIRECT='B', X p-1 × N+2 + 2×k and X p-1 × N+2 + 2×k+1 must contain the real and imaginary parts respectively of z^kp, for k=0,1,…,n/2 and p=1,2,…,m. (Note that for the sequence z^kp to be Hermitian, the imaginary part of z^0p, and of z^ n/2 p for n even, must be zero.)
On exit:
-
if DIRECT='F' and X is declared with bounds 0:N+1,1:M then X2×kp and X2×k+1p will contain the real and imaginary parts respectively of z^ k p , for k=0,1,…,n/2 and p=1,2,…,m;
-
if DIRECT='B' and X is declared with bounds 0:N+1,1:M then Xjp will contain xjp, for j=0,1,…,n-1 and p=1,2,…,m.
- 5: WORK(*) – REAL (KIND=nag_wp) arrayWorkspace
-
Note: the dimension of the array
WORK
must be at least
M+2
×
N
+
15.
The workspace requirements as documented for C06PQF may be an overestimate in some implementations.
On exit:
WORK1 contains the minimum workspace required for the current values of
M and
N with this implementation.
- 6: 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 or
-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
-
- IFAIL=2
-
- IFAIL=3
-
On entry, | DIRECT≠'F' or 'B'. |
- IFAIL=4
-
An unexpected error has occurred in an internal call. Check all subroutine calls and array dimensions. Seek expert help.
7 Accuracy
Some indication of accuracy can be obtained by performing a subsequent inverse transform and comparing the results with the original sequence (in exact arithmetic they would be identical).
8 Further Comments
The time taken by C06PQF is approximately proportional to nm
logn, but also depends on the factors of n. C06PQF is fastest if the only prime factors of n are 2, 3 and 5, and is particularly slow if n is a large prime, or has large prime factors.
9 Example
This example reads in sequences of real data values and prints their discrete Fourier transforms (as computed by C06PQF with DIRECT='F'), after expanding them from complex Hermitian form into a full complex sequences.
Inverse transforms are then calculated by calling C06PQF with DIRECT='B' showing that the original sequences are restored.
9.1 Program Text
Program Text (c06pqfe.f90)
9.2 Program Data
Program Data (c06pqfe.d)
9.3 Program Results
Program Results (c06pqfe.r)