Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/22/2024
Public

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

Document Table of Contents

DftiFreeDescriptor

Frees the memory allocated for a descriptor.

Syntax

status = DftiFreeDescriptor(&desc_handle);

Include Files

  • mkl.h

Input Parameters

Name

Type

Description

desc_handle

DFTI_DESCRIPTOR_HANDLE

FFT descriptor.

Output Parameters

Name

Type

Description

desc_handle

DFTI_DESCRIPTOR_HANDLE

Memory for the FFT descriptor is released.

status

MKL_LONG

Function completion status.

Description

This function frees all memory allocated for a descriptor.

NOTE:

Memory allocation/deallocation inside Intel® oneAPI Math Kernel Library (oneMKL) is managed by Intel® oneAPI Math Kernel Library (oneMKL) memory management software. So, even after successful completion of FreeDescriptor, the memory space may continue being allocated for the application because the memory management software sometimes does not return the memory space to the OS, but considers the space free and can reuse it for future memory allocation. See Example mkl_free_buffers: Usage with FFT Functions on how to use Intel® oneAPI Math Kernel Library (oneMKL) memory management software and release memory to the OS.

The function returns zero when it completes successfully. See Status Checking Functions for more information on the returned status.

Prototype

 
MKL_LONG DftiFreeDescriptor( DFTI_DESCRIPTOR_HANDLE * );