.. meta::
  :description: Introduction to the rocSPARSE API reference library
  :keywords: rocSPARSE, ROCm, API, documentation

.. _api-index:

********************************************
rocSPARSE API reference guide
********************************************

The rocSPARSE API Reference Guide presents an index of the rocSPARSE functions and data types, including function details, by category.

* :ref:`api`
* :ref:`rocsparse_types_`
* :ref:`rocsparse_enumerations_`
* :ref:`rocsparse_auxiliary_functions_` required for subsequent library calls
* :ref:`rocsparse_level1_functions_` between a vector in sparse format and a vector in dense format
* :ref:`rocsparse_level2_functions_` between a matrix in sparse format and a vector in dense format
* :ref:`rocsparse_level3_functions_` between a matrix in sparse format and multiple vectors (matrix) in dense format
* :ref:`rocsparse_extra_functions_` for additional linear algebra operations
* :ref:`rocsparse_precond_functions_` on a matrix in sparse format to obtain a preconditioner
* :ref:`rocsparse_conversion_functions_` to convert a matrix in sparse format to a different storage format
* :ref:`rocsparse_reordering_functions_` for reordering sparse matrices
* :ref:`rocsparse_utility_functions_` for checking sparse matrices for valid data
* :ref:`rocsparse_generic_functions_` for manipulating sparse matrices
* :ref:`reproducibility`

It also includes a discussion of the :doc:`precision support <./data_type_support>` for the various rocSPARSE functions.