oneapi::mkl::sparse::gemvdot¶
Computes a sparse matrix-dense vector product with dot product.
Description¶
Note
Refer to Supported Types for a list of supported <fp>
and
<intType>
and refer to Exceptions for a detailed description of
the exceptions thrown.
The oneapi::mkl::sparse::gemvdot
routine computes a sparse matrix-dense vector product
and dot product defined as
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:
API¶
Syntax¶
Note
Currently, complex types are not supported.
Using SYCL buffers:
namespace oneapi::mkl::sparse {
void gemvdot (
cl::sycl::queue &queue,
oneapi::mkl::transpose transpose_flag,
const fp alpha,
oneapi::mkl::sparse::matrix_handle_t handle,
cl::sycl::buffer<fp, 1> &x,
const fp beta,
cl::sycl::buffer<fp, 1> &y,
cl::sycl::buffer<fp, 1> &d)
}
Using USM pointers:
namespace oneapi::mkl::sparse {
cl::sycl::event gemvdot (
cl::sycl::queue &queue,
oneapi::mkl::transpose transpose_flag,
const fp alpha,
oneapi::mkl::sparse::matrix_handle_t handle,
fp *x,
const fp beta,
fp *y,
fp *d,
const std::vector<cl::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.
- transpose_flag
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\).
- handle
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
Currently, the only supported case for
<sparse_matrix_type>
is csr.- x
SYCL buffer or device-accessible USM pointer of size at least equal to the number of columns of input matrix if
transpose_flag
==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
transpose_flag
==oneapi::mkl::transpose::nontrans
and at least the number of columns of the input matrix otherwise.- dependencies
A vector of type
std::vector<cl::sycl::event>
containing the list of events that theoneapi::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¶
cl::sycl::event
SYCL event which can be waited upon or added as a dependency for the completion of the
gemvdot
routine.