potrs_scratchpad_size¶
Computes size of scratchpad memory required for potrs (USM Version)
function. This routine belongs to the
oneapi::mkl::lapack
namespace.
Syntax
namespace oneapi::mkl::lapack {
template<typename T>
std::int64_t potrs_scratchpad_size(
cl::sycl::queue &queue,
mkl::uplo uplo,
std::int64_t n,
std::int64_t nrhs,
std::int64_t lda,
std::int64_t ldb)
}
.. rubric:: Description
:class: sectiontitle
Computes the number of elements of type T the scratchpad memory to
be passed to the potrs (buffer or USM version) function should be
able to hold.
.. rubric:: Input Parameters
:class: sectiontitle
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`` = ``U``\ :sup:`T`\ \*\ ``U`` for
real data, ``A`` = ``U``\ :sup:`H`\ \*\ ``U`` for complex data.
If uplo=\ ``mkl::uplo::lower``, the upper triangle ``L`` of
``A`` is stored, where ``A`` = ``L``\ \*\ ``L``\ :sup:`T` for
real data, ``A`` = ``L``\ \*\ ``L``\ :sup:`H` 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
.. list-table::
* - 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 should be able to hold.