unmtr_scratchpad_size#
Computes size of scratchpad memory required for unmtr (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 unmtr (buffer or USM version) function must be able to hold.
API#
Syntax#
namespace oneapi::mkl::lapack {
template<typename T>
int64_t unmtr_scratchpad_size(sycl::queue &queue,
mkl::side side,
mkl::uplo uplo,
mkl::transpose trans,
int64_t n,
int64_t lda,
int64_t ldc)
}
Input Parameters#
In the descriptions below, r denotes the order of Q:
|
if |
|
if |
- queue
Device queue where calculations by the unmtr (buffer or USM version) function will be performed.
- side
Must be either
side::leftorside::right.If
side = side::left,QorQT is applied toCfrom the left.If
side = side::right,QorQT is applied toCfrom the right.- uplo
Must be either
uplo::upperoruplo::lower. Uses the sameuploas supplied to hetrd (USM Version).- trans
Must be either
transpose::nontransortranspose::trans.If
trans = transpose::nontrans, the routine multipliesCbyQ.If
trans = transpose::trans, the routine multipliesCbyQT.- m
The number of rows in the matrix
C(m ≥ 0).- n
The number of columns in the matrix
C(n ≥ 0).- lda
The leading dimension of
a(lda ≥ max(1, r)).- ldc
The leading dimension of
c(ldc ≥ max(1, m)).
Exceptions#
Exception |
Description |
|---|---|
|
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 unmtr (buffer or USM version) function must be able to hold.