Contents

The contents of the programming guide to the CUDA model and interface.

• 1. Introduction
  • 1.1. Library Organization and Features
  • 1.2. Static Library Support
  • 1.3. Library Dependencies
• 2. Using the cuSPARSE API
  • 2.1. APIs Usage Notes
  • 2.2. Deprecated APIs
  • 2.3. Thread Safety
  • 2.4. Result Reproducibility
  • 2.5. NaN and Inf Propagation
  • 2.6. Parallelism with Streams
  • 2.7. Compatibility and Versioning
  • 2.8. Optimization Notes
• 3. cuSPARSE Storage Formats
  • 3.1. Index Base
  • 3.2. Vector Formats
    • 3.2.1. Dense Vector Format
    • 3.2.2. Sparse Vector Format
  • 3.3. Matrix Formats
    • 3.3.1. Dense Matrix Format
    • 3.3.2. Coordinate (COO)
    • 3.3.3. Compressed Sparse Row (CSR)
    • 3.3.4. Compressed Sparse Column (CSC)
    • 3.3.5. Sliced Ellpack (SELL)
    • 3.3.6. Block Sparse Row (BSR)
    • 3.3.7. Blocked Ellpack (BLOCKED-ELL)
    • 3.3.8. Extended BSR Format (BSRX) [DEPRECATED]
• 4. cuSPARSE Basic APIs
  • 4.1. cuSPARSE Types Reference
    • 4.1.1. cudaDataType_t
    • 4.1.2. cusparseStatus_t
    • 4.1.3. cusparseHandle_t
    • 4.1.4. cusparsePointerMode_t
    • 4.1.5. cusparseOperation_t
    • 4.1.6. cusparseDiagType_t
    • 4.1.7. cusparseFillMode_t
    • 4.1.8. cusparseIndexBase_t
    • 4.1.9. cusparseDirection_t
  • 4.2. cuSPARSE Management API
    • 4.2.1. cusparseCreate()
    • 4.2.2. cusparseDestroy()
    • 4.2.3. cusparseGetErrorName()
    • 4.2.4. cusparseGetErrorString()
    • 4.2.5. cusparseGetProperty()
    • 4.2.6. cusparseGetVersion()
    • 4.2.7. cusparseGetPointerMode()
    • 4.2.8. cusparseSetPointerMode()
    • 4.2.9. cusparseGetStream()
    • 4.2.10. cusparseSetStream()
  • 4.3. cuSPARSE Logging API
    • 4.3.1. cusparseLoggerSetCallback()
    • 4.3.2. cusparseLoggerSetFile()
    • 4.3.3. cusparseLoggerOpenFile()
    • 4.3.4. cusparseLoggerSetLevel()
    • 4.3.5. cusparseLoggerSetMask()
