Files
TheRock/rocm-libraries/projects/rocsparse/docs/reference/precond.rst
T
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
Flatten subprojects into a single base monorepo
2026-09-02 16:34:47 -07:00

394 lines
10 KiB
ReStructuredText

.. meta::
:description: rocSPARSE preconditioner functions API documentation
:keywords: rocSPARSE, ROCm, API, documentation, preconditioner functions
.. _rocsparse_precond_functions_:
********************************************************************
Sparse preconditioner functions
********************************************************************
This module contains all sparse preconditioners.
The sparse preconditioners describe manipulations on a matrix in sparse format to obtain a sparse preconditioner matrix.
rocsparse_bsric0_zero_pivot()
-----------------------------
.. doxygenfunction:: rocsparse_bsric0_zero_pivot
rocsparse_bsric0_buffer_size()
------------------------------
.. doxygenfunction:: rocsparse_sbsric0_buffer_size
:outline:
.. doxygenfunction:: rocsparse_dbsric0_buffer_size
:outline:
.. doxygenfunction:: rocsparse_cbsric0_buffer_size
:outline:
.. doxygenfunction:: rocsparse_zbsric0_buffer_size
rocsparse_bsric0_analysis()
---------------------------
.. doxygenfunction:: rocsparse_sbsric0_analysis
:outline:
.. doxygenfunction:: rocsparse_dbsric0_analysis
:outline:
.. doxygenfunction:: rocsparse_cbsric0_analysis
:outline:
.. doxygenfunction:: rocsparse_zbsric0_analysis
rocsparse_bsric0()
------------------
.. doxygenfunction:: rocsparse_sbsric0
:outline:
.. doxygenfunction:: rocsparse_dbsric0
:outline:
.. doxygenfunction:: rocsparse_cbsric0
:outline:
.. doxygenfunction:: rocsparse_zbsric0
rocsparse_bsric0_clear()
------------------------
.. doxygenfunction:: rocsparse_bsric0_clear
rocsparse_bsrilu0_zero_pivot()
------------------------------
.. doxygenfunction:: rocsparse_bsrilu0_zero_pivot
rocsparse_bsrilu0_numeric_boost()
---------------------------------
.. doxygenfunction:: rocsparse_sbsrilu0_numeric_boost
:outline:
.. doxygenfunction:: rocsparse_dbsrilu0_numeric_boost
:outline:
.. doxygenfunction:: rocsparse_cbsrilu0_numeric_boost
:outline:
.. doxygenfunction:: rocsparse_zbsrilu0_numeric_boost
rocsparse_bsrilu0_buffer_size()
-------------------------------
.. doxygenfunction:: rocsparse_sbsrilu0_buffer_size
:outline:
.. doxygenfunction:: rocsparse_dbsrilu0_buffer_size
:outline:
.. doxygenfunction:: rocsparse_cbsrilu0_buffer_size
:outline:
.. doxygenfunction:: rocsparse_zbsrilu0_buffer_size
rocsparse_bsrilu0_analysis()
----------------------------
.. doxygenfunction:: rocsparse_sbsrilu0_analysis
:outline:
.. doxygenfunction:: rocsparse_dbsrilu0_analysis
:outline:
.. doxygenfunction:: rocsparse_cbsrilu0_analysis
:outline:
.. doxygenfunction:: rocsparse_zbsrilu0_analysis
rocsparse_bsrilu0()
-------------------
.. doxygenfunction:: rocsparse_sbsrilu0
:outline:
.. doxygenfunction:: rocsparse_dbsrilu0
:outline:
.. doxygenfunction:: rocsparse_cbsrilu0
:outline:
.. doxygenfunction:: rocsparse_zbsrilu0
rocsparse_bsrilu0_clear()
-------------------------
.. doxygenfunction:: rocsparse_bsrilu0_clear
rocsparse_csric0_zero_pivot()
-----------------------------
.. doxygenfunction:: rocsparse_csric0_zero_pivot
rocsparse_csric0_singular_pivot()
---------------------------------
.. doxygenfunction:: rocsparse_csric0_singular_pivot
rocsparse_csric0_set_tolerance()
--------------------------------
.. doxygenfunction:: rocsparse_csric0_set_tolerance
rocsparse_csric0_get_tolerance()
--------------------------------
.. doxygenfunction:: rocsparse_csric0_get_tolerance
rocsparse_csric0_buffer_size()
------------------------------
.. doxygenfunction:: rocsparse_scsric0_buffer_size
:outline:
.. doxygenfunction:: rocsparse_dcsric0_buffer_size
:outline:
.. doxygenfunction:: rocsparse_ccsric0_buffer_size
:outline:
.. doxygenfunction:: rocsparse_zcsric0_buffer_size
rocsparse_csric0_analysis()
---------------------------
.. doxygenfunction:: rocsparse_scsric0_analysis
:outline:
.. doxygenfunction:: rocsparse_dcsric0_analysis
:outline:
.. doxygenfunction:: rocsparse_ccsric0_analysis
:outline:
.. doxygenfunction:: rocsparse_zcsric0_analysis
rocsparse_csric0()
------------------
.. doxygenfunction:: rocsparse_scsric0
:outline:
.. doxygenfunction:: rocsparse_dcsric0
:outline:
.. doxygenfunction:: rocsparse_ccsric0
:outline:
.. doxygenfunction:: rocsparse_zcsric0
rocsparse_csric0_clear()
------------------------
.. doxygenfunction:: rocsparse_csric0_clear
rocsparse_csritilu0_buffer_size()
---------------------------------
.. doxygenfunction:: rocsparse_csritilu0_buffer_size
rocsparse_csritilu0_preprocess()
--------------------------------
.. doxygenfunction:: rocsparse_csritilu0_preprocess
rocsparse_csritilu0_history()
-----------------------------
.. doxygenfunction:: rocsparse_scsritilu0_history
:outline:
.. doxygenfunction:: rocsparse_dcsritilu0_history
:outline:
.. doxygenfunction:: rocsparse_ccsritilu0_history
:outline:
.. doxygenfunction:: rocsparse_zcsritilu0_history
rocsparse_csritilu0_compute()
-----------------------------
.. doxygenfunction:: rocsparse_scsritilu0_compute
:outline:
.. doxygenfunction:: rocsparse_dcsritilu0_compute
:outline:
.. doxygenfunction:: rocsparse_ccsritilu0_compute
:outline:
.. doxygenfunction:: rocsparse_zcsritilu0_compute
rocsparse_csritilu0_compute_ex()
--------------------------------
.. doxygenfunction:: rocsparse_scsritilu0_compute_ex
:outline:
.. doxygenfunction:: rocsparse_dcsritilu0_compute_ex
:outline:
.. doxygenfunction:: rocsparse_ccsritilu0_compute_ex
:outline:
.. doxygenfunction:: rocsparse_zcsritilu0_compute_ex
rocsparse_csrilu0_zero_pivot()
------------------------------
.. doxygenfunction:: rocsparse_csrilu0_zero_pivot
rocsparse_csrilu0_singular_pivot()
----------------------------------
.. doxygenfunction:: rocsparse_csrilu0_singular_pivot
rocsparse_csrilu0_set_tolerance()
---------------------------------
.. doxygenfunction:: rocsparse_csrilu0_set_tolerance
rocsparse_csrilu0_get_tolerance()
---------------------------------
.. doxygenfunction:: rocsparse_csrilu0_get_tolerance
rocsparse_csrilu0_numeric_boost()
---------------------------------
.. doxygenfunction:: rocsparse_scsrilu0_numeric_boost
:outline:
.. doxygenfunction:: rocsparse_dcsrilu0_numeric_boost
:outline:
.. doxygenfunction:: rocsparse_ccsrilu0_numeric_boost
:outline:
.. doxygenfunction:: rocsparse_zcsrilu0_numeric_boost
rocsparse_csrilu0_buffer_size()
-------------------------------
.. doxygenfunction:: rocsparse_scsrilu0_buffer_size
:outline:
.. doxygenfunction:: rocsparse_dcsrilu0_buffer_size
:outline:
.. doxygenfunction:: rocsparse_ccsrilu0_buffer_size
:outline:
.. doxygenfunction:: rocsparse_zcsrilu0_buffer_size
rocsparse_csrilu0_analysis()
----------------------------
.. doxygenfunction:: rocsparse_scsrilu0_analysis
:outline:
.. doxygenfunction:: rocsparse_dcsrilu0_analysis
:outline:
.. doxygenfunction:: rocsparse_ccsrilu0_analysis
:outline:
.. doxygenfunction:: rocsparse_zcsrilu0_analysis
rocsparse_csrilu0()
-------------------
.. doxygenfunction:: rocsparse_scsrilu0
:outline:
.. doxygenfunction:: rocsparse_dcsrilu0
:outline:
.. doxygenfunction:: rocsparse_ccsrilu0
:outline:
.. doxygenfunction:: rocsparse_zcsrilu0
rocsparse_csrilu0_clear()
-------------------------
.. doxygenfunction:: rocsparse_csrilu0_clear
rocsparse_gtsv_buffer_size()
----------------------------
.. doxygenfunction:: rocsparse_sgtsv_buffer_size
:outline:
.. doxygenfunction:: rocsparse_dgtsv_buffer_size
:outline:
.. doxygenfunction:: rocsparse_cgtsv_buffer_size
:outline:
.. doxygenfunction:: rocsparse_zgtsv_buffer_size
rocsparse_gtsv()
----------------
.. doxygenfunction:: rocsparse_sgtsv
:outline:
.. doxygenfunction:: rocsparse_dgtsv
:outline:
.. doxygenfunction:: rocsparse_cgtsv
:outline:
.. doxygenfunction:: rocsparse_zgtsv
rocsparse_gtsv_no_pivot_buffer_size()
-------------------------------------
.. doxygenfunction:: rocsparse_sgtsv_no_pivot_buffer_size
:outline:
.. doxygenfunction:: rocsparse_dgtsv_no_pivot_buffer_size
:outline:
.. doxygenfunction:: rocsparse_cgtsv_no_pivot_buffer_size
:outline:
.. doxygenfunction:: rocsparse_zgtsv_no_pivot_buffer_size
rocsparse_gtsv_no_pivot()
-------------------------
.. doxygenfunction:: rocsparse_sgtsv_no_pivot
:outline:
.. doxygenfunction:: rocsparse_dgtsv_no_pivot
:outline:
.. doxygenfunction:: rocsparse_cgtsv_no_pivot
:outline:
.. doxygenfunction:: rocsparse_zgtsv_no_pivot
rocsparse_gtsv_no_pivot_strided_batch_buffer_size()
---------------------------------------------------
.. doxygenfunction:: rocsparse_sgtsv_no_pivot_strided_batch_buffer_size
:outline:
.. doxygenfunction:: rocsparse_dgtsv_no_pivot_strided_batch_buffer_size
:outline:
.. doxygenfunction:: rocsparse_cgtsv_no_pivot_strided_batch_buffer_size
:outline:
.. doxygenfunction:: rocsparse_zgtsv_no_pivot_strided_batch_buffer_size
rocsparse_gtsv_no_pivot_strided_batch()
---------------------------------------
.. doxygenfunction:: rocsparse_sgtsv_no_pivot_strided_batch
:outline:
.. doxygenfunction:: rocsparse_dgtsv_no_pivot_strided_batch
:outline:
.. doxygenfunction:: rocsparse_cgtsv_no_pivot_strided_batch
:outline:
.. doxygenfunction:: rocsparse_zgtsv_no_pivot_strided_batch
rocsparse_gtsv_interleaved_batch_buffer_size()
----------------------------------------------
.. doxygenfunction:: rocsparse_sgtsv_interleaved_batch_buffer_size
:outline:
.. doxygenfunction:: rocsparse_dgtsv_interleaved_batch_buffer_size
:outline:
.. doxygenfunction:: rocsparse_cgtsv_interleaved_batch_buffer_size
:outline:
.. doxygenfunction:: rocsparse_zgtsv_interleaved_batch_buffer_size
rocsparse_gtsv_interleaved_batch()
----------------------------------
.. doxygenfunction:: rocsparse_sgtsv_interleaved_batch
:outline:
.. doxygenfunction:: rocsparse_dgtsv_interleaved_batch
:outline:
.. doxygenfunction:: rocsparse_cgtsv_interleaved_batch
:outline:
.. doxygenfunction:: rocsparse_zgtsv_interleaved_batch
rocsparse_gpsv_interleaved_batch_buffer_size()
----------------------------------------------
.. doxygenfunction:: rocsparse_sgpsv_interleaved_batch_buffer_size
:outline:
.. doxygenfunction:: rocsparse_dgpsv_interleaved_batch_buffer_size
:outline:
.. doxygenfunction:: rocsparse_cgpsv_interleaved_batch_buffer_size
:outline:
.. doxygenfunction:: rocsparse_zgpsv_interleaved_batch_buffer_size
rocsparse_gpsv_interleaved_batch()
----------------------------------
.. doxygenfunction:: rocsparse_sgpsv_interleaved_batch
:outline:
.. doxygenfunction:: rocsparse_dgpsv_interleaved_batch
:outline:
.. doxygenfunction:: rocsparse_cgpsv_interleaved_batch
:outline:
.. doxygenfunction:: rocsparse_zgpsv_interleaved_batch