Intel MKL BLAS backend

Runtime helpers for integrating Intel MKL with Uni20 BLAS abstractions. More...

Collaboration diagram for Intel MKL BLAS backend:

Enumerations
enum class	uni20::blas::mkl::Domain : int {   uni20::blas::mkl::Domain::all = MKL_DOMAIN_ALL , uni20::blas::mkl::Domain::blas = MKL_DOMAIN_BLAS , uni20::blas::mkl::Domain::fft = MKL_DOMAIN_FFT , uni20::blas::mkl::Domain::vml = MKL_DOMAIN_VML ,   uni20::blas::mkl::Domain::pardiso = MKL_DOMAIN_PARDISO , uni20::blas::mkl::Domain::lapack = MKL_DOMAIN_LAPACK }
	MKL computation domains accepted by domain-specific thread controls. More...

Functions
int	uni20::blas::mkl::max_threads ()
	Return the current global maximum number of oneMKL threads.
int	uni20::blas::mkl::max_threads (Domain domain)
	Return the maximum oneMKL thread count for a specific domain.
constexpr bool	uni20::blas::mkl::sequential_backend ()
	Return whether this build links the sequential MKL backend.
void	uni20::blas::mkl::set_num_threads (int threads)
	Set the global maximum number of oneMKL threads.
int	uni20::blas::mkl::set_num_threads (int threads, Domain domain)
	Set the maximum number of oneMKL threads for a specific domain.
constexpr bool	uni20::blas::mkl::threaded_backend ()
	Return whether this build links the threaded MKL backend.
std::string	uni20::blas::mkl::version_string ()
	Return the oneMKL version string.

Detailed Description

Runtime helpers for integrating Intel MKL with Uni20 BLAS abstractions.

Enumeration Type Documentation

Domain

enum class uni20::blas::mkl::Domain : int

strong

MKL computation domains accepted by domain-specific thread controls.

Enumerator
all
blas
fft
vml
pardiso
lapack

Function Documentation

max_threads() [1/2]

int uni20::blas::mkl::max_threads ( )

inline

Return the current global maximum number of oneMKL threads.

Returns

Current maximum thread count.

max_threads() [2/2]

int uni20::blas::mkl::max_threads ( Domain  domain )

inline

Return the maximum oneMKL thread count for a specific domain.

Parameters

domain

oneMKL computation domain to query.

Returns

Current maximum thread count for the requested domain.

sequential_backend()

constexpr bool uni20::blas::mkl::sequential_backend ( )

constexpr

Return whether this build links the sequential MKL backend.

Returns

True when UNI20_BACKEND_MKL_SEQUENTIAL is enabled.

set_num_threads() [1/2]

void uni20::blas::mkl::set_num_threads ( int  threads )

inline

Set the global maximum number of oneMKL threads.

Parameters

threads

Requested thread count.

set_num_threads() [2/2]

int uni20::blas::mkl::set_num_threads ( int  threads, Domain  domain  )

inline

Set the maximum number of oneMKL threads for a specific domain.

Parameters

threads	Requested thread count.
domain	oneMKL computation domain to configure.

Returns

oneMKL status code from MKL_Domain_Set_Num_Threads.

threaded_backend()

constexpr bool uni20::blas::mkl::threaded_backend ( )

constexpr

Return whether this build links the threaded MKL backend.

Returns

True when UNI20_BACKEND_MKL_THREADED is enabled.

version_string()

std::string uni20::blas::mkl::version_string ( )

inline

Return the oneMKL version string.

Returns

Human-readable oneMKL version text.