Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 10/31/2024
Public
Document Table of Contents

DftiGetValueDM

Gets the value of one particular configuration parameter.

Syntax

status = DftiGetValueDM(handle, param, &value);

Include Files

  • mkl_cdft.h

Input Parameters

handle
The descriptor handle. Must be valid, that is, created in a call to DftiCreateDescriptorDM.
param
Name of a parameter to be retrieved from the descriptor. See Table "Retrievable Configuration Parameters" for the list of available parameters.

Output Parameters

value
Value of the parameter.

Description

This function gets the configuration value of one particular configuration parameter. The configuration parameter is one of the named constants listed in the table below, and the configuration value is the corresponding appropriate type, which can be a named constant or a native type. Possible values of the named constants can be found in Table "Configuration Parameters" and relevant subsections of the Configuration Settings section.

Retrievable Configuration Parameters

Parameter Name

Data Type

Description

DFTI_PRECISION

Named constant

Precision of computation, input data and output data.

DFTI_DIMENSION

Integer scalar

Dimension of the transform

DFTI_LENGTHS

Array of integer values

Array of lengths of the transform. Number of lengths corresponds to the dimension of the transform.

DFTI_FORWARD_SCALE

Floating-point scalar

Scale factor of forward transform.

DFTI_BACKWARD_SCALE

Floating-point scalar

Scale factor of backward transform.

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 DftiGetValueDM(DFTI_DESCRIPTOR_DM_HANDLE handle, int param,...);