gemmt#
Computes a matrix-matrix product with general matrices, but updates only the upper or lower triangular part of the result matrix.
Description
The gemmt routines compute a scalar-matrix-matrix product and add the result to the upper or lower part of a scalar-matrix product, with general matrices. The operation is defined as:
where:
op(X
) is one of op(X
) = X
, or op(X
) = X
T, or
op(X
) = X
H,
alpha
and beta
are scalars
A
, B
, and C
are matrices
op(A
) is n
x k
, op(B
) is k
x n
, and
C
is n
x n
.
gemmt
supports the following precisions.
T
float
double
std::complex<float>
std::complex<double>
gemmt (Buffer Version)#
Syntax
namespace oneapi::mkl::blas::column_major {
void gemmt(sycl::queue &queue,
onemkl::uplo upper_lower,
onemkl::transpose transa,
onemkl::transpose transb,
std::int64_t n,
std::int64_t k,
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 gemmt(sycl::queue &queue,
onemkl::uplo upper_lower,
onemkl::transpose transa,
onemkl::transpose transb,
std::int64_t n,
std::int64_t k,
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)
}
Input Parameters
- queue
The queue where the routine should be executed.
- upper_lower
Specifies whether
C
’s data is stored in its upper or lower triangle. See oneMKL Defined Datatypes for more details.- transa
Specifies op(
A
), the transposition operation applied toA
. See oneMKL Defined Datatypes for more details.- transb
Specifies op(
B
), the transposition operation applied toB
. See oneMKL Defined Datatypes for more details.- n
Number of rows of op(
A
), columns of op(B
), and columns and rows ofC
. Must be at least zero.- k
Number of columns of op(
A
) and rows of op(B
). Must be at least zero.- alpha
Scaling factor for the matrix-matrix product.
- a
Buffer holding the input matrix
A
.A
not transposedA
transposedColumn major
A
is ann
-by-k
matrix so the arraya
must have size at leastlda
*k
.A
is ank
-by-n
matrix so the arraya
must have size at leastlda
*n
Row major
A
is ann
-by-k
matrix so the arraya
must have size at leastlda
*n
.A
is ank
-by-n
matrix so the arraya
must have size at leastlda
*k
.See Matrix Storage for more details.
- lda
The leading dimension of
A
. It must be positive.A
not transposedA
transposedColumn major
lda
must be at leastn
.lda
must be at leastk
.Row major
lda
must be at leastk
.lda
must be at leastn
.- b
Buffer holding the input matrix
B
.B
not transposedB
transposedColumn major
B
is ank
-by-n
matrix so the arrayb
must have size at leastldb
*n
.B
is ann
-by-k
matrix so the arrayb
must have size at leastldb
*k
Row major
B
is ank
-by-n
matrix so the arrayb
must have size at leastldb
*k
.B
is ann
-by-k
matrix so the arrayb
must have size at leastldb
*n
.See Matrix Storage for more details.
- ldb
The leading dimension of
B
. It must be positive.B
not transposedB
transposedColumn major
ldb
must be at leastk
.ldb
must be at leastn
.Row major
ldb
must be at leastn
.ldb
must be at leastk
.- beta
Scaling factor for matrix
C
.- c
Buffer holding the input/output matrix
C
. Must have size at leastldc
*n
. See Matrix Storage for more details.- ldc
Leading dimension of
C
. Must be positive and at leastm
.
Output Parameters
- c
Output buffer, overwritten by the upper or lower triangular part of
alpha
* op(A
)*op(B
) +beta
*C
.
Notes
If beta
= 0, matrix C
does not need to be initialized
before calling gemmt.
gemmt (USM Version)#
Syntax
namespace oneapi::mkl::blas::column_major {
sycl::event gemmt(sycl::queue &queue,
onemkl::uplo upper_lower,
onemkl::transpose transa,
onemkl::transpose transb,
std::int64_t n,
std::int64_t k,
T alpha,
const T* a,
std::int64_t lda,
const T* b,
std::int64_t ldb,
T beta,
T* c,
std::int64_t ldc,
const std::vector<sycl::event> &dependencies = {})
}
namespace oneapi::mkl::blas::row_major {
sycl::event gemmt(sycl::queue &queue,
onemkl::uplo upper_lower,
onemkl::transpose transa,
onemkl::transpose transb,
std::int64_t n,
std::int64_t k,
T alpha,
const T* a,
std::int64_t lda,
const T* b,
std::int64_t ldb,
T beta,
T* c,
std::int64_t ldc,
const std::vector<sycl::event> &dependencies = {})
}
Input Parameters
- queue
The queue where the routine should be executed.
- upper_lower
Specifies whether
C
’s data is stored in its upper or lower triangle. See oneMKL Defined Datatypes for more details.- transa
Specifies op(
A
), the transposition operation applied toA
. See oneMKL Defined Datatypes for more details.- transb
Specifies op(
B
), the transposition operation applied toB
. See oneMKL Defined Datatypes for more details.- n
Number of columns of op(
A
), columns of op(B
), and columns ofC
. Must be at least zero.- k
Number of columns of op(
A
) and rows of op(B
). Must be at least zero.- alpha
Scaling factor for the matrix-matrix product.
- a
Pointer to input matrix
A
.A
not transposedA
transposedColumn major
A
is ann
-by-k
matrix so the arraya
must have size at leastlda
*k
.A
is ank
-by-n
matrix so the arraya
must have size at leastlda
*n
Row major
A
is ann
-by-k
matrix so the arraya
must have size at leastlda
*n
.A
is ank
-by-n
matrix so the arraya
must have size at leastlda
*k
See Matrix Storage for more details.
- lda
The leading dimension of
A
. It must be positive.A
not transposedA
transposedColumn major
lda
must be at leastn
.lda
must be at leastk
.Row major
lda
must be at leastk
.lda
must be at leastn
.- b
Pointer to input matrix
B
.B
not transposedB
transposedColumn major
B
is ank
-by-n
matrix so the arrayb
must have size at leastldb
*n
.B
is ann
-by-k
matrix so the arrayb
must have size at leastldb
*k
Row major
B
is ank
-by-n
matrix so the arrayb
must have size at leastldb
*k
.B
is ann
-by-k
matrix so the arrayb
must have size at leastldb
*n
See Matrix Storage for more details.
- ldb
The leading dimension of
B
. It must be positive.B
not transposedB
transposedColumn major
ldb
must be at leastk
.ldb
must be at leastn
.Row major
ldb
must be at leastn
.ldb
must be at leastk
.- beta
Scaling factor for matrix
C
.- c
Pointer to input/output matrix
C
. Must have size at leastldc
*n
. See Matrix Storage for more details.- ldc
Leading dimension of
C
. Must be positive and at leastm
.- dependencies
List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.
Output Parameters
- c
Pointer to the output matrix, overwritten by the upper or lower triangular part of
alpha
* op(A
)*op(B
) +beta
*C
.
Notes
If beta
= 0, matrix C
does not need to be initialized
before calling gemmt.
Return Values
Output event to wait on to ensure computation is complete.
Parent topic: BLAS-like Extensions