.. meta:: :description: Documentation for exported hipSPARSE API functions :keywords: hipSPARSE, rocSPARSE, ROCm, API, documentation, exported functions .. _api: ******************************************************************** Exported hipSPARSE functions ******************************************************************** This topic provides a list of the exported hipSPARSE functions in various categories. Auxiliary functions =================== +------------------------------------------+ |Function name | +------------------------------------------+ |:cpp:func:`hipsparseCreate` | +------------------------------------------+ |:cpp:func:`hipsparseDestroy` | +------------------------------------------+ |:cpp:func:`hipsparseGetErrorName` | +------------------------------------------+ |:cpp:func:`hipsparseGetErrorString` | +------------------------------------------+ |:cpp:func:`hipsparseGetVersion` | +------------------------------------------+ |:cpp:func:`hipsparseGetGitRevision` | +------------------------------------------+ |:cpp:func:`hipsparseSetStream` | +------------------------------------------+ |:cpp:func:`hipsparseGetStream` | +------------------------------------------+ |:cpp:func:`hipsparseSetPointerMode` | +------------------------------------------+ |:cpp:func:`hipsparseGetPointerMode` | +------------------------------------------+ |:cpp:func:`hipsparseCreateMatDescr` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyMatDescr` | +------------------------------------------+ |:cpp:func:`hipsparseCopyMatDescr` | +------------------------------------------+ |:cpp:func:`hipsparseSetMatType` | +------------------------------------------+ |:cpp:func:`hipsparseGetMatType` | +------------------------------------------+ |:cpp:func:`hipsparseSetMatFillMode` | +------------------------------------------+ |:cpp:func:`hipsparseGetMatFillMode` | +------------------------------------------+ |:cpp:func:`hipsparseSetMatDiagType` | +------------------------------------------+ |:cpp:func:`hipsparseGetMatDiagType` | +------------------------------------------+ |:cpp:func:`hipsparseSetMatIndexBase` | +------------------------------------------+ |:cpp:func:`hipsparseGetMatIndexBase` | +------------------------------------------+ |:cpp:func:`hipsparseCreateHybMat` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyHybMat` | +------------------------------------------+ |:cpp:func:`hipsparseCreateBsrsv2Info` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyBsrsv2Info` | +------------------------------------------+ |:cpp:func:`hipsparseCreateBsrsm2Info` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyBsrsm2Info` | +------------------------------------------+ |:cpp:func:`hipsparseCreateBsrilu02Info` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyBsrilu02Info` | +------------------------------------------+ |:cpp:func:`hipsparseCreateBsric02Info` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyBsric02Info` | +------------------------------------------+ |:cpp:func:`hipsparseCreateCsrsv2Info` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyCsrsv2Info` | +------------------------------------------+ |:cpp:func:`hipsparseCreateCsrsm2Info` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyCsrsm2Info` | +------------------------------------------+ |:cpp:func:`hipsparseCreateCsrilu02Info` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyCsrilu02Info` | +------------------------------------------+ |:cpp:func:`hipsparseCreateCsric02Info` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyCsric02Info` | +------------------------------------------+ |:cpp:func:`hipsparseCreateCsru2csrInfo` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyCsru2csrInfo` | +------------------------------------------+ |:cpp:func:`hipsparseCreateColorInfo` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyColorInfo` | +------------------------------------------+ |:cpp:func:`hipsparseCreateCsrgemm2Info` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyCsrgemm2Info` | +------------------------------------------+ |:cpp:func:`hipsparseCreatePruneInfo` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyPruneInfo` | +------------------------------------------+ |:cpp:func:`hipsparseCreateSpVec` | +------------------------------------------+ |:cpp:func:`hipsparseCreateConstSpVec` | +------------------------------------------+ |:cpp:func:`hipsparseDestroySpVec` | +------------------------------------------+ |:cpp:func:`hipsparseSpVecGet` | +------------------------------------------+ |:cpp:func:`hipsparseConstSpVecGet` | +------------------------------------------+ |:cpp:func:`hipsparseSpVecGetIndexBase` | +------------------------------------------+ |:cpp:func:`hipsparseSpVecGetValues` | +------------------------------------------+ |:cpp:func:`hipsparseConstSpVecGetValues` | +------------------------------------------+ |:cpp:func:`hipsparseSpVecSetValues` | +------------------------------------------+ |:cpp:func:`hipsparseCreateCoo` | +------------------------------------------+ |:cpp:func:`hipsparseCreateConstCoo` | +------------------------------------------+ |:cpp:func:`hipsparseCreateCooAoS` | +------------------------------------------+ |:cpp:func:`hipsparseCreateCsr` | +------------------------------------------+ |:cpp:func:`hipsparseCreateConstCsr` | +------------------------------------------+ |:cpp:func:`hipsparseCreateCsc` | +------------------------------------------+ |:cpp:func:`hipsparseCreateConstCsc` | +------------------------------------------+ |:cpp:func:`hipsparseCreateBlockedEll` | +------------------------------------------+ |:cpp:func:`hipsparseCreateConstBlockedEll`| +------------------------------------------+ |:cpp:func:`hipsparseCreateSlicedEll` | +------------------------------------------+ |:cpp:func:`hipsparseCreateConstSlicedEll` | +------------------------------------------+ |:cpp:func:`hipsparseCreateBsr` | +------------------------------------------+ |:cpp:func:`hipsparseCreateConstBsr` | +------------------------------------------+ |:cpp:func:`hipsparseDestroySpMat` | +------------------------------------------+ |:cpp:func:`hipsparseCooGet` | +------------------------------------------+ |:cpp:func:`hipsparseConstCooGet` | +------------------------------------------+ |:cpp:func:`hipsparseCooAoSGet` | +------------------------------------------+ |:cpp:func:`hipsparseCsrGet` | +------------------------------------------+ |:cpp:func:`hipsparseConstCsrGet` | +------------------------------------------+ |:cpp:func:`hipsparseCscGet` | +------------------------------------------+ |:cpp:func:`hipsparseConstCscGet` | +------------------------------------------+ |:cpp:func:`hipsparseBlockedEllGet` | +------------------------------------------+ |:cpp:func:`hipsparseConstBlockedEllGet` | +------------------------------------------+ |:cpp:func:`hipsparseCsrSetPointers` | +------------------------------------------+ |:cpp:func:`hipsparseCscSetPointers` | +------------------------------------------+ |:cpp:func:`hipsparseCooSetPointers` | +------------------------------------------+ |:cpp:func:`hipsparseBlockedEllSetPointers`| +------------------------------------------+ |:cpp:func:`hipsparseSpMatGetSize` | +------------------------------------------+ |:cpp:func:`hipsparseSpMatGetFormat` | +------------------------------------------+ |:cpp:func:`hipsparseSpMatGetIndexBase` | +------------------------------------------+ |:cpp:func:`hipsparseSpMatGetValues` | +------------------------------------------+ |:cpp:func:`hipsparseConstSpMatGetValues` | +------------------------------------------+ |:cpp:func:`hipsparseSpMatSetValues` | +------------------------------------------+ |:cpp:func:`hipsparseSpMatGetStridedBatch` | +------------------------------------------+ |:cpp:func:`hipsparseSpMatSetStridedBatch` | +------------------------------------------+ |:cpp:func:`hipsparseCooSetStridedBatch` | +------------------------------------------+ |:cpp:func:`hipsparseCsrSetStridedBatch` | +------------------------------------------+ |:cpp:func:`hipsparseSpMatGetAttribute` | +------------------------------------------+ |:cpp:func:`hipsparseSpMatSetAttribute` | +------------------------------------------+ |:cpp:func:`hipsparseCreateDnVec` | +------------------------------------------+ |:cpp:func:`hipsparseCreateConstDnVec` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyDnVec` | +------------------------------------------+ |:cpp:func:`hipsparseDnVecGet` | +------------------------------------------+ |:cpp:func:`hipsparseConstDnVecGet` | +------------------------------------------+ |:cpp:func:`hipsparseDnVecGetValues` | +------------------------------------------+ |:cpp:func:`hipsparseConstDnVecGetValues` | +------------------------------------------+ |:cpp:func:`hipsparseDnVecSetValues` | +------------------------------------------+ |:cpp:func:`hipsparseCreateDnMat` | +------------------------------------------+ |:cpp:func:`hipsparseCreateConstDnMat` | +------------------------------------------+ |:cpp:func:`hipsparseDestroyDnMat` | +------------------------------------------+ |:cpp:func:`hipsparseDnMatGet` | +------------------------------------------+ |:cpp:func:`hipsparseConstDnMatGet` | +------------------------------------------+ |:cpp:func:`hipsparseDnMatGetValues` | +------------------------------------------+ |:cpp:func:`hipsparseConstDnMatGetValues` | +------------------------------------------+ |:cpp:func:`hipsparseDnMatSetValues` | +------------------------------------------+ |:cpp:func:`hipsparseDnMatGetStridedBatch` | +------------------------------------------+ |:cpp:func:`hipsparseDnMatSetStridedBatch` | +------------------------------------------+ Sparse level 1 functions ======================== ================================================ ====== ====== ============== ============== Function name single double single complex double complex ================================================ ====== ====== ============== ============== :cpp:func:`hipsparseXaxpyi() ` x x x x :cpp:func:`hipsparseXdoti() ` x x x x :cpp:func:`hipsparseXdotci() ` x x :cpp:func:`hipsparseXgthr() ` x x x x :cpp:func:`hipsparseXgthrz() ` x x x x :cpp:func:`hipsparseXroti() ` x x :cpp:func:`hipsparseXsctr() ` x x x x ================================================ ====== ====== ============== ============== Sparse level 2 functions ======================== ============================================================================== ====== ====== ============== ============== Function name single double single complex double complex ============================================================================== ====== ====== ============== ============== :cpp:func:`hipsparseXcsrmv() ` x x x x :cpp:func:`hipsparseXcsrsv2_zeroPivot` :cpp:func:`hipsparseXcsrsv2_bufferSize() ` x x x x :cpp:func:`hipsparseXcsrsv2_bufferSizeExt() ` x x x x :cpp:func:`hipsparseXcsrsv2_analysis() ` x x x x :cpp:func:`hipsparseXcsrsv2_solve() ` x x x x :cpp:func:`hipsparseXhybmv() ` x x x x :cpp:func:`hipsparseXbsrmv() ` x x x x :cpp:func:`hipsparseXbsrxmv() ` x x x x :cpp:func:`hipsparseXbsrsv2_zeroPivot` :cpp:func:`hipsparseXbsrsv2_bufferSize() ` x x x x :cpp:func:`hipsparseXbsrsv2_bufferSizeExt() ` x x x x :cpp:func:`hipsparseXbsrsv2_analysis() ` x x x x :cpp:func:`hipsparseXbsrsv2_solve() ` x x x x :cpp:func:`hipsparseXgemvi_bufferSize() ` x x x x :cpp:func:`hipsparseXgemvi() ` x x x x ============================================================================== ====== ====== ============== ============== Sparse level 3 functions ======================== ============================================================================= ====== ====== ============== ============== Function name single double single complex double complex ============================================================================= ====== ====== ============== ============== :cpp:func:`hipsparseXbsrmm() ` x x x x :cpp:func:`hipsparseXcsrmm() ` x x x x :cpp:func:`hipsparseXcsrmm2() ` x x x x :cpp:func:`hipsparseXbsrsm2_zeroPivot` :cpp:func:`hipsparseXbsrsm2_bufferSize() ` x x x x :cpp:func:`hipsparseXbsrsm2_analysis() ` x x x x :cpp:func:`hipsparseXbsrsm2_solve() ` x x x x :cpp:func:`hipsparseXcsrsm2_zeroPivot` :cpp:func:`hipsparseXcsrsm2_bufferSizeExt() ` x x x x :cpp:func:`hipsparseXcsrsm2_analysis() ` x x x x :cpp:func:`hipsparseXcsrsm2_solve() ` x x x x :cpp:func:`hipsparseXgemmi() ` x x x x ============================================================================= ====== ====== ============== ============== Sparse extra functions ====================== ================================================================================== ====== ====== ============== ============== Function name single double single complex double complex ================================================================================== ====== ====== ============== ============== :cpp:func:`hipsparseXcsrgeamNnz()` :cpp:func:`hipsparseXcsrgeam() ` x x x x :cpp:func:`hipsparseXcsrgeam2_bufferSizeExt() ` x x x x :cpp:func:`hipsparseXcsrgeam2Nnz()` :cpp:func:`hipsparseXcsrgeam2() ` x x x x :cpp:func:`hipsparseXcsrgemmNnz` :cpp:func:`hipsparseXcsrgemm() ` x x x x :cpp:func:`hipsparseXcsrgemm2_bufferSizeExt() ` x x x x :cpp:func:`hipsparseXcsrgemm2Nnz` :cpp:func:`hipsparseXcsrgemm2() ` x x x x ================================================================================== ====== ====== ============== ============== Preconditioner functions ======================== ===================================================================================================================== ====== ====== ============== ============== Function name single double single complex double complex ===================================================================================================================== ====== ====== ============== ============== :cpp:func:`hipsparseXbsrilu02_zeroPivot` :cpp:func:`hipsparseXbsrilu02_numericBoost() ` x x x x :cpp:func:`hipsparseXbsrilu02_bufferSize() ` x x x x :cpp:func:`hipsparseXbsrilu02_analysis() ` x x x x :cpp:func:`hipsparseXbsrilu02() ` x x x x :cpp:func:`hipsparseXcsrilu02_zeroPivot` :cpp:func:`hipsparseXcsrilu02_numericBoost() ` x x x x :cpp:func:`hipsparseXcsrilu02_bufferSize() ` x x x x :cpp:func:`hipsparseXcsrilu02_bufferSizeExt() ` x x x x :cpp:func:`hipsparseXcsrilu02_analysis() ` x x x x :cpp:func:`hipsparseXcsrilu02() ` x x x x :cpp:func:`hipsparseXbsric02_zeroPivot` :cpp:func:`hipsparseXbsric02_bufferSize() ` x x x x :cpp:func:`hipsparseXbsric02_analysis() ` x x x x :cpp:func:`hipsparseXbsric02() ` x x x x :cpp:func:`hipsparseXcsric02_zeroPivot` :cpp:func:`hipsparseXcsric02_bufferSize() ` x x x x :cpp:func:`hipsparseXcsric02_bufferSizeExt() ` x x x x :cpp:func:`hipsparseXcsric02_analysis() ` x x x x :cpp:func:`hipsparseXcsric02() ` x x x x :cpp:func:`hipsparseXgtsv2_bufferSizeExt() ` x x x x :cpp:func:`hipsparseXgtsv2() ` x x x x :cpp:func:`hipsparseXgtsv2_nopivot_bufferSizeExt() ` x x x x :cpp:func:`hipsparseXgtsv2_nopivot() ` x x x x :cpp:func:`hipsparseXgtsv2StridedBatch_bufferSizeExt() ` x x x x :cpp:func:`hipsparseXgtsv2StridedBatch() ` x x x x :cpp:func:`hipsparseXgtsvInterleavedBatch_bufferSizeExt() ` x x x x :cpp:func:`hipsparseXgtsvInterleavedBatch() ` x x x x :cpp:func:`hipsparseXgpsvInterleavedBatch_bufferSizeExt() ` x x x x :cpp:func:`hipsparseXgpsvInterleavedBatch() ` x x x x ===================================================================================================================== ====== ====== ============== ============== Conversion functions ==================== ====================================================================================================================== ====== ====== ============== ============== Function name single double single complex double complex ====================================================================================================================== ====== ====== ============== ============== :cpp:func:`hipsparseXnnz() ` x x x x :cpp:func:`hipsparseXdense2csr() ` x x x x :cpp:func:`hipsparseXpruneDense2csr_bufferSize() ` x x :cpp:func:`hipsparseXpruneDense2csr_bufferSizeExt() ` x x :cpp:func:`hipsparseXpruneDense2csrNnz() ` x x :cpp:func:`hipsparseXpruneDense2csr() ` x x :cpp:func:`hipsparseXpruneDense2csrByPercentage_bufferSize() ` x x :cpp:func:`hipsparseXpruneDense2csrByPercentage_bufferSizeExt() ` x x :cpp:func:`hipsparseXpruneDense2csrNnzByPercentage() ` x x :cpp:func:`hipsparseXpruneDense2csrByPercentage() ` x x :cpp:func:`hipsparseXdense2csc() ` x x x x :cpp:func:`hipsparseXcsr2dense() ` x x x x :cpp:func:`hipsparseXcsc2dense() ` x x x x :cpp:func:`hipsparseXcsr2bsrNnz` :cpp:func:`hipsparseXcsr2bsr() ` x x x x :cpp:func:`hipsparseXnnz_compress() ` x x x x :cpp:func:`hipsparseXcsr2coo` :cpp:func:`hipsparseXcsr2csc() ` x x x x :cpp:func:`hipsparseXcsr2hyb() ` x x x x :cpp:func:`hipsparseXgebsr2gebsc_bufferSize ` x x x x :cpp:func:`hipsparseXgebsr2gebsc() ` x x x x :cpp:func:`hipsparseXcsr2gebsr_bufferSize() ` x x x x :cpp:func:`hipsparseXcsr2gebsrNnz` :cpp:func:`hipsparseXcsr2gebsr() ` x x x x :cpp:func:`hipsparseXbsr2csr() ` x x x x :cpp:func:`hipsparseXgebsr2csr() ` x x x x :cpp:func:`hipsparseXcsr2csr_compress() ` x x x x :cpp:func:`hipsparseXpruneCsr2csr_bufferSize() ` x x :cpp:func:`hipsparseXpruneCsr2csr_bufferSizeExt() ` x x :cpp:func:`hipsparseXpruneCsr2csrNnz() ` x x :cpp:func:`hipsparseXpruneCsr2csr() ` x x :cpp:func:`hipsparseXpruneCsr2csrByPercentage_bufferSize() ` x x :cpp:func:`hipsparseXpruneCsr2csrByPercentage_bufferSizeExt() ` x x :cpp:func:`hipsparseXpruneCsr2csrNnzByPercentage() ` x x :cpp:func:`hipsparseXpruneCsr2csrByPercentage() ` x x :cpp:func:`hipsparseXhyb2csr() ` x x x x :cpp:func:`hipsparseXcoo2csr` :cpp:func:`hipsparseCreateIdentityPermutation` :cpp:func:`hipsparseXcsrsort_bufferSizeExt` :cpp:func:`hipsparseXcsrsort` :cpp:func:`hipsparseXcscsort_bufferSizeExt` :cpp:func:`hipsparseXcscsort` :cpp:func:`hipsparseXcoosort_bufferSizeExt` :cpp:func:`hipsparseXcoosortByRow` :cpp:func:`hipsparseXcoosortByColumn` :cpp:func:`hipsparseXgebsr2gebsr_bufferSize() ` x x x x :cpp:func:`hipsparseXgebsr2gebsrNnz()` :cpp:func:`hipsparseXgebsr2gebsr() ` x x x x :cpp:func:`hipsparseXcsru2csr_bufferSizeExt() ` x x x x :cpp:func:`hipsparseXcsru2csr() ` x x x x :cpp:func:`hipsparseXcsr2csru() ` x x x x ====================================================================================================================== ====== ====== ============== ============== Reordering functions ==================== ======================================================= ====== ====== ============== ============== Function name single double single complex double complex ======================================================= ====== ====== ============== ============== :cpp:func:`hipsparseXcsrcolor() ` x x x x ======================================================= ====== ====== ============== ============== Sparse generic functions ======================== ================================================= ====== ====== ============== ============== Function name single double single complex double complex ================================================= ====== ====== ============== ============== :cpp:func:`hipsparseAxpby()` x x x x :cpp:func:`hipsparseGather()` x x x x :cpp:func:`hipsparseScatter()` x x x x :cpp:func:`hipsparseRot()` x x x x :cpp:func:`hipsparseSparseToDense_bufferSize()` x x x x :cpp:func:`hipsparseSparseToDense()` x x x x :cpp:func:`hipsparseDenseToSparse_bufferSize()` x x x x :cpp:func:`hipsparseDenseToSparse_analysis()` x x x x :cpp:func:`hipsparseDenseToSparse_convert()` x x x x :cpp:func:`hipsparseSpVV_bufferSize()` x x x x :cpp:func:`hipsparseSpVV()` x x x x :cpp:func:`hipsparseSpMV_bufferSize()` x x x x :cpp:func:`hipsparseSpMV_preprocess()` x x x x :cpp:func:`hipsparseSpMV()` x x x x :cpp:func:`hipsparseSpMM_bufferSize()` x x x x :cpp:func:`hipsparseSpMM_preprocess()` x x x x :cpp:func:`hipsparseSpMM()` x x x x :cpp:func:`hipsparseSpGEMM_createDescr()` x x x x :cpp:func:`hipsparseSpGEMM_destroyDescr()` x x x x :cpp:func:`hipsparseSpGEMM_workEstimation()` x x x x :cpp:func:`hipsparseSpGEMM_compute()` x x x x :cpp:func:`hipsparseSpGEMM_copy()` x x x x :cpp:func:`hipsparseSpGEMMreuse_workEstimation()` x x x x :cpp:func:`hipsparseSpGEMMreuse_nnz()` x x x x :cpp:func:`hipsparseSpGEMMreuse_copy()` x x x x :cpp:func:`hipsparseSpGEMMreuse_compute()` x x x x :cpp:func:`hipsparseSDDMM_bufferSize()` x x x x :cpp:func:`hipsparseSDDMM_preprocess()` x x x x :cpp:func:`hipsparseSDDMM()` x x x x :cpp:func:`hipsparseSpSV_createDescr()` x x x x :cpp:func:`hipsparseSpSV_destroyDescr()` x x x x :cpp:func:`hipsparseSpSV_bufferSize()` x x x x :cpp:func:`hipsparseSpSV_analysis()` x x x x :cpp:func:`hipsparseSpSV_solve()` x x x x :cpp:func:`hipsparseSpSM_createDescr()` x x x x :cpp:func:`hipsparseSpSM_destroyDescr()` x x x x :cpp:func:`hipsparseSpSM_bufferSize()` x x x x :cpp:func:`hipsparseSpSM_analysis()` x x x x :cpp:func:`hipsparseSpSM_solve()` x x x x :cpp:func:`hipsparseSpSM_solve_ex()` x x x x ================================================= ====== ====== ============== ==============