[oneMKL][spblas] Require same memory kind for alpha and beta paramete…

…rs (#556)
uxlfoundation · Sep 5, 2024 · 616f2e7 · 616f2e7
1 parent e453f5f
commit 616f2e7
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 9 deletions.
diff --git a/source/elements/oneMKL/source/domains/spblas/operations/spmm.rst b/source/elements/oneMKL/source/domains/spblas/operations/spmm.rst
@@ -297,8 +297,11 @@ spmm
 
    alpha
       Host or USM pointer representing :math:`\alpha`. The USM allocation can be
-      on the host or device. Must be a host pointer if SYCL buffers are used.
-      Must be of the same type than the handles' data type.
+      on the host or device. The requirements are:
+
+      * Must use the same kind of memory as ``beta``.
+      * Must be a host pointer if SYCL buffers are used.
+      * Must be of the same type as the handles' data type.
 
    A_view
       Specifies which part of the handle should be read as described by
@@ -312,8 +315,11 @@ spmm
 
    beta
       Host or USM pointer representing :math:`\beta`. The USM allocation can be
-      on the host or device. Must be a host pointer if SYCL buffers are used.
-      Must be of the same type than the handles' data type.
+      on the host or device. The requirements are:
+
+      * Must use the same kind of memory as ``alpha``.
+      * Must be a host pointer if SYCL buffers are used.
+      * Must be of the same type as the handles' data type.
 
    C_handle
       Dense matrix handle object representing :math:`C`.

diff --git a/source/elements/oneMKL/source/domains/spblas/operations/spmv.rst b/source/elements/oneMKL/source/domains/spblas/operations/spmv.rst
@@ -287,8 +287,11 @@ spmv
 
    alpha
       Host or USM pointer representing :math:`\alpha`. The USM allocation can be
-      on the host or device. Must be a host pointer if SYCL buffers are used.
-      Must be of the same type than the handles' data type.
+      on the host or device. The requirements are:
+
+      * Must use the same kind of memory as ``beta``.
+      * Must be a host pointer if SYCL buffers are used.
+      * Must be of the same type as the handles' data type.
 
    A_view
       Specifies which part of the handle should be read as described by
@@ -302,8 +305,11 @@ spmv
 
    beta
       Host or USM pointer representing :math:`\beta`. The USM allocation can be
-      on the host or device. Must be a host pointer if SYCL buffers are used.
-      Must be of the same type than the handles' data type.
+      on the host or device. The requirements are:
+
+      * Must use the same kind of memory as ``alpha``.
+      * Must be a host pointer if SYCL buffers are used.
+      * Must be of the same type as the handles' data type.
 
    y_handle
       Dense vector handle object representing :math:`y`.

diff --git a/source/elements/oneMKL/source/domains/spblas/operations/spsv.rst b/source/elements/oneMKL/source/domains/spblas/operations/spsv.rst
@@ -279,7 +279,7 @@ spsv
    alpha
       Host or USM pointer representing :math:`\alpha`. The USM allocation can be
       on the host or device. Must be a host pointer if SYCL buffers are used.
-      Must be of the same type than the handles' data type.
+      Must be of the same type as the handles' data type.
 
    A_view
       Specifies which part of the handle should be read as described by