trtri_scratchpad_size¶
Computes size of scratchpad memory required for trtri
(USM Version)
function. This routine belongs to the oneapi::mkl::lapack
namespace.
Description¶
This routine computes the number of elements of type T
the scratchpad memory to be passed to the trtri
(USM version) function must be able to hold.
API¶
Syntax¶
namespace oneapi::mkl::lapack {
template<typename T>
std::int64_t trtri_scratchpad_size(sycl::queue &queue,
mkl::uplo uplo,
mkl::diag diag,
std::int64_t n,
std::int64_t lda)
}
Input Parameters¶
- queue
Device queue where calculations by the trtri (buffer or USM version) function will be performed.
- uplo
Indicates whether
A
is upper or lower triangular:If uplo =
uplo::upper
, thenA
is upper triangular.If uplo =
uplo::lower
, thenA
is lower triangular.- diag
If diag =
diag::nonunit
, thenA
is not a unit triangular matrix.If diag =
diag::unit
, thenA
is unit triangular: diagonal elements ofA
are assumed to be 1 and not referenced in the array a.- n
The order of the matrix
A
(n ≥ 0
).- lda
The leading dimension of
a
;lda ≥ 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 trtri
(buffer or USM version) function must be able to hold.