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
\[y \leftarrow \alpha\cdot\text{op}(A)\cdot x + \beta\cdot y\]
\[d \leftarrow x \cdot y\]
where \(A\) is a general sparse matrix, \(\alpha\), \(\beta\), and \(d\) are scalars, \(x\) and \(y\) are dense vectors and \(op()\) is a matrix modifier:
\[\begin{split}\text{op}(A) = \begin{cases} A,& \text{ oneapi::mkl::transpose::nontrans}\\ A^{T},& \text{ oneapi::mkl::transpose::trans}\\A^{H},& \text{ oneapi::mkl::transpose::conjtrans} \end{cases}\end{split}\]
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,
const 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, \(\text{op}(A) = A\).
oneapi::mkl::transpose::trans
Transpose, \(\text{op}(A) = A^{T}\).
oneapi::mkl::transpose::conjtrans
Conjugate transpose, \(\text{op}(A) = A^{H}\).
NOTE:Currently, the only supported case for operation is oneapi::mkl::transpose::nontrans. - alpha
-
Specifies the scalar, \(\alpha\).
- 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.
Formats Supported in sparse::gemvdot()
Compressed Sparse Row (CSR) format on CPU/GPU
Coordinate (COO) format on CPU only
- 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, \(\beta\).
- 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 \(y\).
- d
-
Overwritten by the dot product of \(x\) and \(y\).
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