Developer Reference

Contents

DftiFreeDescriptorDM

Frees memory allocated for a descriptor.

Syntax

status
=
DftiFreeDescriptorDM
(
&handle
)
;
Include Files
  • mkl_cdft.h
Input Parameters
handle
The descriptor handle. Must be valid, that is, created in a call to
DftiCreateDescriptorDM
.
Output Parameters
handle
The descriptor handle. Memory allocated for the handle is released on output.
Description
This function frees up all memory allocated for a descriptor in a particular MPI process. Call the
DftiFreeDescriptorDM
function to delete the descriptor handle. Upon successful completion of
DftiFreeDescriptorDM
the descriptor handle is no longer valid.
Return Values
The function returns
DFTI_NO_ERROR
when completes successfully. If the function fails, it returns a value of another error class constant (for the list of constants, refer to Error Codes ).
Prototype
    MKL_LONG DftiFreeDescriptorDM(DFTI_DESCRIPTOR_DM_HANDLE *handle);    

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804