.. meta::
  :description: rocFFT documentation and API reference library
  :keywords: rocFFT, ROCm, API, documentation

.. _api-index:

********************************************
hipSPARSE API Reference Guide
********************************************

The *hipSPARSE API Reference Guide* presents an Index of hipSPARSE functions, datatypes, and details of the different hipSPARSE functions by category.  

  * :ref:`api`
  * :ref:`hipsparse-types`
  * :ref:`hipsparse_auxiliary_functions` required for subsequent library calls
  * :ref:`hipsparse_level1_functions` between a vector in sparse format and a vector in dense format
  * :ref:`hipsparse_level2_functions` between a matrix in sparse format and a vector in dense format
  * :ref:`hipsparse_level3_functions` between a matrix in sparse format and multiple vectors (matrix) in dense format
  * :ref:`hipsparse_extra_functions` for proposing linear algebra operations
  * :ref:`hipsparse_precond_functions` on a matrix in sparse format to obtain a preconditioner
  * :ref:`hipsparse_conversion_functions` to convert a matrix in sparse format to a different storage format
  * :ref:`hipsparse_reordering_functions` for reordering sparse matrices
  * :ref:`hipsparse_generic_functions` for manipulating sparse matrices 
