Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

Cluster FFT Functions

This section describes the cluster Fast Fourier Transform (FFT) functions implemented in Intel® oneAPI Math Kernel Library (oneMKL).

NOTE:

These functions are available only for Intel® 64 architectures.

The cluster FFT function library was designed to perform fast Fourier transforms on a cluster, that is, a group of computers interconnected via a network. Each computer (node) in the cluster has its own memory and processor(s). Data interchanges between the nodes are provided by the network.

One or more processes may be running in parallel on each cluster node. To organize communication between different processes, the cluster FFT function library uses the Message Passing Interface (MPI). To avoid dependence on a specific MPI implementation (for example, MPICH, Intel® MPI, and others), the library works with MPI via a message-passing library for linear algebra called BLACS.

Cluster FFT functions of Intel® oneAPI Math Kernel Library (oneMKL) provide one-dimensional, two-dimensional, and multi-dimensional (up to the order of 7) functions and both Fortran and C interfaces for all transform functions.

To develop applications using the cluster FFT functions, you should have basic skills in MPI programming.

The interfaces for the Intel® oneAPI Math Kernel Library (oneMKL) cluster FFT functions are similar to the corresponding interfaces for the conventional Intel® oneAPI Math Kernel Library (oneMKL)FFT functions. Refer there for details not explained in this section.

Table "Cluster FFT Functions in Intel® oneAPI Math Kernel Library (oneMKL)" lists cluster FFT functions implemented in Intel® oneAPI Math Kernel Library (oneMKL):

Cluster FFT Functions in oneMKL

Function Name

Operation

Descriptor Manipulation Functions

DftiCreateDescriptorDM

Allocates memory for the descriptor data structure and preliminarily initializes it.

DftiCommitDescriptorDM

Performs all initialization for the actual FFT computation.

DftiFreeDescriptorDM

Frees memory allocated for a descriptor.

FFT Computation Functions

DftiComputeForwardDM

Computes the forward FFT.

DftiComputeBackwardDM

Computes the backward FFT.

Descriptor Configuration Functions

DftiSetValueDM

Sets one particular configuration parameter with the specified configuration value.

DftiGetValueDM

Gets the value of one particular configuration parameter.