Skip to content

Commit

Permalink
[oneMKL][SpBLAS] Update spec for oneapi::mkl::sparse::trsv() routine …
Browse files Browse the repository at this point in the history
…to add alpha parameter.
  • Loading branch information
baeseung-intel committed Feb 14, 2024
1 parent 34e67b9 commit ab76622
Showing 1 changed file with 21 additions and 11 deletions.
32 changes: 21 additions & 11 deletions source/elements/oneMKL/source/domains/spblas/trsv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ for a square matrix:

.. math::
\text{op}(A) y \leftarrow x
\text{op}(A) \cdot y \leftarrow \alpha \cdot x
where: ``A`` is a triangular sparse matrix of size ``m`` rows by
``m`` columns, op is a matrix modifier for matrix ``A``, ``x`` and ``y`` are dense vectors of length at least
``m``.
``m``, and :math:`\alpha` is a scalar value.

.. _onemkl_sparse_trsv_buffer:

Expand All @@ -37,9 +37,10 @@ trsv (Buffer version)
namespace oneapi::mkl::sparse {
void trsv (sycl::queue &queue,
oneapi::mkl::uplo uplo_val
oneapi::mkl::transpose transpose_val,
oneapi::mkl::diag diag_val
oneapi::mkl::uplo uplo_val,
oneapi::mkl::transpose opA,
oneapi::mkl::diag diag_val,
const fp alpha,
oneapi::mkl::sparse::matrix_handle_t A_handle,
sycl::buffer<fp, 1> &x,
sycl::buffer<fp, 1> &y);
Expand All @@ -62,7 +63,7 @@ trsv (Buffer version)
described in :ref:`onemkl_enum_uplo` enum class.


transpose_val
opA
Specifies operation ``op()`` on input matrix. The possible options
are described in :ref:`onemkl_enum_transpose` enum class.

Expand All @@ -72,6 +73,10 @@ trsv (Buffer version)
are described in :ref:`onemkl_enum_diag` enum class.


alpha
Specifies the scalar, :math:`\alpha`.


A_handle
Handle to object containing sparse matrix, :math:`A`. Created using
one of ``oneapi::mkl::sparse::set_csr_data`` or
Expand Down Expand Up @@ -121,12 +126,13 @@ trsv (USM version)
namespace oneapi::mkl::sparse {
sycl::event trsv (sycl::queue &queue,
oneapi::mkl::uplo uplo_val
oneapi::mkl::transpose transpose_val,
oneapi::mkl::diag diag_val
oneapi::mkl::uplo uplo_val,
oneapi::mkl::transpose opA,
oneapi::mkl::diag diag_val,
const fp alpha,
oneapi::mkl::sparse::matrix_handle_t A_handle,
const fp *x,
fp *y
fp *y,
const std::vector<sycl::event> &dependencies = {});
}
Expand All @@ -147,7 +153,7 @@ trsv (USM version)
described in :ref:`onemkl_enum_uplo` enum class.


transpose_val
opA
Specifies operation ``op()`` on input matrix. The possible options
are described in :ref:`onemkl_enum_transpose` enum class.

Expand All @@ -157,6 +163,10 @@ trsv (USM version)
are described in :ref:`onemkl_enum_diag` enum class.


alpha
Specifies the scalar, :math:`\alpha`.


A_handle
Handle to object containing sparse matrix, :math:`A`. Created using
one of ``oneapi::mkl::sparse::set_csr_data`` or
Expand Down

0 comments on commit ab76622

Please sign in to comment.