Developer Reference

Contents

DftiSetValueDM

Sets one particular configuration parameter with the specified configuration value.

Syntax

status
=
DftiSetValueDM
(
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 set up in the descriptor handle.
See Table
"Settable Configuration Parameters"
for the list of available parameters.
value
Value of the parameter.
Description
This function sets one particular configuration parameter with the specified configuration value. The configuration parameter is one of the named constants listed in the table below, and the configuration value must have the corresponding type.
See Configuration Settings for details of the meaning of each setting and for possible values of the parameters whose values are named constants.
Settable Configuration Parameters
Parameter Name
Data Type
Description
Default Value
DFTI_FORWARD_SCALE
Floating-point scalar
Scale factor of forward transform.
1.0
DFTI_BACKWARD_SCALE
Floating-point scalar
Scale factor of backward transform.
1.0
DFTI_PLACEMENT
Named constant
Placement of the computation result.
DFTI_INPLACE
DFTI_ORDERING
Named constant
Scrambling of data order.
DFTI_ORDERED
CDFT_WORKSPACE
Array of an appropriate type
Auxiliary buffer, a user-defined workspace. Enables saving memory during in-place computations.
NULL
(allocate workspace dynamically).
DFTI_PACKED_FORMAT
Named constant
Packed format, real data.
  • DFTI_PERM_FORMAT
    ― default and the only available value for one-dimensional transforms
  • DFTI_CCE_FORMAT
    ― default and the only available value for multi-dimensional transforms
DFTI_TRANSPOSE
Named constant
This parameter determines how the output data is located for multi-dimensional transforms. If the parameter value is
DFTI_NONE
, the data is located in a usual manner described in this document. If the value is
DFTI_ALLOW
, the last (first) global transposition is not performed for a forward (backward) transform.
DFTI_NONE
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 DftiSetValueDM(DFTI_DESCRIPTOR_DM_HANDLE handle, int param,...);    

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.