Intel® Math Kernel Library 2019 Developer Reference - C
Releases the memory allocated for the data structures used by the FFT interface.
void free_Helmholtz_2D(DFTI_DESCRIPTOR_HANDLE* xhandle, MKL_INT* ipar, MKL_INT* stat);
void free_Helmholtz_3D(DFTI_DESCRIPTOR_HANDLE* xhandle, DFTI_DESCRIPTOR_HANDLE* yhandle, MKL_INT* ipar, MKL_INT* stat);
xhandle, yhandle |
DFTI_DESCRIPTOR_HANDLE*. Data structures used by the Intel MKL FFT interface (for details, refer to FFT Functions). The structure yhandle is used only by free_Helmholtz_3D. |
ipar |
MKL_INT array of size 128. Contains integer data used by Fast Helmholtz Solver (for details, refer to ipar). |
xhandle, yhandle |
Data structures used by the Intel MKL FFT interface. Memory allocated for the structures is released on output. |
ipar |
Contains integer data used by Fast Helmholtz Solver. On output, the status of the routine call is written to ipar[0]. |
stat |
MKL_INT*. Routine completion status, which is also written to ipar[0]. |
The free_Helmholtz_2D-free_Helmholtz_3D routine releases the memory used by the xhandle and yhandle structures, which are needed for calling the Intel MKL FFT functions. To release memory allocated for other parameters, include memory release statements in your code.
stat= 0 |
The routine successfully completed the task. |
stat= -1000 |
The routine stopped because of an Intel MKL FFT or TT interface error. |
stat= -99999 |
The routine failed to complete the task because of a fatal error. |