Update documentation

_sources/domains/sparse_linear_algebra.rst

@@ -1,11 +1,29 @@
 .. _onemkl_sparse_linear_algebra:
 
 Sparse Linear Algebra
----------------------
+=====================
 
-See the latest specification for the sparse domain here: https://oneapi-spec.uxlfoundation.org/specifications/oneapi/latest/elements/onemkl/source/domains/spblas/spblas
+See the latest specification for the sparse domain `here
+<https://oneapi-spec.uxlfoundation.org/specifications/oneapi/latest/elements/onemkl/source/domains/spblas/spblas>`_.
 
 This page documents implementation specific or backend specific details.
 
 OneMKL Intel CPU and GPU backends
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------------
+
+Known limitations as of Intel oneMKL product release 2024.1:
+
+  - All operations' algorithms except `no_optimize_alg` map to the default
+    algorithm.
+  - `oneapi::mkl::sparse::set_csr_data` and `oneapi::mkl::sparse::set_coo_data`
+    functions cannot be used on a handle that has already been used for an
+    operation or its optimize function. Doing so will throw an
+    `oneapi::mkl::unimplemented` exception.
+  - Using `spmm` with a sparse matrix that is
+    `oneapi::mkl::transpose::conjtrans` and has the
+    `oneapi::mkl::sparse::matrix_property::symmetric` property will throw an
+    `oneapi::mkl::unimplemented` exception.
+  - Using `spsv` with the `oneapi::mkl::sparse::spsv_alg::no_optimize_alg` and a
+    sparse matrix that does not have the
+    `oneapi::mkl::sparse::matrix_property::sorted` property will throw an
+    `oneapi::mkl::unimplemented` exception.

domains/sparse_linear_algebra.html

@@ -535,10 +535,29 @@ <h2> Contents </h2>
 
   <section id="sparse-linear-algebra">
 <span id="onemkl-sparse-linear-algebra"></span><h1>Sparse Linear Algebra<a class="headerlink" href="#sparse-linear-algebra" title="Link to this heading">#</a></h1>
-<p>See the latest specification for the sparse domain here: <a class="reference external" href="https://oneapi-spec.uxlfoundation.org/specifications/oneapi/latest/elements/onemkl/source/domains/spblas/spblas">https://oneapi-spec.uxlfoundation.org/specifications/oneapi/latest/elements/onemkl/source/domains/spblas/spblas</a></p>
+<p>See the latest specification for the sparse domain <a class="reference external" href="https://oneapi-spec.uxlfoundation.org/specifications/oneapi/latest/elements/onemkl/source/domains/spblas/spblas">here</a>.</p>
 <p>This page documents implementation specific or backend specific details.</p>
 <section id="onemkl-intel-cpu-and-gpu-backends">
 <h2>OneMKL Intel CPU and GPU backends<a class="headerlink" href="#onemkl-intel-cpu-and-gpu-backends" title="Link to this heading">#</a></h2>
+<p>Known limitations as of Intel oneMKL product release 2024.1:</p>
+<blockquote>
+<div><ul class="simple">
+<li><p>All operations’ algorithms except <cite>no_optimize_alg</cite> map to the default
+algorithm.</p></li>
+<li><p><cite>oneapi::mkl::sparse::set_csr_data</cite> and <cite>oneapi::mkl::sparse::set_coo_data</cite>
+functions cannot be used on a handle that has already been used for an
+operation or its optimize function. Doing so will throw an
+<cite>oneapi::mkl::unimplemented</cite> exception.</p></li>
+<li><p>Using <cite>spmm</cite> with a sparse matrix that is
+<cite>oneapi::mkl::transpose::conjtrans</cite> and has the
+<cite>oneapi::mkl::sparse::matrix_property::symmetric</cite> property will throw an
+<cite>oneapi::mkl::unimplemented</cite> exception.</p></li>
+<li><p>Using <cite>spsv</cite> with the <cite>oneapi::mkl::sparse::spsv_alg::no_optimize_alg</cite> and a
+sparse matrix that does not have the
+<cite>oneapi::mkl::sparse::matrix_property::sorted</cite> property will throw an
+<cite>oneapi::mkl::unimplemented</cite> exception.</p></li>
+</ul>
+</div></blockquote>
 </section>
 </section>