Developer Reference

Contents

getrs_batch_scratchpad_size (Group Version)

Computes size of scratchpad memory required for
getrs_batch
(Group 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 getrs_batch (Group Version) function should be able to hold.

API

Syntax
namespace oneapi::mkl::lapack { std::int64_t getrs_batch_scratchpad_size(cl::sycl::queue &queue, mkl::transpose *trans, 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.
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
Input Parameters
queue
Device queue where calculations will be performed.
trans
Array of
group_count
parameters trans
g
indicating the form of the equations for the group
g
:
If trans = mkl::transpose::nontrans, then
A
i
*
X
i
=
B
i
is solved for
X
i
.
If trans = mkl::transpose::trans, then
A
i
T
*
X
i
=
B
i
is solved for
X
i
.
If trans = mkl::transpose::conjtrans, then
A
i
H
*
X
i
=
B
i
is solved for
X
i
.
n
Array of
group_count
parameters
n
g
specifying the order of the matrices
A
i
and the number of rows in matrices
B
i
(
0 ≤ ng
) belonging to group
g
.
nrhs
Array of
group_count
parameters
nrhs
g
specifying the number of right hand sides
(0≤nrhsg)
for group
g
.
lda
Array of
group_count
parameters
lda
g
specifying the leading dimension of
A
i
from group
g
.
ldb
Array of
group_count
parameters
ldb
g
specifying the leading dimension of
B
i
from group
g
.
group_count
Specifies the number of groups of parameters. Must be at least 0.
group_sizes
Array of
group_count
integers. Array element with index
g
specifies the number of problems to solve for each of the groups of parameters
g
. So the total number of problems to solve,
batch_size
, is a sum of all parameter group sizes.
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 getrs_batch (Group Version) function should be able to hold.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.