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, int ipar[], int *stat);

Include Files

The Fortran interfaces are specified in the mkl_trig_transforms.f90 include file and the C interfaces are specified in the mkl_trig_transforms.h include file.

Input Parameters

ipar	int array of size 128. Contains integer data needed for Trigonometric Transform computations.
handle	DFTI_DESCRIPTOR_HANDLE*. The data structure used by Intel MKL FFT interface (for details, refer to FFT Functions).

Output Parameters

handle	The data structure used by Intel MKL 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	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 MKL 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.