The function may be called by the names: c06pxc, nag_sum_fft_complex_3d or nag_fft_3d.
c06pxc 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
where , and .
(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 c06pxc with followed by a call with will restore the original data.
This function 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: – Nag_TransformDirectionInput
On entry: if the forward transform as defined in Section 3 is to be computed, direct must be set equal to .
If the backward transform is to be computed, direct must be set equal to .
2: – IntegerInput
On entry: , the first dimension of the transform.
3: – IntegerInput
On entry: , the second dimension of the transform.
4: – IntegerInput
On entry: , the third dimension of the transform.
5: – ComplexInput/Output
On entry: 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: – NagError *Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).
6Error Indicators and Warnings
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
On entry, argument had an illegal value.
On entry, .
On entry, .
On entry, .
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.
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).
8Parallelism and Performance
Background information to multithreading can be found in the Multithreading documentation.
c06pxc is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
c06pxc 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 function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.
The time taken is approximately proportional to , but also depends on the factorization of the individual dimensions , and . c06pxc 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.