onemkl::dft::Descriptor<onemkl::dft::Precision, onemkl::dft::Domain>::Init

Allocates the descriptor data structure and initializes it with default configuration values.

Syntax

onemkl::dft::ErrCode init(dimension)

Include Files

• mkl_dfti_sycl.hpp

Description

This function allocates memory for the descriptor data structure and instantiates it with all the default configuration settings for the precision, forward domain, and dimensions of the transform. This function does not perform any significant computational work, such as computation of twiddle factors. The function onemkl::dft::Descriptor::commit does this work after the function onemkl::dft::Descriptor::setValue has set values of all necessary parameters.

The interface supports a single std::int64_t input for 1-D transforms, and an std::vector for N-D transforms.

The function returns onemkl::dft::ErrCode::NO_ERROR when it completes successfully.

Input Parameters: 1-Dimensional

Name	Type	Description
dimension	std::int64_t	Dimension of the transform 1-D transform.

Input Parameters: N-Dimensional

Name	Type	Description
dimensions	std::vector<std::int64_t>	Dimensions of the transform.

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::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::MEMORY_ERROR	Internal memory allocation failed.

Parent topic: Fourier Transform Functions