• 5. cuSPARSE Legacy APIs
  • 5.1. Naming Conventions
  • 5.2. cuSPARSE Legacy Types Reference
    • 5.2.1. cusparseAction_t
    • 5.2.2. cusparseMatDescr_t
    • 5.2.3. cusparseMatrixType_t
    • 5.2.4. cusparseColorInfo_t [DEPRECATED]
    • 5.2.5. cusparseSolvePolicy_t [DEPRECATED]
    • 5.2.6. bsric02Info_t [DEPRECATED]
    • 5.2.7. bsrilu02Info_t [DEPRECATED]
    • 5.2.8. bsrsm2Info_t [DEPRECATED]
    • 5.2.9. bsrsv2Info_t [DEPRECATED]
    • 5.2.10. csric02Info_t [DEPRECATED]
    • 5.2.11. csrilu02Info_t [DEPRECATED]
  • 5.3. cuSPARSE Helper Function Reference
    • 5.3.1. cusparseCreateColorInfo() [DEPRECATED]
    • 5.3.2. cusparseCreateMatDescr()
    • 5.3.3. cusparseDestroyColorInfo() [DEPRECATED]
    • 5.3.4. cusparseDestroyMatDescr()
    • 5.3.5. cusparseGetMatDiagType()
    • 5.3.6. cusparseGetMatFillMode()
    • 5.3.7. cusparseGetMatIndexBase()
    • 5.3.8. cusparseGetMatType()
    • 5.3.9. cusparseSetMatDiagType()
    • 5.3.10. cusparseSetMatFillMode()
    • 5.3.11. cusparseSetMatIndexBase()
    • 5.3.12. cusparseSetMatType()
    • 5.3.13. cusparseCreateCsric02Info() [DEPRECATED]
    • 5.3.14. cusparseDestroyCsric02Info() [DEPRECATED]
    • 5.3.15. cusparseCreateCsrilu02Info() [DEPRECATED]
    • 5.3.16. cusparseDestroyCsrilu02Info() [DEPRECATED]
    • 5.3.17. cusparseCreateBsrsv2Info() [DEPRECATED]
    • 5.3.18. cusparseDestroyBsrsv2Info() [DEPRECATED]
    • 5.3.19. cusparseCreateBsrsm2Info() [DEPRECATED]
    • 5.3.20. cusparseDestroyBsrsm2Info() [DEPRECATED]
    • 5.3.21. cusparseCreateBsric02Info() [DEPRECATED]
    • 5.3.22. cusparseDestroyBsric02Info() [DEPRECATED]
    • 5.3.23. cusparseCreateBsrilu02Info() [DEPRECATED]
    • 5.3.24. cusparseDestroyBsrilu02Info() [DEPRECATED]
    • 5.3.25. cusparseCreatePruneInfo() [DEPRECATED]
    • 5.3.26. cusparseDestroyPruneInfo() [DEPRECATED]
  • 5.4. cuSPARSE Level 2 Function Reference
    • 5.4.1. cusparse<t>bsrmv()
    • 5.4.2. cusparse<t>bsrxmv() [DEPRECATED]
    • 5.4.3. cusparse<t>bsrsv2_bufferSize() [DEPRECATED]
    • 5.4.4. cusparse<t>bsrsv2_analysis() [DEPRECATED]
    • 5.4.5. cusparse<t>bsrsv2_solve() [DEPRECATED]
    • 5.4.6. cusparseXbsrsv2_zeroPivot() [DEPRECATED]
    • 5.4.7. cusparse<t>gemvi()
  • 5.5. cuSPARSE Level 3 Function Reference
    • 5.5.1. cusparse<t>bsrmm()
    • 5.5.2. cusparse<t>bsrsm2_bufferSize() [DEPRECATED]
    • 5.5.3. cusparse<t>bsrsm2_analysis() [DEPRECATED]
    • 5.5.4. cusparse<t>bsrsm2_solve() [DEPRECATED]
    • 5.5.5. cusparseXbsrsm2_zeroPivot() [DEPRECATED]
  • 5.6. cuSPARSE Extra Function Reference
    • 5.6.1. cusparse<t>csrgeam2()
  • 5.7. cuSPARSE Preconditioners Reference
    • 5.7.1. Incomplete Cholesky Factorization: level 0 [DEPRECATED]
      • 5.7.1.1. cusparse<t>csric02_bufferSize() [DEPRECATED]
      • 5.7.1.2. cusparse<t>csric02_analysis() [DEPRECATED]
      • 5.7.1.3. cusparse<t>csric02() [DEPRECATED]
      • 5.7.1.4. cusparseXcsric02_zeroPivot() [DEPRECATED]
      • 5.7.1.5. cusparse<t>bsric02_bufferSize() [DEPRECATED]
      • 5.7.1.6. cusparse<t>bsric02_analysis() [DEPRECATED]
      • 5.7.1.7. cusparse<t>bsric02() [DEPRECATED]
      • 5.7.1.8. cusparseXbsric02_zeroPivot() [DEPRECATED]
    • 5.7.2. Incomplete LU Factorization: level 0 [DEPRECATED]
      • 5.7.2.1. cusparse<t>csrilu02_numericBoost() [DEPRECATED]
      • 5.7.2.2. cusparse<t>csrilu02_bufferSize() [DEPRECATED]
      • 5.7.2.3. cusparse<t>csrilu02_analysis() [DEPRECATED]
      • 5.7.2.4. cusparse<t>csrilu02() [DEPRECATED]
      • 5.7.2.5. cusparseXcsrilu02_zeroPivot() [DEPRECATED]
      • 5.7.2.6. cusparse<t>bsrilu02_numericBoost() [DEPRECATED]
      • 5.7.2.7. cusparse<t>bsrilu02_bufferSize() [DEPRECATED]
      • 5.7.2.8. cusparse<t>bsrilu02_analysis() [DEPRECATED]
      • 5.7.2.9. cusparse<t>bsrilu02() [DEPRECATED]
      • 5.7.2.10. cusparseXbsrilu02_zeroPivot() [DEPRECATED]
    • 5.7.3. Tridiagonal Solve
      • 5.7.3.1. cusparse<t>gtsv2_buffSizeExt()
      • 5.7.3.2. cusparse<t>gtsv2()
      • 5.7.3.3. cusparse<t>gtsv2_nopivot_bufferSizeExt()
      • 5.7.3.4. cusparse<t>gtsv2_nopivot()
    • 5.7.4. Batched Tridiagonal Solve
      • 5.7.4.1. cusparse<t>gtsv2StridedBatch_bufferSizeExt()
      • 5.7.4.2. cusparse<t>gtsv2StridedBatch()
      • 5.7.4.3. cusparse<t>gtsvInterleavedBatch()
    • 5.7.5. Batched Pentadiagonal Solve
      • 5.7.5.1. cusparse<t>gpsvInterleavedBatch()
  • 5.8. cuSPARSE Reorderings Reference
    • 5.8.1. cusparse<t>csrcolor() [DEPRECATED]
  • 5.9. cuSPARSE Format Conversion Reference
    • 5.9.1. cusparse<t>bsr2csr()
    • 5.9.2. cusparse<t>gebsr2gebsc()
    • 5.9.3. cusparse<t>gebsr2gebsr()
    • 5.9.4. cusparse<t>gebsr2csr()
    • 5.9.5. cusparse<t>csr2gebsr()
    • 5.9.6. cusparse<t>coo2csr()
    • 5.9.7. cusparse<t>csr2coo()
    • 5.9.8. cusparseCsr2cscEx2()
    • 5.9.9. cusparse<t>nnz()
    • 5.9.10. cusparseCreateIdentityPermutation() [DEPRECATED]
    • 5.9.11. cusparseXcoosort()
    • 5.9.12. cusparseXcsrsort()
    • 5.9.13. cusparseXcscsort()
    • 5.9.14. cusparseXcsru2csr() [DEPRECATED]
    • 5.9.15. cusparseXpruneDense2csr() [DEPRECATED]
    • 5.9.16. cusparseXpruneCsr2csr() [DEPRECATED]
    • 5.9.17. cusparseXpruneDense2csrPercentage() [DEPRECATED]
    • 5.9.18. cusparseXpruneCsr2csrByPercentage() [DEPRECATED]
    • 5.9.19. cusparse<t>nnz_compress() [DEPRECATED]
