oneapi::mkl::sparse::gemv
Computes a sparse matrix-dense vector product.
Description
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::gemv
routine computes a sparse matrix-dense vector product defined as
where
and
are scalars,
is a general sparse matrix of
dimensions
is a matrix modifier:



num_rows
rows and num_cols
columns and 

The dense vectors
and
are appropriately sized based on matrix product
dimensions of
.



API
Syntax
Currently, complex types are not supported.
Using SYCL buffers:
namespace oneapi::mkl::sparse {
void gemv (
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)
}
Using USM pointers:
namespace oneapi::mkl::sparse {
cl::sycl::event gemv (
cl::sycl::queue &queue,
oneapi::mkl::transpose transpose_flag,
const fp alpha,
oneapi::mkl::sparse::matrix_handle_t handle,
const fp *x,
fp beta,
fp *y,
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 operationop()on input matrix.oneapi::mkl::transpose::nontransNon-transpose,
.
oneapi::mkl::transpose::transTranspose,.
oneapi::mkl::transpose::conjtransConjugate transpose,.
Currently, the only supported case foroperationisoneapi::mkl::transpose::nontrans. - alpha
- Specifies the scalar,
.
- handle
- Handle to object containing sparse matrix and other internal data. Created using one of theoneapi::mkl::sparse::set_<sparse_matrix_type>_dataroutines.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 iftranspse_flag=oneapi::mkl::transpose::nontransand 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 iftranspose_flag=oneapi::mkl::transpose::nontransand at least the number of columns of the input matrix otherwise.
- dependencies
- A vector of typestd::vector<cl::sycl::event>containing the list of events that theoneapi::mkl::sparse::gemvroutine depends on.
Output Parameters
- y
- Overwritten by the updated vector
.
Return Values (USM Only)
- cl::sycl::event
- SYCL event which can be waited upon or added as a dependency for the completion of thegemvroutine.
Examples
An example of how to use
oneapi::mkl::sparse::gemv
with SYCL buffers
or USM pointers can be found in the oneMKL installation directory,
under:examples/dpcpp/sparse_blas/source/sparse_gemv.cpp
examples/dpcpp/sparse_blas/source/sparse_gemv_usm.cpp