free_trig_transform
free_trig_transform
Cleans the memory allocated for the data structure used by the FFT interface.
Syntax
void free_trig_transform
(
DFTI_DESCRIPTOR_HANDLE
*handle,
MKL_INT
ipar[],
MKL_INT
*stat
)
;
Include Files
- mkl.h
Input Parameters
- ipar
- MKL_INTarray of size 128. Contains integer data needed for Trigonometric Transform computations.
- handle
- DFTI_DESCRIPTOR_HANDLE*. The data structure used byFFT interface (for details, refer toFFT Functions).Intel® oneAPI Math Kernel Library
Output Parameters
- handle
- The data structure used byFFT interface. Memory allocated for the structure is released on output.Intel® oneAPI Math Kernel Library
- ipar
- Contains integer data needed for Trigonometric Transform computations. On output,ipar[6]is updated with thestatvalue.
- stat
- MKL_INT*. Contains the routine completion status, which is also written toipar[6].
Description
The FFT functions. To release the memory allocated for other parameters, include cleaning of the memory in your code.
free_trig_transform
routine cleans the memory used by the handle
structure, needed for Intel® oneAPI Math Kernel Library
Return Values
- stat= 0
- The routine completed the task normally.
- stat= -1000
- The routine stopped because of an FFT interface error.
- stat= -99999
- The routine failed to complete the task.