The function may be called by the names: c06pyc or nag_sum_fft_real_3d.
c06pyc computes the three-dimensional discrete Fourier transform of a trivariate sequence of real data values , for , and .
The discrete Fourier transform is here defined by
where , and . (Note the scale factor of in this definition.)
The transformed values are complex. Because of conjugate symmetry (i.e., is the complex conjugate of ), only slightly more than half of the Fourier coefficients need to be stored in the output.
A call of c06pyc followed by a call of c06pzc will restore the original data.
This function performs multiple one-dimensional discrete Fourier transforms by the fast Fourier transform (FFT) algorithm in Brigham (1974) and Temperton (1983).
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
1: – IntegerInput
On entry: , the first dimension of the transform.
2: – IntegerInput
On entry: , the second dimension of the transform.
3: – IntegerInput
On entry: , the third dimension of the transform.
4: – const doubleInput
On entry: the real input dataset , where
is stored in , for , and .
5: – ComplexOutput
Note: the dimension, dim, of the array y
must be at least
On exit: the complex output dataset , where
is stored in , for , and . Note the first dimension is cut roughly by half to remove the redundant information due to conjugate symmetry.
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 forward transform using c06pyc and a backward transform using c06pzc, 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.
c06pyc is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
c06pyc 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 by c06pyc is approximately proportional to , but also depends on the factors of , and . c06pyc is fastest if the only prime factors of , and are , and , and is particularly slow if one of the dimensions is a large prime, or has large prime factors.
Workspace is internally allocated by c06pyc. The total size of these arrays is approximately proportional to .
This example reads in a trivariate sequence of real data values and prints their discrete Fourier transforms as computed by c06pyc. Inverse transforms are then calculated by calling c06pzc showing that the original sequences are restored.