NAG Library Routine Document
C06PXF computes the three-dimensional discrete Fourier transform of a trivariate sequence of complex data values (using complex data type).
||N1, N2, N3, IFAIL
C06PXF computes the three-dimensional discrete Fourier transform of a trivariate sequence of complex data values
, for , and .
The discrete Fourier transform is here defined by
(Note the scale factor of in this definition.) The minus sign is taken in the argument of the exponential within the summation when the forward transform is required, and the plus sign is taken when the backward transform is required.
A call of C06PXF with followed by a call with will restore the original data.
This routine performs multiple one-dimensional discrete Fourier transforms by the fast Fourier transform (FFT) algorithm (see Brigham (1974)
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: DIRECT – CHARACTER(1)Input
: 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'.
- 2: N1 – INTEGERInput
On entry: , the first dimension of the transform.
- 3: N2 – INTEGERInput
On entry: , the second dimension of the transform.
- 4: N3 – INTEGERInput
On entry: , the third dimension of the transform.
- 5: X() – COMPLEX (KIND=nag_wp) arrayInput/Output
: the complex data values. Data values are stored in X
using column-major ordering for storing multidimensional arrays; that is,
is stored in
On exit: the corresponding elements of the computed transform.
- 6: WORK() – COMPLEX (KIND=nag_wp) arrayWorkspace
the dimension of the array WORK
must be at least
The workspace requirements as documented for C06PXF may be an overestimate in some implementations.
: the real part of
contains the minimum workspace required for the current values of N1
with this implementation.
- 7: 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 .|
|On entry,||N1 has more than prime factors.|
|On entry,||N2 has more than prime factors.|
|On entry,||N3 has more than prime factors.|
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 is approximately proportional to , but also depends on the factorization of the individual dimensions , and . C06PXF is faster if the only prime factors are , or ; and fastest of all if they are powers of .
This example reads in a trivariate sequence of complex data values and prints the three-dimensional Fourier transform. It then performs an inverse transform and prints the sequence so obtained, which may be compared to the original data values.
9.1 Program Text
Program Text (c06pxfe.f90)
9.2 Program Data
Program Data (c06pxfe.d)
9.3 Program Results
Program Results (c06pxfe.r)