Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 6/24/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

DftiGetValue

Gets the configuration value of one particular configuration parameter.

Syntax

status = DftiGetValue( 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. See Table "Configuration Parameters" for allowable values of config_param.

Output Parameters

Name

Type

Description

config_val

Depends on the configuration parameter.

Configuration value.

status

INTEGER

Function completion status.

Description

This function gets the configuration value of one particular configuration parameter. 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:

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

Interface

 
				INTERFACE DftiGetValue
//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_7_INTVAL( Desc_Handle, Config_Param, INTVAL )
 INTEGER :: some_actual_function_7_INTVAL
 Type(DFTI_DESCRIPTOR), POINTER :: Desc_Handle
 INTEGER, INTENT(IN) :: Config_Param
 INTEGER, INTENT(OUT) :: INTVAL
 END FUNCTION DFTI_GET_VALUE_INTVAL 
 FUNCTION some_actual_function_7_SGLVAL( Desc_Handle, Config_Param, SGLVAL )
 INTEGER :: some_actual_function_7_SGLVAL
 Type(DFTI_DESCRIPTOR), POINTER :: Desc_Handle
 INTEGER, INTENT(IN) :: Config_Param
 REAL, INTENT(OUT) :: SGLVAL
 END FUNCTION some_actual_function_7_SGLVAL 
 FUNCTION some_actual_function_7_DBLVAL( Desc_Handle, Config_Param, DBLVAL )
 INTEGER :: some_actual_function_7_DBLVAL
 Type(DFTI_DESCRIPTOR), POINTER :: Desc_Handle
 INTEGER, INTENT(IN) :: Config_Param
 REAL (KIND(0D0)), INTENT(OUT) :: DBLVAL
 END FUNCTION some_actual_function_7_DBLVAL 
 FUNCTION some_actual_function_7_INTVEC( Desc_Handle, Config_Param, INTVEC )
 INTEGER :: some_actual_function_7_INTVEC
 Type(DFTI_DESCRIPTOR), POINTER :: Desc_Handle
 INTEGER, INTENT(IN) :: Config_Param
 INTEGER, INTENT(OUT) :: INTVEC(*)
 END FUNCTION some_actual_function_7_INTVEC 
 FUNCTION some_actual_function_7_INTPNT( Desc_Handle, Config_Param, INTPNT )
 INTEGER :: some_actual_function_7_INTPNT
 Type(DFTI_DESCRIPTOR), POINTER :: Desc_Handle
 INTEGER, INTENT(IN) :: Config_Param
 INTEGER, DIMENSION(*), POINTER :: INTPNT
 END FUNCTION some_actual_function_7_INTPNT 
 FUNCTION some_actual_function_7_CHARS( Desc_Handle, Config_Param, CHARS )
 INTEGER :: some_actual_function_7_CHARS
 Type(DFTI_DESCRIPTOR), POINTER :: Desc_Handle
 INTEGER, INTENT(IN) :: Config_Param
 CHARCTER(*), INTENT(OUT):: CHARS
 END FUNCTION some_actual_function_7_CHARS
END INTERFACE DftiGetValue 
 
Related information
Configuration Settings for more information on configuration parameters.