symm¶
Computes a matrix-matrix product where one input matrix is symmetric and one matrix is general.
Description¶
The symm
routines compute a scalar-matrix-matrix product and add the
result to a scalar-matrix product, where one of the matrices in the
multiplication is symmetric. The argument left_right
determines
if the symmetric matrix, A
, is on the left of the multiplication
(left_right
= side::left
) or on the right (left_right
=
side::right
). Depending on left_right
, the operation is
defined as
or
where:
alpha
andbeta
are scalars,A
is a symmetric matrix, eitherm
-by-m
orn
-by-n
,B
andC
arem
-by-n
matrices.
API¶
Syntax¶
namespace oneapi::mkl::blas::column_major {
void symm(sycl::queue &queue,
onemkl::side left_right,
onemkl::uplo upper_lower,
std::int64_t m,
std::int64_t n,
T alpha,
sycl::buffer<T,1> &a,
std::int64_t lda,
sycl::buffer<T,1> &b,
std::int64_t ldb,
T beta,
sycl::buffer<T,1> &c,
std::int64_t ldc)
}
namespace oneapi::mkl::blas::row_major {
void symm(sycl::queue &queue,
onemkl::side left_right,
onemkl::uplo upper_lower,
std::int64_t m,
std::int64_t n,
T alpha,
sycl::buffer<T,1> &a,
std::int64_t lda,
sycl::buffer<T,1> &b,
std::int64_t ldb,
T beta,
sycl::buffer<T,1> &c,
std::int64_t ldc)
}
symm
supports the following precisions and devices:
T |
Devices Supported |
---|---|
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
Input Parameters¶
- exec_queue
The queue where the routine should be executed.
- left_right
Specifies whether
A
is on the left side of the multiplication (side::left
) or on the right side (side::right
). See Data Types for more details.- upper_lower
Specifies whether A’s data is stored in its upper or lower triangle. See Data Types for more details.
- m
Number of rows of
B
andC
. The value ofm
must be at least zero.- n
Number of columns of
B
andC
. The value ofn
must be at least zero.- alpha
Scaling factor for the matrix-matrix product.
- a
Buffer holding input matrix
A
. Must have size at leastlda
*m
ifA
is on the left of the multiplication, orlda
*n
ifA
is on the right. See Matrix and Vector Storage for more details.- lda
Leading dimension of
A
. Must be at leastm
ifA
is on the left of the multiplication, or at leastn
ifA
is on the right. Must be positive.- b
Buffer holding input matrix
B
. It must have a size of at least ldb*n if column major layout is used to store matrices or at least ldb*m if row major layout is used to store matrices. See Matrix and Vector Storage for more details.- ldb
Leading dimension of
B
. It must be positive and at leastm
if column major layout is used to store matrices or at leastn
if column major layout is used to store matrices.- beta
Scaling factor for matrix
C
.- c
Buffer holding input/output matrix
C
. It must have a size of at least ldc*n if column major layout is used to store matrices or at least ldc*m if row major layout is used to store matrices. See Matrix and Vector Storage for more details.- ldc
Leading dimension of
C
. It must be positive and at leastm
if column major layout is used to store matrices or at leastn
if column major layout is used to store matrices.
Output Parameters¶
- c
Output buffer, overwritten by
alpha
*A
*B
+beta
*C
(left_right
=side::left
) oralpha
*B
*A
+beta
*C
(left_right
=side::right
).Note
If
beta
= 0, matrixC
does not need to be initialized before callingsymm
.