• 6. cuSPARSE Generic APIs
  • 6.1. Generic Types Reference
    • 6.1.1. cusparseFormat_t
    • 6.1.2. cusparseOrder_t
    • 6.1.3. cusparseIndexType_t
  • 6.2. Dense Vector APIs
    • 6.2.1. cusparseCreateDnVec()
    • 6.2.2. cusparseDestroyDnVec()
    • 6.2.3. cusparseDnVecGet()
    • 6.2.4. cusparseDnVecGetValues()
    • 6.2.5. cusparseDnVecSetValues()
  • 6.3. Sparse Vector APIs
    • 6.3.1. cusparseCreateSpVec()
    • 6.3.2. cusparseDestroySpVec()
    • 6.3.3. cusparseSpVecGet()
    • 6.3.4. cusparseSpVecGetIndexBase()
    • 6.3.5. cusparseSpVecGetValues()
    • 6.3.6. cusparseSpVecSetValues()
  • 6.4. Dense Matrix APIs
    • 6.4.1. cusparseCreateDnMat()
    • 6.4.2. cusparseDestroyDnMat()
    • 6.4.3. cusparseDnMatGet()
    • 6.4.4. cusparseDnMatGetValues()
    • 6.4.5. cusparseDnMatSetValues()
    • 6.4.6. cusparseDnMatGetStridedBatch()
    • 6.4.7. cusparseDnMatSetStridedBatch()
  • 6.5. Sparse Matrix APIs
    • 6.5.1. Coordinate (COO)
      • 6.5.1.1. cusparseCreateCoo()
      • 6.5.1.2. cusparseCooGet()
      • 6.5.1.3. cusparseCooSetPointers()
      • 6.5.1.4. cusparseCooSetStridedBatch()
    • 6.5.2. Compressed Sparse Row (CSR)
      • 6.5.2.1. cusparseCreateCsr()
      • 6.5.2.2. cusparseCsrGet()
      • 6.5.2.3. cusparseCsrSetPointers()
      • 6.5.2.4. cusparseCsrSetStridedBatch()
    • 6.5.3. Compressed Sparse Column (CSC)
      • 6.5.3.1. cusparseCreateCsc()
      • 6.5.3.2. cusparseCscGet()
      • 6.5.3.3. cusparseCscSetPointers()
    • 6.5.4. Blocked-Ellpack (Blocked-ELL)
      • 6.5.4.1. cusparseCreateBlockedEll()
      • 6.5.4.2. cusparseBlockedEllGet()
    • 6.5.5. Sliced-Ellpack (SELL)
      • 6.5.5.1. cusparseCreateSlicedEll()
    • 6.5.6. Block Sparse Row (BSR)
      • 6.5.6.1. cusparseCreateBsr()
      • 6.5.6.2. cusparseBsrSetStridedBatch()
    • 6.5.7. All Sparse Formats
      • 6.5.7.1. cusparseDestroySpMat()
      • 6.5.7.2. cusparseSpMatGetSize()
      • 6.5.7.3. cusparseSpMatGetFormat()
      • 6.5.7.4. cusparseSpMatGetIndexBase()
      • 6.5.7.5. cusparseSpMatGetValues()
      • 6.5.7.6. cusparseSpMatSetValues()
      • 6.5.7.7. cusparseSpMatGetStridedBatch()
      • 6.5.7.8. cusparseSpMatGetAttribute()
      • 6.5.7.9. cusparseSpMatSetAttribute()
  • 6.6. Generic API Functions
    • 6.6.1. cusparseAxpby()
    • 6.6.2. cusparseGather()
    • 6.6.3. cusparseScatter()
    • 6.6.4. cusparseRot() [DEPRECATED]
    • 6.6.5. cusparseSpVV()
    • 6.6.6. cusparseSpMV()
    • 6.6.7. cusparseSpSV()
    • 6.6.8. cusparseSpMM()
    • 6.6.9. cusparseSpMMOp()
    • 6.6.10. cusparseSpSM()
    • 6.6.11. cusparseSDDMM()
    • 6.6.12. cusparseSpGEMM()
    • 6.6.13. cusparseSpGEMMreuse()
    • 6.6.14. cusparseSparseToDense()
    • 6.6.15. cusparseDenseToSparse()
• 7. cuSPARSE Fortran Bindings
  • 7.1. Fortran Application
• 8. Acknowledgements
• 9. Bibliography
• 10. Notices
  • 10.1. Notice
  • 10.2. OpenCL
  • 10.3. Trademarks