Visible to Intel only — GUID: GUID-9BA787A1-6CC1-40EF-A5A2-D3E9EFA93047
Visible to Intel only — GUID: GUID-9BA787A1-6CC1-40EF-A5A2-D3E9EFA93047
oneapi::mkl::sparse::gemm
Computes a sparse matrix-dense matrix product.
Description
The oneapi::mkl::sparse::gemm routine computes a sparse matrix-dense matrix product defined as
where: and are scalars, is a sparse matrix of size num_rows rows by num_cols columns, and is a matrix modifier for A and X using the following description:
The dense matrix objects X and Y are stored with row-major or column-major layout and have an appropriate number of rows for the matrix product and columns number of columns.
API
Syntax
Using SYCL buffers:
namespace oneapi::mkl::sparse {
void gemm(sycl::queue &queue,
oneapi::mkl::layout layout_val,
oneapi::mkl::transpose opA,
oneapi::mkl::transpose opX,
const DATA_TYPE alpha,
matrix_handle_t A,
sycl::buffer<DATA_TYPE, 1> &X,
const std::int64_t columns,
const std::int64_t ldx,
const DATA_TYPE beta,
sycl::buffer<DATA_TYPE, 1> &Y,
const std::int64_t ldy);
}
Using USM pointers:
namespace oneapi::mkl::sparse {
sycl::event gemm(
sycl::queue &queue,
oneapi::mkl::layout layout_val,
oneapi::mkl::transpose opA,
oneapi::mkl::transpose opX,
const DATA_TYPE alpha,
matrix_handle_t A,
DATA_TYPE *X,
const std::int64_t columns,
const std::int64_t ldx,
const DATA_TYPE beta,
DATA_TYPE *Y,
const std::int64_t ldy,
const std::vector<sycl::event> &dependencies = {});
}
int main() {
...
// For using SYCL buffers
oneapi::mkl::sparse::gemm(queue, oneapi::mkl::layout::row_major, opA, oneapi::mkl::transpose:nontrans, alpha, A, X, ... );
or
// For using USM pointers
auto ev_gemm = oneapi::mkl::sparse::gemm(queue, oneapi::mkl::layout::row_major, opA, oneapi::mkl::transpose:nontrans, alpha, A, X, ... );
...
}
Include Files
oneapi/mkl/spblas.hpp
Input Parameters
- queue
-
Specifies the SYCL command queue which will be used for SYCL kernels execution.
- layout_val
-
Specifies the storage scheme in memory for the dense matrices. Note that this layout applies to both X and Y dense matrices.
- opA
-
Specifies operation op() on input matrix A.
oneapi::mkl::transpose::nontrans
Non-transpose, .
oneapi::mkl::transpose::trans
Transpose, .
oneapi::mkl::transpose::conjtrans
Conjugate transpose, .
- opX
-
Specifies operation op() on input matrix X.
oneapi::mkl::transpose::nontrans
Non-transpose, .
oneapi::mkl::transpose::trans
Transpose, .
oneapi::mkl::transpose::conjtrans
Conjugate transpose, .
NOTE:Currently, the only supported case for operation is oneapi::mkl::transpose::nontrans. - alpha
-
Specifies the scalar, .
- A
-
Handle to object containing sparse matrix and other internal data. Created using one of the oneapi::mkl::sparse::set_<sparse_matrix_type>_data routines.
NOTE:The supported cases for <sparse_matrix_type> are csr on CPU and GPU devices, and coo only on CPU device. - X
-
SYCL buffer or device-accessible USM pointer of size at least rows*cols, where (with the assumption of opX == oneapi::mkl::transpose::nontrans).
layout=oneapi::mkl::layout::col-major
layout=oneapi::mkl::layout::row-major
rows (number of rows in X)
ldx
if , number of columns in A
if , number of rows in A
cols (number of columns in X)
columns
ldx
- columns
-
Number of columns of matrix Y.
- ldx
-
Specifies the leading dimension of matrix X. Must be positive, and at least columns if layout_val=oneapi::mkl::layout::row-major or at least number of columns in A if layout_val=oneapi::mkl::layout::col-major.
- beta
-
Specifies the scalar, .
- Y
-
SYCL buffer or device-accessible USM pointer of size at least rows*cols, where:
layout=oneapi::mkl::layout::col-major
layout=oneapi::mkl::layout::row-major
rows (number of rows in Y)
ldy
if , number of rows in A
if , number of columns in A
cols (number of columns in Y)
columns
ldy
- ldy
-
Specifies the leading dimension of matrix Y. Must be positive, and at least columns if layout_val=oneapi::mkl::layout::row-major or at least number of rows in A if layout_val=oneapi::mkl::layout::col-major.
- dependencies
-
A vector of type std::vector<sycl::event> containing the list of events that the oneapi::mkl::sparse::gemm routine depends on.
Output Parameters
- Y
-
Overwritten by the updated matrix Y.
Return Values (USM Only)
- sycl::event
-
SYCL event which can be waited upon or added as a dependency for the completion of the gemm routine.
Examples
An example of how to use oneapi::mkl::sparse::gemm with SYCL buffers or USM can be found in the oneMKL installation directory, under:
share/doc/mkl/examples/sycl/sparse_blas/source/csr_gemm_row_major.cpp
share/doc/mkl/examples/sycl/sparse_blas/source/csr_gemm_row_major_usm.cpp
share/doc/mkl/examples/sycl/sparse_blas/source/csr_gemm_col_major.cpp
share/doc/mkl/examples/sycl/sparse_blas/source/csr_gemm_col_major_usm.cpp