Visible to Intel only — GUID: GUID-68683755-05A2-4DAC-A25E-B03D339772A6
Visible to Intel only — GUID: GUID-68683755-05A2-4DAC-A25E-B03D339772A6
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, then A is upper triangular.
If uplo = uplo::lower, then A is lower triangular.
- diag
-
If diag = diag::nonunit, then A is not a unit triangular matrix.
If diag = diag::unit, then A is unit triangular: diagonal elements of A 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 |
---|---|
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 trtri (buffer or USM version) function must be able to hold.