Support Functions

Intel® Math Kernel Library (Intel® MKL) support functions are used to:

- retrieve information about the current Intel MKL version

- additionally control the number of threads

- handle errors

- test characters and character strings for equality

- measure user time for a process and elapsed CPU time

- measure CPU frequency

- free memory allocated by Intel MKL memory management software

- facilitate easy linking

Functions described below are subdivided according to their purpose into the following groups:

Version Information Functions

Threading Control Functions

Error Handling Functions

Equality Test Functions

Timing Functions

Memory Functions

Miscellaneous Utility Functions

Functions Supporting the Single Dynamic Library

Table "Intel MKL Support Functions" contains the list of support functions common for Intel MKL.

Intel MKL Support Functions

Function Name

Operation

Version Information Functions

mkl_get_version

Returns information about the active library version.

mkl_get_version_string

Returns information about the library version string.

Threading Control Functions

mkl_set_num_threads

Suggests the number of threads to use.

mkl_domain_set_num_threads

Suggests the number of threads for a particular function domain.

mkl_set_dynamic

Enables Intel MKL to dynamically change the number of threads.

mkl_get_max_threads

Inquires about the number of threads targeted for parallelism.

mkl_domain_get_max_threads

Inquires about the number of threads targeted for parallelism in different domains.

mkl_get_dynamic

Returns the current value of the MKL_DYNAMIC variable.

Error Handling Functions

xerbla

Handles error conditions for the BLAS, LAPACK, VSL, VML routines.

pxerbla

Handles error conditions for the ScaLAPACK routines.

Equality Test Functions

lsame

Tests two characters for equality regardless of the case.

lsamen

Tests two character strings for equality regardless of the case.

Timing Functions

second/dsecnd

Returns user time for a process.

mkl_get_cpu_clocks

Returns full precision elapsed CPU clocks.

mkl_get_cpu_frequency

Returns CPU frequency value in GHz.

mkl_get_max_cpu_frequency

Returns the maximum CPU frequency value in GHz.

mkl_get_clocks_frequency

Returns the frequency value in GHz based on constant-rate Time Stamp Counter.

Memory Functions

mkl_free_buffers

Frees memory buffers.

mkl_thread_free_buffers

Frees memory buffers allocated only in the current thread.

mkl_mem_stat

Reports an amount of memory utilized by Intel MKL memory management software.

mkl_disable_fast_mm

Enables Intel MKL to dynamically turn off memory management.

mkl_malloc

Allocates the aligned memory buffer.

mkl_free

Frees the aligned memory buffer allocated by MKL_malloc.

Miscellaneous Utility Functions

mkl_progress

Tracks computational progress of selective MKL routines.

mkl_enable_instructions

Allows Intel MKL to dispatch Intel® Advanced Vector Extensions (Intel® AVX) if run on the respective hardware (or simulation).

Functions Supporting the Single Dynamic Library (SDL)

mkl_set_interface_layer

Sets the interface layer for Intel MKL at run time.

mkl_set_threading_layer

Sets the threading layer for Intel MKL at run time.

mkl_set_xerbla

Replaces the error handling routine. Use with SDL on Windows* OS.

mkl_set_progress

Replaces the progress information routine. Use with SDL on Windows* OS.


Submit feedback on this help topic