Update documentation

_sources/domains/sparse_linear_algebra.rst

@@ -0,0 +1,40 @@
+.. _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>`_.
+
+This page documents implementation specific or backend specific details of the
+sparse domain.
+
+OneMKL Intel CPU and GPU backends
+---------------------------------
+
+Currently known limitations:
+
+- All operations' algorithms except ``no_optimize_alg`` map to the default
+  algorithm.
+- The required external workspace size is always 0 bytes.
+- ``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 ``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.
+- Using ``spmm`` on Intel GPU 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 ``spmv`` with a sparse matrix that is
+  ``oneapi::mkl::transpose::conjtrans`` with a ``type_view``
+  ``matrix_descr::symmetric`` or ``matrix_descr::hermitian`` will throw an
+  ``oneapi::mkl::unimplemented`` exception.
+- Using ``spsv`` on Intel GPU with a sparse matrix that is
+  ``oneapi::mkl::transpose::conjtrans`` and will throw an
+  ``oneapi::mkl::unimplemented`` exception.
+- Scalar parameters ``alpha`` and ``beta`` should be host pointers to prevent
+  synchronizations and copies to the host.

_sources/index.rst

@@ -33,4 +33,5 @@ Contents
 
    onemkl-datatypes.rst
    domains/dense_linear_algebra.rst
+   domains/sparse_linear_algebra.rst
    create_new_backend.rst

building_and_running_tests.html

@@ -327,6 +327,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="domains/sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

building_the_project_with_adaptivecpp.html

@@ -327,6 +327,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="domains/sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

building_the_project_with_dpcpp.html

@@ -327,6 +327,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="domains/sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

create_new_backend.html

@@ -44,7 +44,7 @@
     <link rel="icon" href="_static/favicons.png"/>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="ungqr_batch_scratchpad_size" href="domains/lapack/ungqr_batch_scratchpad_size.html" />
+    <link rel="prev" title="Sparse Linear Algebra" href="domains/sparse_linear_algebra.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>
@@ -326,6 +326,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="domains/sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 
@@ -977,12 +978,12 @@ <h2> Contents </h2>
 
 <div class="prev-next-area">
     <a class="left-prev"
-       href="domains/lapack/ungqr_batch_scratchpad_size.html"
+       href="domains/sparse_linear_algebra.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
         <p class="prev-next-subtitle">previous</p>
-        <p class="prev-next-title">ungqr_batch_scratchpad_size</p>
+        <p class="prev-next-title">Sparse Linear Algebra</p>
       </div>
     </a>
 </div>

domains/blas/asum.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/axpby.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/axpy.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/axpy_batch.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/blas-level-1-routines.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/blas-level-2-routines.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/blas-level-3-routines.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/blas-like-extensions.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/blas.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/copy.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/copy_batch.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/dgmm_batch.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/dot.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/dotc.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/dotu.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/gbmv.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/gemm.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/gemm_batch.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/gemm_bias.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/gemmt.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/gemv.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/gemv_batch.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/ger.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/gerc.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/geru.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/hbmv.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/hemm.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/hemv.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/her.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/her2.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/her2k.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/herk.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/hpmv.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/hpr.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/hpr2.html

@@ -328,6 +328,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/iamax.html

@@ -327,6 +327,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>
 

domains/blas/iamin.html

@@ -327,6 +327,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../sparse_linear_algebra.html">Sparse Linear Algebra</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../create_new_backend.html">Integrating a Third-Party Library to oneAPI Math Kernel Library (oneMKL) Interfaces</a></li>
 </ul>