onemkl::dft::Descriptor<onemkl::dft::Precision, onemkl::dft::Domain>::commit¶
Performs all initialization for the actual FFT computation.
Syntax
-
onemkl::dft::ErrCode
Commit(cl::sycl::queue &in)¶
Include Files
mkl_dfti_sycl.hpp
Description
This function completes initialization of a previously created descriptor, which is required before the descriptor can be used for FFT computations. The cl::sycl::queue may be associated with a host, CPU, or GPU device. Typically, committing the descriptor performs all initialization that is required for the actual FFT computation on the given device. The initialization done by the function may involve exploring different factorizations of the input length to find the optimal computation method.
Note
All calls to the onemkl::dft::Descriptor<onemkl::dft::Precision, onemkl::dft::Domain>::setValue function to change configuration parameters of a descriptor need to happen after onemkl::dft::Descriptor<onemkl::dft::Precision, onemkl::dft::Domain>::init and before onemkl::dft::Descriptor<onemkl::dft::Precision, onemkl::dft::Domain>::commit. Typically, a committal function call is immediately followed by a computation function call (see FFT Compute Functions).
The function returns onemkl::dft::ErrCode::NO_ERROR when it completes successfully. See Status Checking Functions for more information on the returned status.
Input Parameters
Name |
Type |
Description |
|---|---|---|
deviceQueue |
cl::sycl::queue |
Sycl queue for a host, CPU, or GPU device. |
Output Parameters
Name |
Type |
Description |
|---|---|---|
status |
onemkl::dft::ErrCode |
Function completion status. |
Return Values
The function returns a value indicating whether the operation was successful or not, and why.
Return Value |
Description |
|---|---|
onemkl::dft::ErrCode::NO_ERROR |
The operation was successful. |
onemkl::dft::ErrCode::BAD_DESCRIPTOR |
DFTI handle provided is invalid. |
onemkl::dft::ErrCode::INCONSISTENT_CONFIGURATION/ onemkl::dft::ErrCode::INVALID_CONFIGURATION |
An input value provided is invalid. |
onemkl::dft::ErrCode::UNIMPLEMENTED |
Functionality requested is not implemented. |
onemkl::dft::ErrCode::MKL_INTERNAL_ERROR |
Internal MKL error. |
Parent topic: Fourier Transform Functions