hipSPARSE Documentation#
hipSPARSE exposes a common interface that provides Basic Linear Algebra Subroutines for sparse computation implemented on top of the AMD ROCm runtime and toolchains. hipSPARSE is created using the HIP programming language and optimized for AMD’s latest discrete GPUs.
In the following, three separate chapters are available:
User Manual: This is the manual of hipSPARSE. It can be seen as a starting guide for new users but also a reference book for more experienced developers.
API: This is a list of API functions provided by hipSPARSE.
- User Manual
- Introduction
- Building and Installing
- Device and Stream Management
- Storage Formats
- Exported Sparse Functions
- Types
- hipsparseHandle_t
- hipsparseMatDescr_t
- hipsparseHybMat_t
- hipsparseColorInfo_t
- bsrsv2Info_t
- bsrsm2Info_t
- bsrilu02Info_t
- bsric02Info_t
- csrsv2Info_t
- csrsm2Info_t
- csrilu02Info_t
- csric02Info_t
- csrgemm2Info_t
- pruneInfo_t
- csru2csrInfo_t
- hipsparseSpVecDescr_t
- hipsparseSpMatDescr_t
- hipsparseDnVecDescr_t
- hipsparseDnMatDescr_t
- hipsparseSpGEMMDescr_t
- hipsparseSpSVDescr_t
- hipsparseSpSMDescr_t
- hipsparseStatus_t
- hipsparsePointerMode_t
- hipsparseAction_t
- hipsparseMatrixType_t
- hipsparseFillMode_t
- hipsparseDiagType_t
- hipsparseIndexBase_t
- hipsparseOperation_t
- hipsparseHybPartition_t
- hipsparseSolvePolicy_t
- hipsparseDirection_t
- hipsparseFormat_t
- hipsparseOrder_t
- hipsparseIndextype_t
- hipsparseCsr2CscAlg_t
- hipsparseSpMVAlg_t
- hipsparseSpMMAlg_t
- hipsparseSparseToDenseAlg_t
- hipsparseDenseToSparseAlg_t
- hipsparseSDDMMAlg_t
- hipsparseSpSVAlg_t
- hipsparseSpSMAlg_t
- hipsparseSpMatAttribute_t
- hipsparseSpGEMMAlg_t
- Sparse Auxiliary Functions
- hipsparseCreate()
- hipsparseDestroy()
- hipsparseGetVersion()
- hipsparseGetGitRevision()
- hipsparseSetStream()
- hipsparseGetStream()
- hipsparseSetPointerMode()
- hipsparseGetPointerMode()
- hipsparseCreateMatDescr()
- hipsparseDestroyMatDescr()
- hipsparseCopyMatDescr()
- hipsparseSetMatType()
- hipsparseGetMatType()
- hipsparseSetMatFillMode()
- hipsparseGetMatFillMode()
- hipsparseSetMatDiagType()
- hipsparseGetMatDiagType()
- hipsparseSetMatIndexBase()
- hipsparseGetMatIndexBase()
- hipsparseCreateHybMat()
- hipsparseDestroyHybMat()
- hipsparseCreateBsrsv2Info()
- hipsparseDestroyBsrsv2Info()
- hipsparseCreateBsrsm2Info()
- hipsparseDestroyBsrsm2Info()
- hipsparseCreateBsrilu02Info()
- hipsparseDestroyBsrilu02Info()
- hipsparseCreateBsric02Info()
- hipsparseDestroyBsric02Info()
- hipsparseCreateCsrsv2Info()
- hipsparseDestroyCsrsv2Info()
- hipsparseCreateCsrsm2Info()
- hipsparseDestroyCsrsm2Info()
- hipsparseCreateCsrilu02Info()
- hipsparseDestroyCsrilu02Info()
- hipsparseCreateCsric02Info()
- hipsparseDestroyCsric02Info()
- hipsparseCreateCsru2csrInfo()
- hipsparseDestroyCsru2csrInfo()
- hipsparseCreateColorInfo()
- hipsparseDestroyColorInfo()
- hipsparseCreateCsrgemm2Info()
- hipsparseDestroyCsrgemm2Info()
- hipsparseCreatePruneInfo()
- hipsparseDestroyPruneInfo()
- hipsparseCreateSpVec()
- hipsparseDestroySpVec()
- hipsparseSpVecGet()
- hipsparseSpVecGetIndexBase()
- hipsparseSpVecGetValues()
- hipsparseSpVecSetValues()
- hipsparseCreateCoo()
- hipsparseCreateCooAoS()
- hipsparseCreateCsr()
- hipsparseCreateCsc()
- hipsparseCreateBlockedEll()
- hipsparseDestroySpMat()
- hipsparseCooGet()
- hipsparseCooAoSGet()
- hipsparseCsrGet()
- hipsparseBlockedEllGet()
- hipsparseCsrSetPointers()
- hipsparseCscSetPointers()
- hipsparseCooSetPointers()
- hipsparseSpMatGetSize()
- hipsparseSpMatGetFormat()
- hipsparseSpMatGetIndexBase()
- hipsparseSpMatGetValues()
- hipsparseSpMatSetValues()
- hipsparseSpMatGetAttribute()
- hipsparseSpMatSetAttribute()
- hipsparseCreateDnVec()
- hipsparseDestroyDnVec()
- hipsparseDnVecGet()
- hipsparseDnVecGetValues()
- hipsparseDnVecSetValues()
- hipsparseCreateDnMat()
- hipsparseDestroyDnMat()
- hipsparseDnMatGet()
- hipsparseDnMatGetValues()
- hipsparseDnMatSetValues()
- Sparse Level 1 Functions
- Sparse Level 2 Functions
- hipsparseXcsrmv()
- hipsparseXcsrsv2_zeroPivot()
- hipsparseXcsrsv2_bufferSize()
- hipsparseXcsrsv2_bufferSizeExt()
- hipsparseXcsrsv2_analysis()
- hipsparseXcsrsv2_solve()
- hipsparseXhybmv()
- hipsparseXbsrmv()
- hipsparseXbsrxmv()
- hipsparseXbsrsv2_zeroPivot()
- hipsparseXbsrsv2_bufferSize()
- hipsparseXbsrsv2_bufferSizeExt()
- hipsparseXbsrsv2_analysis()
- hipsparseXbsrsv2_solve()
- hipsparseXgemvi_bufferSize()
- hipsparseXgemvi()
- Sparse Level 3 Functions
- Sparse Extra Functions
- Preconditioner Functions
- hipsparseXbsrilu02_zeroPivot()
- hipsparseXbsrilu02_numericBoost()
- hipsparseXbsrilu02_bufferSize()
- hipsparseXbsrilu02_analysis()
- hipsparseXbsrilu02()
- hipsparseXcsrilu02_zeroPivot()
- hipsparseXcsrilu02_numericBoost()
- hipsparseXcsrilu02_bufferSize()
- hipsparseXcsrilu02_bufferSizeExt()
- hipsparseXcsrilu02_analysis()
- hipsparseXcsrilu02()
- hipsparseXbsric02_zeroPivot()
- hipsparseXbsric02_bufferSize()
- hipsparseXbsric02_analysis()
- hipsparseXbsric02()
- hipsparseXcsric02_zeroPivot()
- hipsparseXcsric02_bufferSize()
- hipsparseXcsric02_bufferSizeExt()
- hipsparseXcsric02_analysis()
- hipsparseXcsric02()
- hipsparseXgtsv2_bufferSizeExt()
- hipsparseXgtsv2()
- hipsparseXgtsv2_nopivot_bufferSizeExt()
- hipsparseXgtsv2_nopivot()
- hipsparseXgtsv2StridedBatch_bufferSizeExt()
- hipsparseXgtsv2StridedBatch()
- hipsparseXgtsvInterleavedBatch_bufferSizeExt()
- hipsparseXgtsvInterleavedBatch()
- hipsparseXgpsvInterleavedBatch_bufferSizeExt()
- hipsparseXgpsvInterleavedBatch()
- Sparse Conversion Functions
- hipsparseXnnz()
- hipsparseXdense2csr()
- hipsparseXpruneDense2csr_bufferSize()
- hipsparseXpruneDense2csrNnz()
- hipsparseXpruneDense2csr()
- hipsparseXpruneDense2csrByPercentage_bufferSize()
- hipsparseXpruneDense2csrByPercentage_bufferSizeExt()
- hipsparseXpruneDense2csrNnzByPercentage()
- hipsparseXpruneDense2csrByPercentage()
- hipsparseXdense2csc()
- hipsparseXcsr2dense()
- hipsparseXcsc2dense()
- hipsparseXcsr2bsrNnz()
- hipsparseXcsr2bsr()
- hipsparseXnnz_compress()
- hipsparseXcsr2coo()
- hipsparseXcsr2csc()
- hipsparseXcsr2cscEx2_bufferSize()
- hipsparseXcsr2cscEx2()
- hipsparseXcsr2hyb()
- hipsparseXgebsr2gebsc_bufferSize()
- hipsparseXgebsr2gebsc()
- hipsparseXcsr2gebsr_bufferSize()
- hipsparseXcsr2gebsrNnz()
- hipsparseXcsr2gebsr()
- hipsparseXbsr2csr()
- hipsparseXgebsr2csr()
- hipsparseXcsr2csr_compress()
- hipsparseXpruneCsr2csr_bufferSize()
- hipsparseXpruneCsr2csr_bufferSizeExt()
- hipsparseXpruneCsr2csrNnz()
- hipsparseXpruneCsr2csr()
- hipsparseXpruneCsr2csrByPercentage_bufferSize()
- hipsparseXpruneCsr2csrByPercentage_bufferSizeExt()
- hipsparseXpruneCsr2csrNnzByPercentage()
- hipsparseXpruneCsr2csrByPercentage()
- hipsparseXhyb2csr()
- hipsparseXcoo2csr()
- hipsparseCreateIdentityPermutation()
- hipsparseXcsrsort_bufferSizeExt()
- hipsparseXcsrsort()
- hipsparseXcscsort_bufferSizeExt()
- hipsparseXcscsort()
- hipsparseXcoosort_bufferSizeExt()
- hipsparseXcoosortByRow()
- hipsparseXcoosortByColumn()
- hipsparseXgebsr2gebsr_bufferSize()
- hipsparseXgebsr2gebsrNnz()
- hipsparseXgebsr2gebsr()
- hipsparseXcsru2csr_bufferSizeExt()
- hipsparseXcsru2csr()
- hipsparseXcsr2csru()
- Sparse Reordering Functions
- Sparse Generic Functions
- hipsparseAxpby()
- hipsparseGather()
- hipsparseScatter()
- hipsparseRot()
- hipsparseSparseToDense_bufferSize()
- hipsparseSparseToDense()
- hipsparseDenseToSparse_bufferSize()
- hipsparseDenseToSparse_analysis()
- hipsparseDenseToSparse_convert()
- hipsparseSpVV_bufferSize()
- hipsparseSpVV()
- hipsparseSpMV_bufferSize()
- hipsparseSpMV()
- hipsparseSpMM_bufferSize()
- hipsparseSpMM_preprocess()
- hipsparseSpMM()
- hipsparseSpGEMM_createDescr()
- hipsparseSpGEMM_destroyDescr()
- hipsparseSpGEMM_workEstimation()
- hipsparseSpGEMM_compute()
- hipsparseSpGEMM_copy()
- hipsparseSDDMM_bufferSize()
- hipsparseSDDMM_preprocess()
- hipsparseSDDMM()
- hipsparseSpSV_createDescr()
- hipsparseSpSV_destroyDescr()
- hipsparseSpSV_bufferSize()
- hipsparseSpSV_analysis()
- hipsparseSpSV_solve()
- hipsparseSpSM_createDescr()
- hipsparseSpSM_destroyDescr()
- hipsparseSpSM_bufferSize()
- hipsparseSpSM_analysis()
- hipsparseSpSM_solve()