NAG Library Routine Document
C06FRF computes the discrete Fourier transforms of sequences, each containing complex data values. This routine is designed to be particularly efficient on vector processors.
||M, N, IFAIL
||X(M*N), Y(M*N), TRIG(2*N), WORK(2*M*N)
complex data values
, C06FRF simultaneously calculates the Fourier transforms of all the sequences defined by
(Note the scale factor
in this definition.)
The discrete Fourier transform is sometimes defined using a positive sign in the exponential term
To compute this form, this routine should be preceded and followed by a call of C06GCF
to form the complex conjugates of the
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 code is provided for the factors
. This routine is designed to be particularly efficient on vector processors, and it becomes especially fast as
, the number of transforms to be computed in parallel, increases.
Brigham E O (1974) The Fast Fourier Transform Prentice–Hall
Temperton C (1983) Self-sorting mixed-radix fast Fourier transforms J. Comput. Phys. 52 1–23
- 1: M – INTEGERInput
On entry: , the number of sequences to be transformed.
- 2: N – INTEGERInput
On entry: , the number of complex values in each sequence.
- 3: X() – REAL (KIND=nag_wp) arrayInput/Output
- 4: Y() – REAL (KIND=nag_wp) arrayInput/Output
: the real and imaginary parts of the complex data must be stored in X
respectively as if in a two-dimensional array of dimension
; each of the
sequences is stored in a row
of each array. In other words, if the real parts of the
th sequence to be transformed are denoted by
, then the
elements of the array X
must contain the values
are overwritten by the real and imaginary parts of the complex transforms.
- 5: INIT – CHARACTER(1)Input
: indicates whether trigonometric coefficients are to be calculated.
- Calculate the required trigonometric coefficients for the given value of , and store in the array TRIG.
- The required trigonometric coefficients are assumed to have been calculated and stored in the array TRIG in a prior call to one of C06FPF, C06FQF or C06FRF. The routine performs a simple check that the current value of is consistent with the values stored in TRIG.
, or .
- 6: TRIG() – REAL (KIND=nag_wp) arrayInput/Output
must contain the required trigonometric coefficients that have been previously calculated. Otherwise TRIG
need not be set.
On exit: contains the required coefficients (computed by the routine if ).
- 7: WORK() – REAL (KIND=nag_wp) arrayWorkspace
- 8: IFAIL – INTEGERInput/Output
must be set to
. 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
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is
. When the value is used it is essential to test the value of IFAIL on exit.
unless the routine detects an error or a warning has been flagged (see Section 6
6 Error Indicators and Warnings
If on entry
, explanatory error messages are output on the current error message unit (as defined by X04AAF
Errors or warnings detected by the routine:
|On entry,||, or .|
Not used at this Mark.
|On entry,|| or , but the array TRIG and the current value of N are inconsistent.|
An unexpected error has occurred in an internal call. Check all subroutine calls and array dimensions. Seek expert help.
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).
The time taken by C06FRF is approximately proportional to , but also depends on the factors of . C06FRF is fastest if the only prime factors of are , and , and is particularly slow if is a large prime, or has large prime factors.
This example reads in sequences of complex data values and prints their discrete Fourier transforms (as computed by C06FRF). Inverse transforms are then calculated using C06FRF and C06GCF
and printed out, showing that the original sequences are restored.
9.1 Program Text
Program Text (c06frfe.f90)
9.2 Program Data
Program Data (c06frfe.d)
9.3 Program Results
Program Results (c06frfe.r)