Developer Reference

Contents

descriptor<precision, domain>::commit

Performs all initialization for the actual FFT computation. This routine belongs to the
oneapi::mkl::dft
namespace.

Description

This function completes initialization of a previously created descriptor, which is required before the descriptor can be used for FFT computations. It throws an
std::runtime_exception()
in the case that it fails. 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.
Calls to the
descriptor<precision, domain>::set_value
function to change configuration parameters of a descriptor need to happen before
descriptor<precision, domain>::commit
. Typically, a committal function call is immediately followed by a computation function call (see FFT Compute Functions).

API

Syntax
namespace oneapi::mkl::dft{ void descriptor<prec, dom>::commit(cl::sycl::queue &in) }
Include Files
  • oneapi/mkl/dfti.hpp
Input Parameters
Name
Type
Description
deviceQueue
cl::sycl::queue
Sycl queue for a host, CPU, or GPU device.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.