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.
DFTI_PLACEMENT
Named constant
Placement of the computation result.
DFTI_COMMIT_STATUS
Named constant
Shows whether descriptor has been committed.
DFTI_FORWARD_DOMAIN
Named constant
Forward domain of transforms, has the value of
DFTI_COMPLEX
or
DFTI_REAL
.
DFTI_ORDERING
Named constant
Scrambling of data order.
CDFT_MPI_COMM
Type of MPI communicator
MPI communicator used for transforms.
CDFT_LOCAL_SIZE
Integer scalar
Necessary size of input, output, and buffer arrays in data elements.
CDFT_LOCAL_X_START
Integer scalar
Row/element number of the global array that corresponds to the first row/element of the local array. For more information, see Distributing Data among Processes.
CDFT_LOCAL_NX
Integer scalar
The number of rows/elements of the global array stored in the local array. For more information, see Distributing Data among Processes.
CDFT_LOCAL_OUT_X_START
Integer scalar
Element number of the appropriate global array that corresponds to the first element of the input or output local array in a 1D case. For details, see Distributing Data among Processes.
CDFT_LOCAL_OUT_NX
Integer scalar
The number of elements of the appropriate global array that are stored in the input or output local array in a 1D case. For details, see Distributing Data among Processes.
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,...);    

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804