Sets one particular configuration parameter with the specified configuration value.
Syntax
Fortran:
status = DftiSetValue( desc_handle, config_param, config_val )
C:
status = DftiSetValue(desc_handle, config_param, config_val);
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
Name |
Type |
Description |
|---|---|---|
desc_handle |
FORTRAN: DFTI_DESCRIPTOR C: DFTI_DESCRIPTOR_HANDLE |
FFT descriptor. |
config_param |
FORTRAN: INTEGER C: enum |
Configuration parameter. |
config_val |
Depends on the configuration parameter. |
Configuration value. |
Output Parameters
Name |
Type |
Description |
|---|---|---|
desc_handle |
FORTRAN: DFTI_DESCRIPTOR C: DFTI_DESCRIPTOR_HANDLE |
Updated FFT descriptor. |
status |
FORTRAN: INTEGER C: MKL_LONG |
Function completion status. |
Description
This function sets one particular configuration parameter with the specified configuration value. Each configuration parameter is a named constant, and the configuration value must have the corresponding type, which can be a named constant or a native type. For available configuration parameters and the corresponding configuration values, see:
- DFTI_PRECISION
- DFTI_FORWARD_DOMAIN
- DFTI_DIMENSION, DFTI_LENGTH
- DFTI_PLACEMENT
- DFTI_FORWARD_SCALE, DFTI_BACKWARD_SCALE
- DFTI_NUMBER_OF_USER_THREADS
- DFTI_INPUT_STRIDES, DFTI_OUTPUT_STRIDES
- DFTI_NUMBER_OF_TRANSFORMS
- DFTI_INPUT_DISTANCE, DFTI_OUTPUT_DISTANCE
- DFTI_COMPLEX_STORAGE, DFTI_REAL_STORAGE, DFTI_CONJUGATE_EVEN_STORAGE
- DFTI_PACKED_FORMAT
- DFTI_WORKSPACE
- DFTI_ORDERING
Important
The DftiSetValue function does not change configuration parameters DFTI_FORWARD_DOMAIN, DFTI_PRECISION, DFTI_DIMENSION, and DFTI_LENGTHS. Use the DftiCreateDescriptor function to set them.
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 DftiSetValue //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_6_INTVAL( Desc_Handle, Config_Param, INTVAL ) INTEGER :: some_actual_function_6_INTVAL Type(DFTI_DESCRIPTOR), POINTER :: Desc_Handle INTEGER, INTENT(IN) :: Config_Param INTEGER, INTENT(IN) :: INTVAL END FUNCTION some_actual_function_6_INTVAL FUNCTION some_actual_function_6_SGLVAL( Desc_Handle, Config_Param, SGLVAL ) INTEGER :: some_actual_function_6_SGLVAL Type(DFTI_DESCRIPTOR), POINTER :: Desc_Handle INTEGER, INTENT(IN) :: Config_Param REAL, INTENT(IN) :: SGLVAL END FUNCTION some_actual_function_6_SGLVAL FUNCTION some_actual_function_6_DBLVAL( Desc_Handle, Config_Param, DBLVAL ) INTEGER :: some_actual_function_6_DBLVAL Type(DFTI_DESCRIPTOR), POINTER :: Desc_Handle INTEGER, INTENT(IN) :: Config_Param REAL (KIND(0D0)), INTENT(IN) :: DBLVAL END FUNCTION some_actual_function_6_DBLVAL FUNCTION some_actual_function_6_INTVEC( Desc_Handle, Config_Param, INTVEC ) INTEGER :: some_actual_function_6_INTVEC Type(DFTI_DESCRIPTOR), POINTER :: Desc_Handle INTEGER, INTENT(IN) :: Config_Param INTEGER, INTENT(IN) :: INTVEC(*) END FUNCTION some_actual_function_6_INTVEC FUNCTION some_actual_function_6_CHARS( Desc_Handle, Config_Param, CHARS ) INTEGER :: some_actual_function_6_CHARS Type(DFTI_DESCRIPTOR), POINTER :: Desc_Handle INTEGER, INTENT(IN) :: Config_Param CHARCTER(*), INTENT(IN) :: CHARS END FUNCTION some_actual_function_6_CHARS END INTERFACE DftiSetValue