Allocates the descriptor data structure and initializes it with default configuration values.
mkl::dft::ErrCode descriptor.init (dimension ) ;
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 mkl::dft::Descriptor::commit does this work after the function mkl::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 mkl::dft::ErrCode::NO_ERROR when it completes successfully.
Name |
Type |
Description |
---|---|---|
dimension |
std::int64_t |
Dimension of the transform 1-D transform. |
Name |
Type |
Description |
---|---|---|
dimensions |
std::vector<std::int64_t> |
Dimensions of the transform. |
Name |
Type |
Description |
---|---|---|
status |
mkl::dft::ErrCode |
Function completion status. |
The function returns a value indicating whether the operation was successful or not, and why.
Return Value | Description |
---|---|
mkl::dft::ErrCode::NO_ERROR | The operation was successful. |
mkl::dft::ErrCode::INCONSISTENT_CONFIGURATION/ mkl::dft::ErrCode::INVALID_CONFIGURATION |
An input value provided is invalid. |
mkl::dft::ErrCode::UNIMPLEMENTED | Functionality requested is not implemented. |
mkl::dft::ErrCode::MEMORY_ERROR | Internal memory allocation failed. |