ormtr_scratchpad_size
Computes size of scratchpad memory required for
ormtr
(USM Version) function. This routine belongs to the oneapi::mkl::lapack
namespace.Description
Computes the number of elements of type
T
the scratchpad memory to be passed to the ormtr
(buffer or USM version) function should be able to hold.API
Syntax
namespace oneapi::mkl::lapack {
template<typename T>
std::int64_t ormtr_scratchpad_size(cl::sycl::queue &queue,
mkl::side side,
mkl::uplo uplo,
mkl::transpose trans,
std::int64_t m,
std::int64_t n,
std::int64_t lda,
std::int64_t ldc)
}
Input Parameters
In the descriptions below,
r
denotes the order of Q
:r = m | if side = side::left |
r = n | if side = side::right |
- queue
- Device queue where calculations by theormtr(buffer or USM version) function will be performed.
- side
- Must be eitherside::leftorside::right.Ifside = side::left,QorQTis applied toCfrom the left.Ifside = side::right,QorQTis applied toCfrom the right.
- uplo
- trans
- Must be eithertranspose::nontransortranspose::trans.Iftrans = transpose::nontrans, the routine multipliesCbyQ.Iftrans = transpose::trans, the routine multipliesCbyQT.
- m
- The number of rows in the matrixC(m ≥ 0).
- n
- The number of columns in the matrixC(n ≥ 0).
- lda
- The leading dimension of a(max(1, r) ≤ lda).
- ldc
- The leading dimension of c(max(1, n) ≤ ldc).
Exceptions
Exception | Description |
---|---|
mkl::lapack::exception | This exception is thrown when an incorrect argument value is supplied. You can determine the position of the incorrect argument by the info() method of the exception object. |
Return Values
The number of elements of type
T
the scratchpad memory to be passed to the ormtr
(buffer or USM version) function should be able to hold.