Developer Reference

  • 2020.2
  • 07/15/2020
  • Public Content
Contents

DftiSetValue

Sets one particular configuration parameter with the specified configuration value.

Syntax

status
=
DftiSetValue
(
desc_handle
,
config_param
,
config_val
)
Include Files
  • mkl_dfti.f90
Input Parameters
Name
Type
Description
desc_handle
DFTI_DESCRIPTOR
FFT descriptor.
config_param
INTEGER
Configuration parameter.
config_val
Depends on the configuration parameter.
Configuration value.
Output Parameters
Name
Type
Description
desc_handle
DFTI_DESCRIPTOR
Updated FFT descriptor.
status
INTEGER
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:
You cannot use the
DftiSetValue
function to change configuration parameters
DFTI_FORWARD_DOMAIN
,
DFTI_PRECISION
,
DFTI_DIMENSION
, and
DFTI_LENGTHS
. Use the
DftiCreateDescriptor
function to set them.
Function calls needed to configure an FFT descriptor for a particular call to an FFT computation function are summarized in Configuring and Computing an FFT in Fortran .
The function returns zero when it completes successfully.
See Status Checking Functions for more information on the returned status.
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