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

DftiCommitDescriptor

Performs all initialization for the actual FFT computation.

Syntax

status = DftiCommitDescriptor(desc_handle);

Include Files

  • mkl.h

Input Parameters

Name

Type

Description

desc_handle

DFTI_DESCRIPTOR_HANDLE

FFT descriptor.

Output Parameters

Name

Type

Description

desc_handle

DFTI_DESCRIPTOR_HANDLE

Updated FFT descriptor.

status

MKL_LONG

Function completion status.

Description

This function completes initialization of a previously created descriptor, which is required before the descriptor can be used for FFT computations. Typically, committing the descriptor performs all initialization that is required for the actual FFT computation. The initialization done by the function may involve exploring different factorizations of the input length to find the optimal computation method.

If you call the DftiSetValue function to change configuration parameters of a committed descriptor (see Descriptor Configuration Functions), you must re-commit the descriptor before invoking a computation function. Typically, a committal function call is immediately followed by a computation function call (see FFT Computation Functions).

The function returns zero when it completes successfully. See Status Checking Functions for more information on the returned status.

Prototype

 
MKL_LONG DftiCommitDescriptor( DFTI_DESCRIPTOR_HANDLE );