derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
40 lines
2.3 KiB
ReStructuredText
40 lines
2.3 KiB
ReStructuredText
.. meta::
|
|
:description: An introduction to hipSPARSE and the API reference library
|
|
:keywords: hipSPARSE, rocSPARSE, ROCm, API, documentation, introduction
|
|
|
|
.. _hipsparse_intro:
|
|
|
|
********************************************************************
|
|
What is hipSPARSE
|
|
********************************************************************
|
|
|
|
hipSPARSE is a library that contains basic linear algebra subroutines for sparse matrices and vectors,
|
|
written in :doc:`HIP <hip:index>` for GPU devices.
|
|
It is designed to be called from C and C++ code.
|
|
|
|
hipSPARSE is a SPARSE marshalling library, with multiple supported backends.
|
|
It lies between the application and a "worker" SPARSE library,
|
|
marshalling inputs into the backend library and results back to the application.
|
|
hipSPARSE exports a common interface that does not require the client to change, regardless of the chosen backend.
|
|
It supports :doc:`rocSPARSE <rocsparse:index>` and NVIDIA CUDA cuSPARSE as backends.
|
|
|
|
The hipSPARSE functionality is organized into the following categories:
|
|
|
|
* :ref:`hipsparse_auxiliary_functions`: Available helper functions that are required for subsequent library calls.
|
|
* :ref:`hipsparse_level1_functions`: Operations between a vector in sparse format and a vector in dense format.
|
|
* :ref:`hipsparse_level2_functions`: Operations between a matrix in sparse format and a vector in dense format.
|
|
* :ref:`hipsparse_level3_functions`: Operations between a matrix in sparse format and multiple vectors in dense format.
|
|
* :ref:`hipsparse_extra_functions`: Operations that manipulate sparse matrices.
|
|
* :ref:`hipsparse_precond_functions`: Operations that manipulate a matrix in sparse format to obtain a preconditioner.
|
|
* :ref:`hipsparse_conversion_functions`: Operations on a matrix in sparse format to obtain a different matrix format.
|
|
* :ref:`hipsparse_reordering_functions`: Operations on a matrix in sparse format to obtain a reordering.
|
|
* :ref:`hipsparse_generic_functions`: Operations that manipulate sparse matrices.
|
|
|
|
The source code can be found at `<https://github.com/ROCm/rocm-libraries/tree/develop/projects/hipsparse>`_.
|
|
|
|
.. note::
|
|
|
|
hipSPARSE focuses on convenience and portability.
|
|
If performance outweighs these factors, it's better to use rocSPARSE directly.
|
|
The rocSPARSE source code can be found on the `rocSPARSE GitHub <https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocsparse>`_.
|