This is an old version of ROCm documentation. Read the latest ROCm release documentation to stay informed of all our developments.

Exported hipSPARSE Functions#

Auxiliary Functions#

Function name

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#

Function name

single

double

single complex

double complex

hipsparseXaxpyi()

x

x

x

x

hipsparseXdoti()

x

x

x

x

hipsparseXdotci()

x

x

hipsparseXgthr()

x

x

x

x

hipsparseXgthrz()

x

x

x

x

hipsparseXroti()

x

x

hipsparseXsctr()

x

x

x

x

Sparse Level 2 Functions#

Function name

single

double

single complex

double complex

hipsparseXcsrmv()

x

x

x

x

hipsparseXcsrsv2_zeroPivot()

hipsparseXcsrsv2_bufferSize()

x

x

x

x

hipsparseXcsrsv2_bufferSizeExt()

x

x

x

x

hipsparseXcsrsv2_analysis()

x

x

x

x

hipsparseXcsrsv2_solve()

x

x

x

x

hipsparseXhybmv()

x

x

x

x

hipsparseXbsrmv()

x

x

x

x

hipsparseXbsrxmv()

x

x

x

x

hipsparseXbsrsv2_zeroPivot()

hipsparseXbsrsv2_bufferSize()

x

x

x

x

hipsparseXbsrsv2_bufferSizeExt()

x

x

x

x

hipsparseXbsrsv2_analysis()

x

x

x

x

hipsparseXbsrsv2_solve()

x

x

x

x

hipsparseXgemvi_bufferSize()

x

x

x

x

hipsparseXgemvi()

x

x

x

x

Sparse Level 3 Functions#

Function name

single

double

single complex

double complex

hipsparseXbsrmm()

x

x

x

x

hipsparseXcsrmm()

x

x

x

x

hipsparseXcsrmm2()

x

x

x

x

hipsparseXbsrsm2_zeroPivot()

hipsparseXbsrsm2_bufferSize()

x

x

x

x

hipsparseXbsrsm2_analysis()

x

x

x

x

hipsparseXbsrsm2_solve()

x

x

x

x

hipsparseXcsrsm2_zeroPivot()

hipsparseXcsrsm2_bufferSizeExt()

x

x

x

x

hipsparseXcsrsm2_analysis()

x

x

x

x

hipsparseXcsrsm2_solve()

x

x

x

x

hipsparseXgemmi()

x

x

x

x

Sparse Extra Functions#

Function name

single

double

single complex

double complex

hipsparseXcsrgeamNnz()

hipsparseXcsrgeam()

x

x

x

x

hipsparseXcsrgeam2_bufferSizeExt()

x

x

x

x

hipsparseXcsrgeam2Nnz()

hipsparseXcsrgeam2()

x

x

x

x

hipsparseXcsrgemmNnz()

hipsparseXcsrgemm()

x

x

x

x

hipsparseXcsrgemm2_bufferSizeExt()

x

x

x

x

hipsparseXcsrgemm2Nnz()

hipsparseXcsrgemm2()

x

x

x

x

Preconditioner Functions#

Function name

single

double

single complex

double complex

hipsparseXbsrilu02_zeroPivot()

hipsparseXbsrilu02_numericBoost()

x

x

x

x

hipsparseXbsrilu02_bufferSize()

x

x

x

x

hipsparseXbsrilu02_analysis()

x

x

x

x

hipsparseXbsrilu02()

x

x

x

x

hipsparseXcsrilu02_zeroPivot()

hipsparseXcsrilu02_numericBoost()

x

x

x

x

hipsparseXcsrilu02_bufferSize()

x

x

x

x

hipsparseXcsrilu02_bufferSizeExt()

x

x

x

x

hipsparseXcsrilu02_analysis()

x

x

x

x

hipsparseXcsrilu02()

x

x

x

x

hipsparseXbsric02_zeroPivot()

hipsparseXbsric02_bufferSize()

x

x

x

x

hipsparseXbsric02_analysis()

x

x

x

x

hipsparseXbsric02()

x

x

x

x

hipsparseXcsric02_zeroPivot()

hipsparseXcsric02_bufferSize()

x

x

x

x

hipsparseXcsric02_bufferSizeExt()

x

x

x

x

hipsparseXcsric02_analysis()

x

x

x

x

hipsparseXcsric02()

x

x

x

x

hipsparseXgtsv2_bufferSizeExt()

x

x

x

x

hipsparseXgtsv2()

x

x

x

x

hipsparseXgtsv2_nopivot_bufferSizeExt()

x

x

x

x

hipsparseXgtsv2_nopivot()

x

x

x

x

hipsparseXgtsv2StridedBatch_bufferSizeExt()

x

x

x

x

hipsparseXgtsv2StridedBatch()

x

x

x

x

hipsparseXgtsvInterleavedBatch_bufferSizeExt()

x

x

x

x

hipsparseXgtsvInterleavedBatch()

x

x

x

x

hipsparseXgpsvInterleavedBatch_bufferSizeExt()

x

x

x

x

hipsparseXgpsvInterleavedBatch()

x

x

x

x

Conversion Functions#

Function name

single

double

single complex

double complex

hipsparseXnnz()

x

x

x

x

hipsparseXdense2csr()

x

x

x

x

