Visible to Intel only — GUID: GUID-2CA4889C-D4AC-45DF-A39F-B54B05FDFD56
Visible to Intel only — GUID: GUID-2CA4889C-D4AC-45DF-A39F-B54B05FDFD56
DftiFreeDescriptor
Frees the memory allocated for a descriptor.
Syntax
status = DftiFreeDescriptor( desc_handle )
Include Files
- mkl_dfti.f90
Input Parameters
Name |
Type |
Description |
---|---|---|
desc_handle |
DESCRIPTOR_HANDLE |
FFT descriptor. |
Output Parameters
Name |
Type |
Description |
---|---|---|
desc_handle |
DESCRIPTOR_HANDLE |
Memory for the FFT descriptor is released. |
status |
INTEGER |
Function completion status. |
Description
This function frees all memory allocated for a descriptor.
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.
Interface
INTERFACE DftiFreeDescriptor //Note that the body provided here is to illustrate the different //argument list and types of dummy arguments. The interface //does not guarantee what the actual function names are. //Users can only rely on the function name following the //keyword INTERFACE FUNCTION some_actual_function_3( Desc_Handle ) INTEGER :: some_actual_function_3 TYPE(DFTI_DESCRIPTOR), POINTER :: Desc_Handle END FUNCTION some_actual_function_3 END INTERFACE DftiFreeDescriptor