ormtr_scratchpad_size¶
Computes size of scratchpad memory required for ormtr (USM Version)
function. This routine belongs to the
oneapi::mkl::lapack
namespace.
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)
}
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.
Input Parameters
In the descriptions below, r
denotes the order of Q
:
|
if |
---|---|
|
if |
- queue
Device queue where calculations by the ormtr (buffer or USM version) function will be performed.
- side
Must be either
side::left
orside::right
.If
side = side::left
,Q
orQ
T is applied toC
from the left.If
side = side::right
,Q
orQ
T is applied toC
from the right.- uplo
Must be either
uplo::upper
oruplo::lower
. Uses the sameuplo
as supplied to sytrd (USM Version).- trans
Must be either
transpose::nontrans
ortranspose::trans
.If
trans = transpose::nontrans
, the routine multipliesC
byQ
.If
trans = transpose::trans
, the routine multipliesC
byQ
T.- 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
(max(1, r) ≤ lda)
.- ldc
The leading dimension of c
(max(1, n) ≤ ldc)
.
Exceptions
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.