Visible to Intel only — GUID: GUID-A242385C-AA77-481D-AB24-5142F6F1440F
Visible to Intel only — GUID: GUID-A242385C-AA77-481D-AB24-5142F6F1440F
oneapi::mkl::sparse::gemvdot
Computes a sparse matrix-dense vector product with dot product.
Description
The oneapi::mkl::sparse::gemvdot routine computes a sparse matrix-dense vector product and dot product defined as
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-2/DC92588D-A439-420B-B6BC-ADEA40EBCFF5-low.png)
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-2/58791509-B1EE-414B-B57B-55131790A576-low.png)
where is a general sparse matrix,
,
, and
are scalars,
and
are dense vectors and
is a matrix modifier:
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-2/EBD814F8-1FC0-45F2-8954-3B5CBFDC8DB8-low.png)
API
Syntax
Using SYCL buffers:
namespace oneapi::mkl::sparse {
void gemvdot (
sycl::queue &queue,
oneapi::mkl::transpose opA,
const DATA_TYPE alpha,
oneapi::mkl::sparse::matrix_handle_t A,
sycl::buffer<DATA_TYPE, 1> &x,
const DATA_TYPE beta,
sycl::buffer<DATA_TYPE, 1> &y,
sycl::buffer<DATA_TYPE, 1> &d)
}
Using USM pointers:
namespace oneapi::mkl::sparse {
sycl::event gemvdot (
sycl::queue &queue,
oneapi::mkl::transpose opA,
const DATA_TYPE alpha,
oneapi::mkl::sparse::matrix_handle_t A,
DATA_TYPE *x,
const DATA_TYPE beta,
DATA_TYPE *y,
DATA_TYPE *d,
const std::vector<sycl::event> &dependencies={})
}
Include Files
oneapi/mkl/spblas.hpp
Input Parameters
- queue
-
Specifies the SYCL command queue which will be used for SYCL kernels execution.
- opA
-
Specifies operation op() on input matrix.
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 equal to the number of columns of input matrix if opA == oneapi::mkl::transpose::nontrans and at least the number of rows of input matrix otherwise.
- beta
-
Specifies the scalar,
.
- y
-
SYCL buffer or device-accessible USM pointer of size at least equal to the number of rows of the input matrix if opA == oneapi::mkl::transpose::nontrans and at least the number of columns of the input matrix otherwise.
- dependencies
-
A vector of type std::vector<sycl::event> containing the list of events that the oneapi::mkl::sparse::gemvdot routine depends on.
Output Parameters
- y
-
Overwritten by the updated vector
.
- d
-
Overwritten by the dot product of
and
.
Return Values
- sycl::event
-
SYCL event which can be waited upon or added as a dependency for the completion of the gemvdot routine.
Examples
An example of how to use oneapi::mkl::sparse::gemvdot with SYCL buffers can be found in the oneMKL installation directory, under:
share/doc/mkl/examples/sycl/sparse_blas/source/csr_gemvdot.cpp