potrs_batch_scratchpad_size (Group Version)¶
Computes size of scratchpad memory required for potrs_batch (Group
Version) function. This routine belongs to the
oneapi::mkl::lapack
namespace.
Syntax
namespace oneapi::mkl::lapack {
std::int64_t potrs_batch_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,
std::int64_t group_count,
std::int64_t *group_sizes)
}
Function supports the following precisions and devices.
.. list-table::
:header-rows: 1
* - T
- Devices supported
* - ``float``
- Host, CPU, and GPU
* - ``double``
- Host, CPU, and GPU
* - ``std::complex<float>``
- Host, CPU, and GPU
* - ``std::complex<double>``
- Host, CPU, and GPU
Description
Computes the number of elements of type T the scratchpad memory to be passed to the potrs_batch (Group Version) function should be able to hold.
Input Parameters
- queue
Device queue where calculations will be performed.
- uplo
Array of
group_count
parametersuplo
g.Each of uplog indicates whether the upper or lower triangular parts of the input matrices are provided.
If uplog=
mkl::uplo::upper
, input matrices from arraya
belonging to groupg
store the upper triangular parts.If uplog=
mkl::uplo::lower
, input matrices from arraya
belonging to groupg
store the lower triangular parts.- n
Array of
group_count
parametersn
g.Each
n
g specifies the order of the input matrices belonging to groupg
.- nrhs
Array of
nrhs
g parameters.Each
nrhs
g specifies the number of right-hand sides supplied for to groupg
.- lda
Array of
group_count
parameterslda
g.Each
lda
g specifies the leading dimension of the matrices belonging to groupg
.- ldb
Array of
group_count
parametersldb
g.Each
ldb
g specifies the leading dimension of the matrices belonging to groupg
.- group_count
Specifies the number of groups of parameters. Must be at least 0.
- group_sizes
Array of
group_count
integers. Array element with indexg
specifies the number of problems to solve for each of the groups of parametersg
. So the total number of problems to solve,batch_size
, is a sum of all parameter group sizes.
Exceptions
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_batch (Group Version) function should be able to hold.