.. _SparseMatrix:

############
SparseMatrix
############


We provide a simple class that handles the local tensor products that are added to the :ref:`Operator class<Operator>`.
The :ref:`SparseMatrix class<SparseMatrix>` only provides a minimal amount of functionality as all linear algebra routines should be executed by `LAPACK <https://de.wikipedia.org/wiki/LAPACK>`_ libraries like `MKL <https://www.intel.com/content/www/us/en/developer/tools/oneapi/onemkl.html>`_ or :ref:`Petsc/Slepc<Petsc_setup>` if you want to exploit the sparsity of an :ref:`operator<Operator>`.
The class does **neither** support :ref:`openMP<openMP_docs>` nor :ref:`MPI<MPI_docs>`.

It only contains three data members, :ref:`dim<SparseMatrix_dim>`, :ref:`range<SparseMatrix_range>`, and :ref:`data<SparseMatrix_data>`, that provide full access to the matrix in the following way:

.. code-block:: cpp

	for(uint64_t i = 0UL; i < dim; i++){
	    for(uint64_t j = range[i]; j < range[i+1]; j++){
	        std::cout << "Element at (" << i << "," << data[j].first << "): " << data[j].second;
        }
    }


Class content
-------------

.. toctree::
    :maxdepth: 2
    :titlesonly:


    SparseMatrix/Members.rst
    SparseMatrix/Constructors.rst
    SparseMatrix/Functions.rst
    SparseMatrix/Autodocs.rst