Intel® Math Kernel Library 2018 Developer Reference - C
Intel® Math Kernel Library (Intel® MKL) support functions are subdivided into the following groups according to their purpose:
Single Dynamic Library Control
Intel® Many Integrated Core (Intel® MIC) Architecture Support
Conditional Numerical Reproducibility Control
The following table lists Intel MKL support functions.
Function Name |
Operation |
---|---|
Version Information |
|
Returns the Intel MKL version. |
|
Returns the Intel MKL version in a character string. |
|
Threading Control |
|
Specifies the number of OpenMP* threads to use. |
|
Specifies the number of OpenMP* threads for a particular function domain. |
|
Specifies the number of OpenMP* threads for all Intel MKL functions on the current execution thread. |
|
Enables Intel MKL to dynamically change the number of OpenMP* threads. |
|
Gets the number of OpenMP* threads targeted for parallelism. |
|
Gets the number of OpenMP* threads targeted for parallelism for a particular function domain. |
|
Determines whether Intel MKL is enabled to dynamically change the number of OpenMP* threads. |
|
Specifies the number of partitions along the leading dimension of the output matrix for parallel ?gemm functions. |
|
Gets the number of partitions along the leading dimension of the output matrix for parallel ?gemm functions. |
|
Error Handling |
|
Error handling function called by BLAS, LAPACK, Vector Math, and Vector Statistics functions. |
|
Handles error conditions for the ScaLAPACK routines. |
|
Error handling function called by the C interface to LAPACK functions. |
|
Sets the custom handler of fatal errors. |
|
Character Equality Testing |
|
Tests two characters for equality regardless of the case. |
|
Tests two character strings for equality regardless of the case. |
|
Timing |
|
Returns elapsed time in seconds. Use to estimate real time between two calls to this function. |
|
Returns elapsed CPU clocks. |
|
Returns CPU frequency value in GHz. |
|
Returns the maximum CPU frequency value in GHz. |
|
Returns the frequency value in GHz based on constant-rate Time Stamp Counter. |
|
Memory Management |
|
Frees unused memory allocated by the Intel MKL Memory Allocator. |
|
Frees unused memory allocated by the Intel MKL Memory Allocator in the current thread. |
|
Reports the status of the Intel MKL Memory Allocator. |
|
Reports the peak memory allocated by the Intel MKL Memory Allocator. |
|
Turns off the Intel MKL Memory Allocator for Intel MKL functions to directly use the system malloc/free functions. |
|
Allocates an aligned memory buffer. |
|
Allocates and initializes an aligned memory buffer. |
|
Changes the size of memory buffer allocated by mkl_malloc/mkl_calloc. |
|
Frees the aligned memory buffer allocated by mkl_malloc/mkl_calloc. |
|
On Linux, sets the limit of memory that Intel MKL can allocate for a specified type of memory. |
|
Single Dynamic Library (SDL) Control |
|
Sets the interface layer for Intel MKL at run time. |
|
Sets the threading layer for Intel MKL at run time. |
|
Replaces the error handling routine. Use with the Single Dynamic Library on Windows*. | |
Replaces the progress information routine. |
|
Replaces the routine handling Intel MKL PARDISO pivots with a user-defined routine. Use with the Single Dynamic Library (SDL). |
|
Intel MIC Architecture Support |
|
Enables Automatic Offload mode. |
|
Disables Automatic Offload mode. |
|
Returns the number of Intel® Xeon Phi™ coprocessors on the system when called on the host CPU. |
|
For computations in the Automatic Offload mode, sets the fraction of the work for the specified coprocessor or host CPU to do. |
|
For computations in the Automatic Offload mode, retrieves the fraction of the work for the specified coprocessor or host CPU to do. |
|
Sets the maximum amount of coprocessor memory reserved for Automatic Offload computations. |
|
Frees the coprocessor memory reserved for Automatic Offload computations. |
|
Enables/disables the mkl_malloc function running in Automatic Offload mode to register allocated memory. |
|
Sets the maximum number of OpenMP* threads to use on an Intel Xeon Phi coprocessor for the Automatic Offload computations. |
|
mkl_mic_set_resource_limit | For computations in the Automatic Offload mode, sets the maximum fraction of available Intel Xeon Phi coprocessor computational resources (cores) that the calling process can use. |
mkl_mic_get_resource_limit | For computations in the Automatic Offload mode, retrieves the maximum fraction of available Intel Xeon Phi coprocessor computational resources (cores) that the calling process can use. |
Turns on/off reporting of Automatic Offload profiling. |
|
Sets flags to control the behavior of computations in the Automatic Offload mode. | |
Retrieves flags that control the behavior of computations in the Automatic Offload mode. |
|
For the Automatic Offload mode, returns the status of the latest call to an Intel MKL function. |
|
For the Automatic Offload mode, clears the status of the latest call to an Intel MKL function. |
|
Retrieves the amount of total and free memory for the specified coprocessor or host CPU. |
|
Retrieves the number of cores, hardware threads, and frequency for the specified coprocessor or host CPU. |
|
Conditional Numerical Reproducibility (CNR) Control |
|
Configures the CNR mode of Intel MKL. |
|
Returns the current CNR settings. |
|
Automatically detects the CNR code branch for your platform. |
|
Miscellaneous |
|
Provides progress information. |
|
Provides progress information. |
|
Enables dispatching for new Intel® architectures or restricts the set of Intel® instruction sets available for dispatching. |
|
Sets up the mode that ignores environment settings specific to Intel MKL. |
|
Enables or disables Intel MKL Verbose mode. |
|
Sets the implementation of the message-passing interface to be used by Intel MKL. |
|
Terminates Intel MKL execution environment and frees resources allocated by the library. |
Optimization Notice |
---|
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 |