potrs_scratchpad_size#

Computes size of scratchpad memory required for potrs (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 potrs (buffer or USM version) function must be able to hold.

API#

Syntax#

namespace oneapi::mkl::lapack {
   template<typename T>
   int64_t potrs_scratchpad_size(
   sycl::queue &queue,
   mkl::uplo uplo,
   int64_t n,
   int64_t nrhs,
   int64_t lda,
   int64_t ldb)
}

Input Parameters#

queue

Device queue where calculations by the potrs (buffer or USM version) function will be performed.

uplo

Indicates how the input matrix has been factored:

If uplo=mkl::uplo::upper, the upper triangle U of A is stored, where A = UT*U for real data, A = UH*U for complex data.

If uplo=mkl::uplo::lower, the upper triangle L of A is stored, where A = L*LT for real data, A = L*LH for complex data.

n

The order of matrix A (0 ≤ n).

nrhs

The number of right-hand sides (0 ≤ nrhs).

lda

The leading dimension of A.

ldb

The leading dimension of B.

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 potrs (buffer or USM version) function must be able to hold.