Developer Reference

Contents

DftiErrorClass

Checks whether the status reflects an error of a predefined class.

Syntax

predicate
=
DftiErrorClass
(
status
,
error_class
)
;
Include Files
  • mkl.h
Input Parameters
Name
Type
Description
status
MKL_LONG
Completion status of an FFT function.
error_class
MKL_LONG
Predefined error class.
Output Parameters
Name
Type
Description
predicate
MKL_LONG
Result of checking.
Description
The FFT interface in
Intel® MKL
provides a set of predefined error classes. They are named constants and have the type
MKL_LONG
.
Predefined Error Classes
Named Constants
Comments
DFTI_NO_ERROR
No error. The zero status belongs to this class.
DFTI_MEMORY_ERROR
Usually associated with memory allocation
DFTI_INVALID_CONFIGURATION
Invalid settings of one or more configuration parameters
DFTI_INCONSISTENT_CONFIGURATION
Inconsistent configuration or input parameters
DFTI_NUMBER_OF_THREADS_ERROR
Number of OMP threads in the computation function is not equal to the number of OMP threads in the initialization stage (commit function)
DFTI_MULTITHREADED_ERROR
Usually associated with a value that OMP routines return in case of errors
DFTI_BAD_DESCRIPTOR
Descriptor is unusable for computation
DFTI_UNIMPLEMENTED
Unimplemented legitimate settings; implementation dependent
DFTI_MKL_INTERNAL_ERROR
Internal library error
DFTI_1D_LENGTH_EXCEEDS_INT32
Length of one of dimensions exceeds 2
32
-1 (4 bytes).
The
DftiErrorClass
function returns
a non-zero value
if the status belongs to the predefined error class. To check whether a function call was successful, call
DftiErrorClass
with a specific error class. However, the zero value of the status belongs to the
DFTI_NO_ERROR
class and thus the zero status indicates successful completion of an operation.
See Example
"Using Status Checking Functions"
for an illustration of correct use of the status checking functions.
It is incorrect to directly compare a status with a predefined class.
Prototype
  MKL_LONG DftiErrorClass( MKL_LONG , MKL_LONG ); 

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