hipsparseXpruneDense2csr_bufferSize()

x

x

hipsparseXpruneDense2csrNnz()

x

x

hipsparseXpruneDense2csr()

x

x

hipsparseXpruneDense2csrByPercentage_bufferSize()

x

x

hipsparseXpruneDense2csrByPercentage_bufferSizeExt()

x

x

hipsparseXpruneDense2csrNnzByPercentage()

x

x

hipsparseXpruneDense2csrByPercentage()

x

x

hipsparseXdense2csc()

x

x

x

x

hipsparseXcsr2dense()

x

x

x

x

hipsparseXcsc2dense()

x

x

x

x

hipsparseXcsr2bsrNnz()

hipsparseXcsr2bsr()

x

x

x

x

hipsparseXnnz_compress()

x

x

x

x

hipsparseXcsr2coo()

hipsparseXcsr2csc()

x

x

x

x

hipsparseXcsr2hyb()

x

x

x

x

hipsparseXgebsr2gebsc_bufferSize

x

x

x

x

hipsparseXgebsr2gebsc()

x

x

x

x

hipsparseXcsr2gebsr_bufferSize()

x

x

x

x

hipsparseXcsr2gebsrNnz()

hipsparseXcsr2gebsr()

x

x

x

x

hipsparseXbsr2csr()

x

x

x

x

hipsparseXgebsr2csr()

x

x

x

x

hipsparseXcsr2csr_compress()

x

x

x

x

hipsparseXpruneCsr2csr_bufferSize()

x

x

hipsparseXpruneCsr2csr_bufferSizeExt()

x

x

hipsparseXpruneCsr2csrNnz()

x

x

hipsparseXpruneCsr2csr()

x

x

hipsparseXpruneCsr2csrByPercentage_bufferSize()

x

x

hipsparseXpruneCsr2csrByPercentage_bufferSizeExt()

x

x

hipsparseXpruneCsr2csrNnzByPercentage()

x

x

hipsparseXpruneCsr2csrByPercentage()

x

x

hipsparseXhyb2csr()

x

x

x

x

hipsparseXcoo2csr()

hipsparseCreateIdentityPermutation()

hipsparseXcsrsort_bufferSizeExt()

hipsparseXcsrsort()

hipsparseXcscsort_bufferSizeExt()

hipsparseXcscsort()

hipsparseXcoosort_bufferSizeExt()

hipsparseXcoosortByRow()

hipsparseXcoosortByColumn()

hipsparseXgebsr2gebsr_bufferSize()

x

x

x

x

hipsparseXgebsr2gebsrNnz()

hipsparseXgebsr2gebsr()

x

x

x

x

hipsparseXcsru2csr_bufferSizeExt()

x

x

x

x

hipsparseXcsru2csr()

x

x

x

x

hipsparseXcsr2csru()

x

x

x

x

Reordering Functions#

Function name

single

double

single complex

double complex

hipsparseXcsrcolor()

x

x

x

x

Sparse Generic Functions#

Function name

single

double

single complex

double complex

hipsparseAxpby()

x

x

x

x

hipsparseGather()

x

x

x

x

hipsparseScatter()

x

x

x

x

hipsparseRot()

x

x

x

x

hipsparseSparseToDense_bufferSize()

x

x

x

x

hipsparseSparseToDense()

x

x

x

x

hipsparseDenseToSparse_bufferSize()

x

x

x

x

hipsparseDenseToSparse_analysis()

x

x

x

x

hipsparseDenseToSparse_convert()

x

x

x

x

hipsparseSpVV_bufferSize()

x

x

x

x

hipsparseSpVV()

x

x

x

x

hipsparseSpMV_bufferSize()

x

x

x

x

hipsparseSpMV()

x

x

x

x

hipsparseSpMM_bufferSize()

x

x

x

x

hipsparseSpMM_preprocess()

x

x

x

x

hipsparseSpMM()

x

x

x

x

hipsparseSpGEMM_createDescr()

x

x

x

x

hipsparseSpGEMM_destroyDescr()

x

x

x

x

hipsparseSpGEMM_workEstimation()

x

x

x

x

hipsparseSpGEMM_compute()

x

x

x

x

hipsparseSpGEMM_copy()

x

x

x

x

hipsparseSpGEMMreuse_workEstimation()

x

x

x

x

hipsparseSpGEMMreuse_nnz()

x

x

x

x

hipsparseSpGEMMreuse_copy()

x

x

x

x

hipsparseSpGEMMreuse_compute()

x

x

x

x

hipsparseSDDMM_bufferSize()

x

x

x

x

hipsparseSDDMM_preprocess()

x

x

x

x

hipsparseSDDMM()

x

x

x

x

hipsparseSpSV_createDescr()

x

x

x

x

hipsparseSpSV_destroyDescr()

x

x

x

x

hipsparseSpSV_bufferSize()

x

x

x

x

hipsparseSpSV_analysis()

x

x

x

x

hipsparseSpSV_solve()

x

x

x

x

hipsparseSpSM_createDescr()

x

x

x

x

hipsparseSpSM_destroyDescr()

x

x

x

x

hipsparseSpSM_bufferSize()

x

x

x

x

hipsparseSpSM_analysis()

x

x

x

x

hipsparseSpSM_solve()

x

x

x

x