Visible to Intel only — GUID: GUID-70C9CE2A-3213-467D-8CCA-5798FCC803A2
Visible to Intel only — GUID: GUID-70C9CE2A-3213-467D-8CCA-5798FCC803A2
Support Functions
Intel® oneAPI Math Kernel Library (oneMKL) support functions are subdivided into the following groups according to their purpose:
Single Dynamic Library Control
Conditional Numerical Reproducibility Control
The following table lists Intel® oneAPI Math Kernel Library (oneMKL) support functions.
Function Name |
Operation |
---|---|
Version Information |
|
Returns the Intel® oneAPI Math Kernel Library (oneMKL) 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® oneAPI Math Kernel Library (oneMKL) functions on the current execution thread. |
|
Enables Intel® oneAPI Math Kernel Library (oneMKL) 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® oneAPI Math Kernel Library (oneMKL) 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. |
|
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® oneAPI Math Kernel Library (oneMKL) Memory Allocator. |
|
Frees unused memory allocated by the Intel® oneAPI Math Kernel Library (oneMKL) Memory Allocator in the current thread. |
|
Reports the status of the Intel® oneAPI Math Kernel Library (oneMKL) Memory Allocator. |
|
Reports the peak memory allocated by the Intel® oneAPI Math Kernel Library (oneMKL) Memory Allocator. |
|
Turns off the Intel® oneAPI Math Kernel Library (oneMKL) Memory Allocator for Intel® oneAPI Math Kernel Library (oneMKL) functions to directly use the systemmalloc/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® oneAPI Math Kernel Library (oneMKL) can allocate for a specified type of memory. |
|
Single Dynamic Library (SDL) Control |
|
Sets the interface layer for Intel® oneAPI Math Kernel Library (oneMKL) at run time. |
|
Sets the threading layer for Intel® oneAPI Math Kernel Library (oneMKL) at run time. |
|
Replaces the error handling routine. Use with the Single Dynamic Library . | |
Replaces the progress information routine. |
|
Replaces the routine handling Intel® oneAPI Math Kernel Library (oneMKL) PARDISO pivots with a user-defined routine. Use with the Single Dynamic Library (SDL). |
|
Conditional Numerical Reproducibility (CNR) Control |
|
Configures the CNR mode of Intel® oneAPI Math Kernel Library (oneMKL). |
|
Returns the current CNR settings. |
|
Automatically detects the CNR code branch for your platform. |
|
Miscellaneous |
|
Provides progress information. |
|
Set up the mode that ignores environment settings specific to Intel® oneAPI Math Kernel Library (oneMKL). |
|
Enable or disable Intel® oneAPI Math Kernel Library (oneMKL) Verbose mode. |
|
Write output in Intel® oneAPI Math Kernel Library (oneMKL) Verbose mode to a file. |
|
Sets the implementation of the message-passing interface to be used by Intel® oneAPI Math Kernel Library (oneMKL). |
|
Terminates Intel® oneAPI Math Kernel Library (oneMKL) execution environment and frees resources allocated by the library. |
Product and Performance Information |
---|
Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex. Notice revision #20201201 |