CommitDescriptor

Syntax

Fortran:

status = DftiCommitDescriptor( desc_handle )

C:

status = DftiCommitDescriptor(desc_handle);

Include Files

The Fortran interface is specified in the mkl_dfti.f90 include file and the C interface is specified in the mkl_dfti.h include file.

Input Parameters

Output Parameters

Description

The interface requires a function that completes initialization of a previously created descriptor before the descriptor can be used for FFT computations. Typically, this committal performs all initialization that facilitates the actual FFT computation. For a modern implementation, it may involve exploring many different factorizations of the input length to search for highly efficient computation method.

Any changes of configuration parameters of a committed descriptor via the set value function (see Descriptor Configuration) requires a re-committal of the descriptor before a computation function can be invoked. Typically, this committal function call is immediately followed by a computation function call (see FFT Computation).

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

Interface and Prototype

 
! Fortran interface
INTERFACE DftiCommitDescriptor
!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_1 ( Desc_Handle )
 INTEGER :: some_actual function_1
 TYPE(DFTI_DESCRIPTOR), POINTER :: Desc_Handle
 END FUNCTION some_actual function_1
END INTERFACE DftiCommitDescriptor 
 

 
/* C prototype */
MKL_LONG DftiCommitDescriptor( DFTI_DESCRIPTOR_HANDLE );