onemkl::sparse::trsv¶

Solves a system of linear equations for a triangular sparse matrix.

Syntax

Note

Currently, complex types are not supported.

Using SYCL buffers:

void onemkl::sparse::trsv(cl::sycl::queue &queue, onemkl::uplo uplo_val, onemkl::transpose transpose_val, onemkl::diag diag_val, matrixHandle_t handle, cl::sycl::buffer<fp, 1> &x, cl::sycl::buffer<fp, 1> &y)¶

Using USM pointers:

void onemkl::sparse::trsv(cl::sycl::queue &queue, onemkl::uplo uplo_val, onemkl::transpose transpose_val, onemkl::diag diag_val, matrixHandle_t handle, fp *x, fp *y)¶

Include Files

mkl_spblas_sycl.hpp

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 onemkl::sparse::trsv routine solves a system of linear equations for a square matrix:

op(A)*y =  x

where A is a triangular sparse matrix of size m rows by m columns, op is a matrix modifier for matrix A, alpha is a scalar, and x and y are vectors of length at least m.

Input Parameters

queue

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

uplo_val

Specifies if the input matrix is an upper triangular or a lower triangular matrix.

onemkl::uplo::lower	The lower triangular matrix part is processed.
onemkl::uplo::upper	The upper triangular matrix part is processed.

transpose_val

Specifies operation op() on input matrix.

onemkl::transpose::nontrans	Non-transpose, `op(A)` = `A`.
onemkl::transpose::trans	Transpose, `op(A)` = `A`^T.
onemkl::transpose::conjtrans	Conjugate transpose, `op(A)` = `A`^H.

Note

Currently, the only supported case for operation is onemkl::transpose::nontrans.

diag_val

Specifies if the input matrix has a unit diagonal or not.

onemkl::diag::nonunit	Diagonal elements might not be equal to one.
onemkl::diag::unit	Diagonal elements are equal to one.

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 if op = onemkl::transpose::nontrans and at least the number of rows of input matrix otherwise. It is the input vector x

y

SYCL or USM memory object containing an array of size at least equal to the number of columns of input matrix if op = onemkl::transpose::nontrans and at least the number of rows of input matrix otherwise.

Output Parameters

y: SYCL or USM memory object containing an array of size at least nRows filled with the solution to the system of linear equations.

Parent topic: Sparse BLAS Routines