trtrs_scratchpad_size#
Computes size of scratchpad memory required for trtrs (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 trtrs (buffer or USM version) function must be able to hold.
API#
Syntax#
namespace oneapi::mkl::lapack {
template<typename T>
int64_t trtrs_scratchpad_size(sycl::queue &queue,
mkl::uplo uplo,
mkl::transpose trans,
mkl::diag diag,
int64_t n,
int64_t nrhs,
int64_t lda,
int64_t ldb)
}
Input Parameters#
- queue
Device queue where calculations by the trtrs (buffer or USM version) function will be performed.
- uplo
Indicates whether
Ais upper or lower triangular:If uplo =
uplo::upper, thenAis upper triangular.If uplo =
uplo::lower, thenAis lower triangular.- trans
If trans =
transpose::nontrans, thenA*X=Bis solved forX.If trans =
transpose::trans, thenAT*X=Bis solved forX.If trans =
transpose::conjtrans, thenAH*X=Bis solved forX.- diag
If diag =
diag::nonunit, thenAis not a unit triangular matrix.If diag =
diag::unit, thenAis unit triangular: diagonal elements ofAare assumed to be 1 and not referenced in the array a.- n
The order of
A; the number of rows inB;n`` ≥ 0``.- nrhs
The number of right-hand sides; nrhs`` ≥ 0``.
- lda
The leading dimension of
a; lda`` ≥ max(1, n)``.- ldb
The leading dimension of b; ldb`` ≥ max(1, n)``.
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 trtrs (buffer or USM version) function must be able to hold.