Intel® oneAPI Math Kernel Library (oneMKL) - Data Parallel C++ Developer Reference
A newer version of this document is available. Customers should click here to go to the newest version.
Visible to Intel only — GUID: GUID-888D7B91-1DAD-499E-9694-EDC0180932F9
Visible to Intel only — GUID: GUID-888D7B91-1DAD-499E-9694-EDC0180932F9
Fourier Transform Functions
The general form of the discrete Fourier transform is:
for 
, where σ is a scale factor, 
for the forward transform, and 
for the inverse (backward) transform. In the forward transform, the input (periodic) sequence 
belongs to the set of complex-valued sequences or the set of real-valued sequences, and the output sequence belongs to the set of complex-valued sequences or the set of complex-valued conjugate-even sequences, respectively.
The Intel® oneAPI Math Kernel Library (oneMKL) provides a DPC++ interface for computing a discrete Fourier transform through the fast Fourier transform algorithm. The DPC++ interface emulates the usage model of the oneMKL C and Fortran Discrete Fourier Transform Interface (DFTI).
The DPC++ interface computes an FFT in four steps:
Allocate a fresh descriptor for the problem with a call to the descriptor object constructor,
descriptor<PRECISION, DOMAIN> desc(dimensions);
The descriptor captures the configuration of the transform, such as the dimensionality (or rank), sizes, number of transforms, memory layout of the input/output data (defined by strides), and scaling factors. Many of the configuration settings are assigned default values in this call which you might need to modify in your application.
Optionally adjust the descriptor configuration with a call to the descriptor<PRECISION, DOMAIN>::set_value function as needed. Typically, you must carefully define the data storage layout for an FFT. The configuration settings of the descriptor, such as the default values, can be obtained with the descriptor<PRECISION, DOMAIN>::get_value function.
Commit the descriptor with a call to the descriptor<PRECISION, DOMAIN>::commit function, that is, make the descriptor ready for the transform computation. Once the descriptor is committed, the parameters of the transform, such as the type and number of transforms, strides and distances, the type and storage layout of the data, and so on, are “frozen” in the descriptor. The commit function takes in a sycl::queue object to determine the device associated with the descriptor.
Compute the transform with a call to the compute_forward or compute_backward functions as many times as needed. Because the descriptor is defined and committed separately, the compute functions just take the input and output data and compute the transform as defined. To modify any configuration parameters for another call to a compute function, use
descriptor<PRECISION, DOMAIN>::set_value
followed by
descriptor<PRECISION, DOMAIN>::commit
before calling the compute function again.
All the above functions throw a named std::runtime_exception in the event of failure.
To use the DPC++ interface, include oneapi/mkl/dfti.hpp. The DPC++ interface supports CPU and Intel GPU devices. Some device-specific limitations are noted in the descriptor<precision, domain>::set_value section of this document. Refer to the Intel® oneAPI Math Kernel Library Release Notes for known limitations. Working usage examples can be found in the oneMKL installation directory under examples/dpcpp/dft.
The FFT functions assume the Cartesian representation of complex data (that is, the real and imaginary parts define a complex number). The Intel® oneAPI Math Kernel Library Vector Mathematical Functions provide efficient tools for conversion to and from polar representation. See the Conversion from Cartesian to polar representation of complex data and Conversion from polar to Cartesian representation of complex data examples.