diff --git a/source/elements/oneMKL/source/domains/spblas/trsv.rst b/source/elements/oneMKL/source/domains/spblas/trsv.rst index fe91e88f2d..b55b6e4dde 100644 --- a/source/elements/oneMKL/source/domains/spblas/trsv.rst +++ b/source/elements/oneMKL/source/domains/spblas/trsv.rst @@ -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: @@ -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 &x, sycl::buffer &y); @@ -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. @@ -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 @@ -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 &dependencies = {}); } @@ -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. @@ -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