Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/22/2024
Public

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

Document Table of Contents

DftiSetValue

Sets one particular configuration parameter with the specified configuration value.

Syntax

status = DftiSetValue(desc_handle, config_param, config_val);

Include Files

  • mkl.h

Input Parameters

Name

Type

Description

desc_handle

DFTI_DESCRIPTOR_HANDLE

FFT descriptor.

config_param

enum

Configuration parameter.

config_val

Depends on the configuration parameter.

Configuration value.

Output Parameters

Name

Type

Description

desc_handle

DFTI_DESCRIPTOR_HANDLE

Updated FFT descriptor.

status

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:

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 C C++.

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

Prototype

 
				MKL_LONG DftiSetValue( DFTI_DESCRIPTOR_HANDLE, DFTI_CONFIG_PARAM , ... );
 

See Also