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
586 lines
12 KiB
ReStructuredText
586 lines
12 KiB
ReStructuredText
.. meta::
|
|
:description: hipSPARSE sparse auxiliary functions API documentation
|
|
:keywords: hipSPARSE, rocSPARSE, ROCm, API, documentation, auxiliary functions
|
|
|
|
.. _hipsparse_auxiliary_functions:
|
|
|
|
********************************************************************
|
|
Sparse auxiliary functions
|
|
********************************************************************
|
|
|
|
This module contains all sparse auxiliary functions.
|
|
|
|
The functions that are contained in the auxiliary module describe all available helper functions
|
|
that are required for subsequent library calls.
|
|
|
|
.. _hipsparse_create_handle_:
|
|
|
|
hipsparseCreate()
|
|
=================
|
|
|
|
.. doxygenfunction:: hipsparseCreate
|
|
|
|
.. _hipsparse_destroy_handle_:
|
|
|
|
hipsparseDestroy()
|
|
==================
|
|
|
|
.. doxygenfunction:: hipsparseDestroy
|
|
|
|
hipsparseGetErrorName()
|
|
=======================
|
|
|
|
.. doxygenfunction:: hipsparseGetErrorName
|
|
|
|
hipsparseGetErrorString()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseGetErrorString
|
|
|
|
hipsparseGetVersion()
|
|
=====================
|
|
|
|
.. doxygenfunction:: hipsparseGetVersion
|
|
|
|
hipsparseGetGitRevision()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseGetGitRevision
|
|
|
|
.. _hipsparse_set_stream_:
|
|
|
|
hipsparseSetStream()
|
|
====================
|
|
|
|
.. doxygenfunction:: hipsparseSetStream
|
|
|
|
hipsparseGetStream()
|
|
====================
|
|
|
|
.. doxygenfunction:: hipsparseGetStream
|
|
|
|
hipsparseSetPointerMode()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseSetPointerMode
|
|
|
|
hipsparseGetPointerMode()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseGetPointerMode
|
|
|
|
hipsparseCreateMatDescr()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateMatDescr
|
|
|
|
hipsparseDestroyMatDescr()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyMatDescr
|
|
|
|
hipsparseCopyMatDescr()
|
|
=======================
|
|
|
|
.. doxygenfunction:: hipsparseCopyMatDescr
|
|
|
|
hipsparseSetMatType()
|
|
=====================
|
|
|
|
.. doxygenfunction:: hipsparseSetMatType
|
|
|
|
hipsparseGetMatType()
|
|
=====================
|
|
|
|
.. doxygenfunction:: hipsparseGetMatType
|
|
|
|
hipsparseSetMatFillMode()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseSetMatFillMode
|
|
|
|
hipsparseGetMatFillMode()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseGetMatFillMode
|
|
|
|
hipsparseSetMatDiagType()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseSetMatDiagType
|
|
|
|
hipsparseGetMatDiagType()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseGetMatDiagType
|
|
|
|
hipsparseSetMatIndexBase()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseSetMatIndexBase
|
|
|
|
hipsparseGetMatIndexBase()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseGetMatIndexBase
|
|
|
|
hipsparseCreateHybMat()
|
|
=======================
|
|
|
|
.. doxygenfunction:: hipsparseCreateHybMat
|
|
|
|
hipsparseDestroyHybMat()
|
|
========================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyHybMat
|
|
|
|
hipsparseCreateBsrsv2Info()
|
|
===========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateBsrsv2Info
|
|
|
|
hipsparseDestroyBsrsv2Info()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyBsrsv2Info
|
|
|
|
hipsparseCreateBsrsm2Info()
|
|
===========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateBsrsm2Info
|
|
|
|
hipsparseDestroyBsrsm2Info()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyBsrsm2Info
|
|
|
|
hipsparseCreateBsrilu02Info()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseCreateBsrilu02Info
|
|
|
|
hipsparseDestroyBsrilu02Info()
|
|
==============================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyBsrilu02Info
|
|
|
|
hipsparseCreateBsric02Info()
|
|
============================
|
|
|
|
.. doxygenfunction:: hipsparseCreateBsric02Info
|
|
|
|
hipsparseDestroyBsric02Info()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyBsric02Info
|
|
|
|
hipsparseCreateCsrsv2Info()
|
|
===========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateCsrsv2Info
|
|
|
|
hipsparseDestroyCsrsv2Info()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyCsrsv2Info
|
|
|
|
hipsparseCreateCsrsm2Info()
|
|
===========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateCsrsm2Info
|
|
|
|
hipsparseDestroyCsrsm2Info()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyCsrsm2Info
|
|
|
|
hipsparseCreateCsrilu02Info()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseCreateCsrilu02Info
|
|
|
|
hipsparseDestroyCsrilu02Info()
|
|
==============================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyCsrilu02Info
|
|
|
|
hipsparseCreateCsric02Info()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseCreateCsric02Info
|
|
|
|
hipsparseDestroyCsric02Info()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyCsric02Info
|
|
|
|
hipsparseCreateCsru2csrInfo()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseCreateCsru2csrInfo
|
|
|
|
hipsparseDestroyCsru2csrInfo()
|
|
==============================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyCsru2csrInfo
|
|
|
|
hipsparseCreateColorInfo()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateColorInfo
|
|
|
|
hipsparseDestroyColorInfo()
|
|
===========================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyColorInfo
|
|
|
|
hipsparseCreateCsrgemm2Info()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseCreateCsrgemm2Info
|
|
|
|
hipsparseDestroyCsrgemm2Info()
|
|
==============================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyCsrgemm2Info
|
|
|
|
hipsparseCreatePruneInfo()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseCreatePruneInfo
|
|
|
|
hipsparseDestroyPruneInfo()
|
|
===========================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyPruneInfo
|
|
|
|
hipsparseCreateSpVec()
|
|
=======================
|
|
|
|
.. doxygenfunction:: hipsparseCreateSpVec
|
|
|
|
hipsparseCreateConstSpVec()
|
|
===========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateConstSpVec
|
|
|
|
hipsparseDestroySpVec()
|
|
=======================
|
|
|
|
.. doxygenfunction:: hipsparseDestroySpVec
|
|
|
|
hipsparseSpVecGet()
|
|
====================
|
|
|
|
.. doxygenfunction:: hipsparseSpVecGet
|
|
|
|
hipsparseConstSpVecGet()
|
|
========================
|
|
|
|
.. doxygenfunction:: hipsparseConstSpVecGet
|
|
|
|
hipsparseSpVecGetIndexBase()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseSpVecGetIndexBase
|
|
|
|
hipsparseSpVecGetValues()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseSpVecGetValues
|
|
|
|
hipsparseConstSpVecGetValues()
|
|
==============================
|
|
|
|
.. doxygenfunction:: hipsparseConstSpVecGetValues
|
|
|
|
hipsparseSpVecSetValues()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseSpVecSetValues
|
|
|
|
hipsparseCreateCoo()
|
|
====================
|
|
|
|
.. doxygenfunction:: hipsparseCreateCoo
|
|
|
|
hipsparseCreateConstCoo()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateConstCoo
|
|
|
|
hipsparseCreateCooAoS()
|
|
=======================
|
|
|
|
.. doxygenfunction:: hipsparseCreateCooAoS
|
|
|
|
hipsparseCreateCsr()
|
|
====================
|
|
|
|
.. doxygenfunction:: hipsparseCreateCsr
|
|
|
|
hipsparseCreateConstCsr()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateConstCsr
|
|
|
|
hipsparseCreateCsc()
|
|
====================
|
|
|
|
.. doxygenfunction:: hipsparseCreateCsc
|
|
|
|
hipsparseCreateConstCsc()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateConstCsc
|
|
|
|
hipsparseCreateBlockedEll()
|
|
===========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateBlockedEll
|
|
|
|
hipsparseCreateConstBlockedEll()
|
|
================================
|
|
|
|
.. doxygenfunction:: hipsparseCreateConstBlockedEll
|
|
|
|
hipsparseCreateSlicedEll()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateSlicedEll
|
|
|
|
hipsparseCreateConstSlicedEll()
|
|
===============================
|
|
|
|
.. doxygenfunction:: hipsparseCreateConstSlicedEll
|
|
|
|
hipsparseCreateBsr()
|
|
====================
|
|
|
|
.. doxygenfunction:: hipsparseCreateBsr
|
|
|
|
hipsparseCreateConstBsr()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateConstBsr
|
|
|
|
hipsparseDestroySpMat()
|
|
=======================
|
|
|
|
.. doxygenfunction:: hipsparseDestroySpMat
|
|
|
|
hipsparseCooGet()
|
|
=================
|
|
|
|
.. doxygenfunction:: hipsparseCooGet
|
|
|
|
hipsparseConstCooGet()
|
|
======================
|
|
|
|
.. doxygenfunction:: hipsparseConstCooGet
|
|
|
|
hipsparseCooAoSGet()
|
|
====================
|
|
|
|
.. doxygenfunction:: hipsparseCooAoSGet
|
|
|
|
hipsparseCsrGet()
|
|
=================
|
|
|
|
.. doxygenfunction:: hipsparseCsrGet
|
|
|
|
hipsparseConstCsrGet()
|
|
======================
|
|
|
|
.. doxygenfunction:: hipsparseConstCsrGet
|
|
|
|
hipsparseCscGet()
|
|
=================
|
|
|
|
.. doxygenfunction:: hipsparseCscGet
|
|
|
|
hipsparseConstCscGet()
|
|
======================
|
|
|
|
.. doxygenfunction:: hipsparseConstCscGet
|
|
|
|
hipsparseBlockedEllGet()
|
|
========================
|
|
|
|
.. doxygenfunction:: hipsparseBlockedEllGet
|
|
|
|
hipsparseConstBlockedEllGet()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseConstBlockedEllGet
|
|
|
|
hipsparseCsrSetPointers()
|
|
=========================
|
|
|
|
.. doxygenfunction:: hipsparseCsrSetPointers
|
|
|
|
hipsparseCscSetPointers()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseCscSetPointers
|
|
|
|
hipsparseCooSetPointers()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseCooSetPointers
|
|
|
|
hipsparseBlockedEllSetPointers()
|
|
================================
|
|
|
|
.. doxygenfunction:: hipsparseBlockedEllSetPointers
|
|
|
|
hipsparseSpMatGetSize()
|
|
=======================
|
|
|
|
.. doxygenfunction:: hipsparseSpMatGetSize
|
|
|
|
hipsparseSpMatGetFormat()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseSpMatGetFormat
|
|
|
|
hipsparseSpMatGetIndexBase()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseSpMatGetIndexBase
|
|
|
|
hipsparseSpMatGetValues()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseSpMatGetValues
|
|
|
|
hipsparseConstSpMatGetValues()
|
|
==============================
|
|
|
|
.. doxygenfunction:: hipsparseConstSpMatGetValues
|
|
|
|
hipsparseSpMatSetValues()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseSpMatSetValues
|
|
|
|
hipsparseSpMatGetStridedBatch()
|
|
===============================
|
|
|
|
.. doxygenfunction:: hipsparseSpMatGetStridedBatch
|
|
|
|
hipsparseSpMatSetStridedBatch()
|
|
===============================
|
|
|
|
.. doxygenfunction:: hipsparseSpMatSetStridedBatch
|
|
|
|
hipsparseCooSetStridedBatch()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseCooSetStridedBatch
|
|
|
|
hipsparseCsrSetStridedBatch()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseCsrSetStridedBatch
|
|
|
|
hipsparseSpMatGetAttribute()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseSpMatGetAttribute
|
|
|
|
hipsparseSpMatSetAttribute()
|
|
=============================
|
|
|
|
.. doxygenfunction:: hipsparseSpMatSetAttribute
|
|
|
|
hipsparseCreateDnVec()
|
|
=======================
|
|
|
|
.. doxygenfunction:: hipsparseCreateDnVec
|
|
|
|
hipsparseCreateConstDnVec()
|
|
===========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateConstDnVec
|
|
|
|
hipsparseDestroyDnVec()
|
|
=======================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyDnVec
|
|
|
|
hipsparseDnVecGet()
|
|
====================
|
|
|
|
.. doxygenfunction:: hipsparseDnVecGet
|
|
|
|
hipsparseConstDnVecGet()
|
|
========================
|
|
|
|
.. doxygenfunction:: hipsparseConstDnVecGet
|
|
|
|
hipsparseDnVecGetValues()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseDnVecGetValues
|
|
|
|
hipsparseConstDnVecGetValues()
|
|
==============================
|
|
|
|
.. doxygenfunction:: hipsparseConstDnVecGetValues
|
|
|
|
hipsparseDnVecSetValues()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseDnVecSetValues
|
|
|
|
hipsparseCreateDnMat()
|
|
=======================
|
|
|
|
.. doxygenfunction:: hipsparseCreateDnMat
|
|
|
|
hipsparseCreateConstDnMat()
|
|
===========================
|
|
|
|
.. doxygenfunction:: hipsparseCreateConstDnMat
|
|
|
|
hipsparseDestroyDnMat()
|
|
=======================
|
|
|
|
.. doxygenfunction:: hipsparseDestroyDnMat
|
|
|
|
hipsparseDnMatGet()
|
|
====================
|
|
|
|
.. doxygenfunction:: hipsparseDnMatGet
|
|
|
|
hipsparseConstDnMatGet()
|
|
========================
|
|
|
|
.. doxygenfunction:: hipsparseConstDnMatGet
|
|
|
|
hipsparseDnMatGetValues()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseDnMatGetValues
|
|
|
|
hipsparseConstDnMatGetValues()
|
|
==============================
|
|
|
|
.. doxygenfunction:: hipsparseConstDnMatGetValues
|
|
|
|
hipsparseDnMatSetValues()
|
|
==========================
|
|
|
|
.. doxygenfunction:: hipsparseDnMatSetValues
|
|
|
|
hipsparseDnMatGetStridedBatch()
|
|
===============================
|
|
|
|
.. doxygenfunction:: hipsparseDnMatGetStridedBatch
|
|
|
|
hipsparseDnMatSetStridedBatch()
|
|
===============================
|
|
|
|
.. doxygenfunction:: hipsparseDnMatSetStridedBatch
|