Developer Reference

  • 2021.1
  • 12/04/2020
  • Public Content
Contents

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_INT
array of size 128. Contains integer data needed for Trigonometric Transform computations.
handle
DFTI_DESCRIPTOR_HANDLE*
. The data structure used by
Intel® oneAPI Math Kernel Library
FFT interface (for details, refer toFFT Functions).
Output Parameters
handle
The data structure used by
Intel® oneAPI Math Kernel Library
FFT interface. Memory allocated for the structure is released on output.
ipar
Contains integer data needed for Trigonometric Transform computations. On output,
ipar[6]
is updated with the
stat
value.
stat
MKL_INT*
. Contains the routine completion status, which is also written to
ipar[6]
.
Description
The
free_trig_transform
routine cleans the memory used by the
handle
structure, needed for
Intel® oneAPI Math Kernel Library
FFT functions. To release the memory allocated for other parameters, include cleaning of the memory in your code.
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.

Product and Performance Information

1

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