oneapi::mkl::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 oneapi::mkl::sparse::trsv (cl::sycl::queue & queue,
oneapi::mkl::uplo uplo_flag,
oneapi::mkl::transpose transpose_flag,
oneapi::mkl::diag diag_flag,
oneapi::mkl::sparse::matrix_handle_t handle,
cl::sycl::buffer<fp, 1> & x,
cl::sycl::buffer<fp, 1> & y)
Using USM pointers:
cl::sycl::event oneapi::mkl::sparse::trsv (cl::sycl::queue & queue,
oneapi::mkl::uplo uplo_flag,
oneapi::mkl::transpose transpose_flag,
oneapi::mkl::diag diag_flag,
oneapi::mkl::sparse::matrix_handle_t handle,
fp *x,
fp *y,
const cl::sycl::vector_class<cl::sycl::event> &dependencies = {})
Include Files
oneapi/mkl/spblas.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 oneapi::mkl::sparse::trmv
routine computes a sparse
matrix-dense vector product over a triangular part defined as
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 dense vectors of length at least
m
.
Input Parameters
- queue
Specifies the SYCL command queue which will be used for SYCL kernels execution.
- uplo_flag
Specifies which part of the matrix is to be processed.
oneapi::mkl::uplo::lower
The lower triangular matrix part is processed.
oneapi::mkl::uplo::upper
The upper triangular matrix part is processed.
- transpose_flag
Specifies operation
op()
on input matrix.oneapi::mkl::transpose::nontrans
Non-transpose,
op(A)
=A
.oneapi::mkl::transpose::trans
Transpose,
op(A)
=A
T.oneapi::mkl::transpose::conjtrans
Conjugate transpose,
op(A)
=A
H.
Note
Currently, the only supported case for operation is
oneapi::mkl::transpose::nontrans
.
- diag_flag
Specifies if the diagonal used for computations is unit or not.
oneapi::mkl::diag::nonunit
Diagonal elements might not be equal to one.
oneapi::mkl::diag::unit
Diagonal elements are equal to one.
- 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 or USM memory object containing an array of size at least equal to the number of columns of input matrix if
op
=oneapi::mkl::transpose::nontrans
and at least the number of rows of input matrix otherwise. It is the input vectorx
- y
SYCL or USM memory object containing an array of size at least equal to the number of rows of the input matrix if
op
=oneapi::mkl::transpose::nontrans
and at least the number of columns of the input matrix otherwise.- dependencies
A vector of type
cl::sycl::vector_class<cl::sycl::event>
containing the list of events that theoneapi::mkl::sparse::trsv
routine depends on.
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.
Return Values (USM Only)
- cl::sycl::event
SYCL event which can be waited upon or added as a dependency for the completion of the trsv routine.
Example
An example of how to use oneapi::mkl::sparse::trsv with SYCL buffers or USM can be found in the Intel® oneMKL installation directory, under:
examples/dpcpp/sparse_blas/source/sparse_trsv.cpp
examples/dpcpp/sparse_blas/source/sparse_trsv_usm.cpp