onemkl::sparse::symv

Computes a sparse matrix-vector product for a symmetric matrix.

Syntax

Note

Currently, complex types are not supported.

Using SYCL buffers:

void onemkl::sparse::symv(cl::sycl::queue &queue, onemkl::uplo uplo_val, fp alpha, matrixHandle_t handle, cl::sycl::buffer<fp, 1> &x, fp beta, cl::sycl::buffer<fp, 1> &y)

Using USM pointers:

void onemkl::sparse::symv(cl::sycl::queue &queue, onemkl::uplo uplo_val, fp alpha, matrixHandle_t handle, fp *x, fp beta, fp *y)

Include Files

• mkl_spblas_sycl.hpp

Description

Note

Refer to Exceptions for a detailed description of the exceptions thrown. The onemkl::sparse::symv routine computes a sparse matrix-vector product over a symmetric part defined as

y := alpha*A*x + beta*y

where:

alpha and beta are scalars, andx and y are vectors.

Input Parameters

queue

Specifies the SYCL command queue which will be used for SYCL kernels execution.

uplo_val

Specifies which symmetric part is to be processed.

onemkl::uplo::lower	The lower symmetric part is processed.
onemkl::uplo::upper	The upper symmetric part is processed.

alpha

Specifies the scalar alpha.

handle

Handle to object containing sparse matrix and other internal data. Created using one of the onemkl::sparse::set<sparse_matrix_type>structure routines.

Note

Currently, the only supported case for <sparse_matrix_type> is CSR.

x

SYCL or USM memory object containing an array of size at least equal to the number of columns of input matrix.

beta

Specifies the scalar beta.

y

SYCL or USM memory object containing an array of size at least equal to the number of columns of input matrix.

Output Parameters

y

Overwritten by the updated vector y.

Example

An example of how to use onemkl::sparse::symv with SYCL buffers or USM can be found in the oneMKL installation directory, under:

examples/sycl/spblas/sparse_symv_l.cpp

examples/sycl/spblas/sparse_symv_l_usm.cpp

Parent topic: Sparse BLAS Routines