Computes a sparse matrix-dense vector product over upper or lower triangular parts of the matrix.
Currently, complex types are not supported.
Using SYCL buffers:
void mkl::sparse::trmv (cl::sycl::queue & queue, mkl::uplo uplo_flag, mkl::transpose transpose_flag, mkl::diag diag_flag, fp alpha, matrix_handle_t handle, cl::sycl::buffer<fp, 1> & x, fp beta, cl::sycl::buffer<fp, 1> & y);
Using USM pointers:
cl::sycl::event mkl::sparse::trmv (cl::sycl::queue & queue, mkl::uplo uplo_flag, mkl::transpose transpose_flag, mkl::diag diag_flag, fp alpha, matrix_handle_t handle, fp *x, fp beta, fp *y, cl::sycl::vector_class<cl::sycl::event> &dependencies = {});
The mkl::sparse::trmv routine computes a sparse matrix-vector product over a triangular part defined as
y := alpha* (op)A*x + beta*y
where:
alpha and beta are scalars, and x and y are vectors.
Specifies the SYCL command queue which will be used for SYCL kernels execution.
Specifies which triangular matrix is to be processed.
mkl::uplo::lower | The lower triangular matrix part is processed. |
mkl::uplo::upper | The upper triangular matrix part is processed. |
Specifies operation op() on input matrix.
mkl::transpose::nontrans | Non-transpose, op(A) = A. |
mkl::transpose::trans | Transpose, op(A) = AT. |
mkl::transpose::conjtrans | Conjugate transpose, op(A) = AH. |
Currently, the only supported case for operation is mkl::transpose::nontrans.
Specifies if the input matrix has a unit diagonal or not.
mkl::diag::nonunit | Diagonal elements might not be equal to one. |
mkl::diag::unit | Diagonal elements are equal to one. |
Specifies the scalar alpha.
Handle to object containing sparse matrix and other internal data. Created using one of the mkl::sparse::set_ <sparse_matrix_type>_data routines.
Currently, the only supported case for <sparse_matrix_type> is csr.
SYCL or USM memory object containing an array of size at least equal to the number of columns of input matrix if op = mkl::transpose::nontrans and at least the number of rows of input matrix otherwise.
Specifies the scalar beta.
SYCL or USM memory object containing an array of size at least equal to the number of columns of input matrix if op = mkl::transpose::nontrans and at least the number of rows of input matrix otherwise.
A vector of type cl::sycl::vector_class<cl::sycl::event> containing the list of events that the mkl::sparse::trmv routine depends on.
Overwritten by the updated vector y.
SYCL event which can be waited upon or added as a dependency for the completion of the trmv routine.
An example of how to use mkl::sparse::trmv with SYCL buffers can be found in the Intel® oneMKL installation directory, under:
examples/sycl/spblas/sparse_trmv.cpp