Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 7/13/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of 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_trig_transforms.f90

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 (oneMKL) FFT interface (for details, refer toFFT Functions).

Output Parameters

handle

The data structure used by Intel® oneAPI Math Kernel Library (oneMKL) 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 handlestructure, needed for Intel® oneAPI Math Kernel Library (oneMKL) 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.