Sparse Auxiliary Functions¶

This module holds 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.

hipsparseCreate()¶

hipsparseStatus_t hipsparseCreate(hipsparseHandle_t *handle)¶

Create a hipsparse handle.

hipsparseCreate creates the hipSPARSE library context. It must be initialized before any other hipSPARSE API function is invoked and must be passed to all subsequent library function calls. The handle should be destroyed at the end using hipsparseDestroy().

hipsparseDestroy()¶

hipsparseStatus_t hipsparseDestroy(hipsparseHandle_t handle)¶

Destroy a hipsparse handle.

hipsparseDestroy destroys the hipSPARSE library context and releases all resources used by the hipSPARSE library.

hipsparseGetVersion()¶

hipsparseStatus_t hipsparseGetVersion(hipsparseHandle_t handle, int *version)¶

Get hipSPARSE version.

hipsparseGetVersion gets the hipSPARSE library version number.

patch = version % 100
minor = version / 100 % 1000
major = version / 100000

hipsparseGetGitRevision()¶

hipsparseStatus_t hipsparseGetGitRevision(hipsparseHandle_t handle, char *rev)¶

Get hipSPARSE git revision.

hipsparseGetGitRevision gets the hipSPARSE library git commit revision (SHA-1).

hipsparseSetStream()¶

hipsparseStatus_t hipsparseSetStream(hipsparseHandle_t handle, hipStream_t streamId)¶

Specify user defined HIP stream.

hipsparseSetStream specifies the stream to be used by the hipSPARSE library context and all subsequent function calls.

hipsparseGetStream()¶

hipsparseStatus_t hipsparseGetStream(hipsparseHandle_t handle, hipStream_t *streamId)¶

Get current stream from library context.

hipsparseGetStream gets the hipSPARSE library context stream which is currently used for all subsequent function calls.

hipsparseSetPointerMode()¶

hipsparseStatus_t hipsparseSetPointerMode(hipsparseHandle_t handle, hipsparsePointerMode_t mode)¶

Specify pointer mode.

hipsparseSetPointerMode specifies the pointer mode to be used by the hipSPARSE library context and all subsequent function calls. By default, all values are passed by reference on the host. Valid pointer modes are HIPSPARSE_POINTER_MODE_HOST or HIPSPARSE_POINTER_MODE_DEVICE.

hipsparseGetPointerMode()¶

hipsparseStatus_t hipsparseGetPointerMode(hipsparseHandle_t handle, hipsparsePointerMode_t *mode)¶

Get current pointer mode from library context.

hipsparseGetPointerMode gets the hipSPARSE library context pointer mode which is currently used for all subsequent function calls.

hipsparseCreateMatDescr()¶

hipsparseStatus_t hipsparseCreateMatDescr(hipsparseMatDescr_t *descrA)¶

Create a matrix descriptor.

hipsparseCreateMatDescr creates a matrix descriptor. It initializes hipsparseMatrixType_t to HIPSPARSE_MATRIX_TYPE_GENERAL and hipsparseIndexBase_t to HIPSPARSE_INDEX_BASE_ZERO. It should be destroyed at the end using hipsparseDestroyMatDescr().

hipsparseDestroyMatDescr()¶

hipsparseStatus_t hipsparseDestroyMatDescr(hipsparseMatDescr_t descrA)¶

Destroy a matrix descriptor.

hipsparseDestroyMatDescr destroys a matrix descriptor and releases all resources used by the descriptor.

hipsparseCopyMatDescr()¶

hipsparseStatus_t hipsparseCopyMatDescr(hipsparseMatDescr_t dest, const hipsparseMatDescr_t src)¶

Copy a matrix descriptor.

hipsparseCopyMatDescr copies a matrix descriptor. Both, source and destination matrix descriptors must be initialized prior to calling hipsparseCopyMatDescr.

hipsparseSetMatType()¶

hipsparseStatus_t hipsparseSetMatType(hipsparseMatDescr_t descrA, hipsparseMatrixType_t type)¶

Specify the matrix type of a matrix descriptor.

hipsparseSetMatType sets the matrix type of a matrix descriptor. Valid matrix types are HIPSPARSE_MATRIX_TYPE_GENERAL, HIPSPARSE_MATRIX_TYPE_SYMMETRIC, HIPSPARSE_MATRIX_TYPE_HERMITIAN or HIPSPARSE_MATRIX_TYPE_TRIANGULAR.

hipsparseGetMatType()¶

hipsparseMatrixType_t hipsparseGetMatType(const hipsparseMatDescr_t descrA)¶

Get the matrix type of a matrix descriptor.

hipsparseGetMatType returns the matrix type of a matrix descriptor.

hipsparseSetMatFillMode()¶

hipsparseStatus_t hipsparseSetMatFillMode(hipsparseMatDescr_t descrA, hipsparseFillMode_t fillMode)¶

Specify the matrix fill mode of a matrix descriptor.

hipsparseSetMatFillMode sets the matrix fill mode of a matrix descriptor. Valid fill modes are HIPSPARSE_FILL_MODE_LOWER or HIPSPARSE_FILL_MODE_UPPER.

hipsparseGetMatFillMode()¶

hipsparseFillMode_t hipsparseGetMatFillMode(const hipsparseMatDescr_t descrA)¶

Get the matrix fill mode of a matrix descriptor.

hipsparseGetMatFillMode returns the matrix fill mode of a matrix descriptor.

hipsparseSetMatDiagType()¶

hipsparseStatus_t hipsparseSetMatDiagType(hipsparseMatDescr_t descrA, hipsparseDiagType_t diagType)¶

Specify the matrix diagonal type of a matrix descriptor.

hipsparseSetMatDiagType sets the matrix diagonal type of a matrix descriptor. Valid diagonal types are HIPSPARSE_DIAG_TYPE_UNIT or HIPSPARSE_DIAG_TYPE_NON_UNIT.

hipsparseGetMatDiagType()¶

hipsparseDiagType_t hipsparseGetMatDiagType(const hipsparseMatDescr_t descrA)¶

Get the matrix diagonal type of a matrix descriptor.

hipsparseGetMatDiagType returns the matrix diagonal type of a matrix descriptor.

hipsparseSetMatIndexBase()¶

hipsparseStatus_t hipsparseSetMatIndexBase(hipsparseMatDescr_t descrA, hipsparseIndexBase_t base)¶

Specify the index base of a matrix descriptor.

hipsparseSetMatIndexBase sets the index base of a matrix descriptor. Valid options are HIPSPARSE_INDEX_BASE_ZERO or HIPSPARSE_INDEX_BASE_ONE.

hipsparseGetMatIndexBase()¶

hipsparseIndexBase_t hipsparseGetMatIndexBase(const hipsparseMatDescr_t descrA)¶

Get the index base of a matrix descriptor.

hipsparseGetMatIndexBase returns the index base of a matrix descriptor.

hipsparseCreateHybMat()¶

hipsparseStatus_t hipsparseCreateHybMat(hipsparseHybMat_t *hybA)¶

Create a HYB matrix structure.

hipsparseCreateHybMat creates a structure that holds the matrix in HYB storage format. It should be destroyed at the end using hipsparseDestroyHybMat().

hipsparseDestroyHybMat()¶

hipsparseStatus_t hipsparseDestroyHybMat(hipsparseHybMat_t hybA)¶

Destroy a HYB matrix structure.

hipsparseDestroyHybMat destroys a HYB structure.

hipsparseCreateBsrsv2Info()¶

hipsparseStatus_t hipsparseCreateBsrsv2Info(bsrsv2Info_t *info)¶

Create a bsrsv2 info structure.

hipsparseCreateBsrsv2Info creates a structure that holds the bsrsv2 info data that is gathered during the analysis routines available. It should be destroyed at the end using hipsparseDestroyBsrsv2Info().

hipsparseDestroyBsrsv2Info()¶

hipsparseStatus_t hipsparseDestroyBsrsv2Info(bsrsv2Info_t info)¶

Destroy a bsrsv2 info structure.

hipsparseDestroyBsrsv2Info destroys a bsrsv2 info structure.

hipsparseCreateBsrsm2Info()¶

hipsparseStatus_t hipsparseCreateBsrsm2Info(bsrsm2Info_t *info)¶

Create a bsrsm2 info structure.

hipsparseCreateBsrsm2Info creates a structure that holds the bsrsm2 info data that is gathered during the analysis routines available. It should be destroyed at the end using hipsparseDestroyBsrsm2Info().

hipsparseDestroyBsrsm2Info()¶

hipsparseStatus_t hipsparseDestroyBsrsm2Info(bsrsm2Info_t info)¶

Destroy a bsrsm2 info structure.

hipsparseDestroyBsrsm2Info destroys a bsrsm2 info structure.

hipsparseCreateBsrilu02Info()¶

hipsparseStatus_t hipsparseCreateBsrilu02Info(bsrilu02Info_t *info)¶

Create a bsrilu02 info structure.

hipsparseCreateBsrilu02Info creates a structure that holds the bsrilu02 info data that is gathered during the analysis routines available. It should be destroyed at the end using hipsparseDestroyBsrilu02Info().

hipsparseDestroyBsrilu02Info()¶

hipsparseStatus_t hipsparseDestroyBsrilu02Info(bsrilu02Info_t info)¶

Destroy a bsrilu02 info structure.

hipsparseDestroyBsrilu02Info destroys a bsrilu02 info structure.

hipsparseCreateBsric02Info()¶

hipsparseStatus_t hipsparseCreateBsric02Info(bsric02Info_t *info)¶

Create a bsric02 info structure.

hipsparseCreateBsric02Info creates a structure that holds the bsric02 info data that is gathered during the analysis routines available. It should be destroyed at the end using hipsparseDestroyBsric02Info().

hipsparseDestroyBsric02Info()¶

hipsparseStatus_t hipsparseDestroyBsric02Info(bsric02Info_t info)¶

Destroy a bsric02 info structure.

hipsparseDestroyBsric02Info destroys a bsric02 info structure.

hipsparseCreateCsrsv2Info()¶

hipsparseStatus_t hipsparseCreateCsrsv2Info(csrsv2Info_t *info)¶

Create a csrsv2 info structure.

hipsparseCreateCsrsv2Info creates a structure that holds the csrsv2 info data that is gathered during the analysis routines available. It should be destroyed at the end using hipsparseDestroyCsrsv2Info().

hipsparseDestroyCsrsv2Info()¶

hipsparseStatus_t hipsparseDestroyCsrsv2Info(csrsv2Info_t info)¶

Destroy a csrsv2 info structure.

hipsparseDestroyCsrsv2Info destroys a csrsv2 info structure.

hipsparseCreateCsrsm2Info()¶

hipsparseStatus_t hipsparseCreateCsrsm2Info(csrsm2Info_t *info)¶

Create a csrsm2 info structure.

hipsparseCreateCsrsm2Info creates a structure that holds the csrsm2 info data that is gathered during the analysis routines available. It should be destroyed at the end using hipsparseDestroyCsrsm2Info().

hipsparseDestroyCsrsm2Info()¶

hipsparseStatus_t hipsparseDestroyCsrsm2Info(csrsm2Info_t info)¶

Destroy a csrsm2 info structure.

hipsparseDestroyCsrsm2Info destroys a csrsm2 info structure.

hipsparseCreateCsrilu02Info()¶

hipsparseStatus_t hipsparseCreateCsrilu02Info(csrilu02Info_t *info)¶

Create a csrilu02 info structure.

hipsparseCreateCsrilu02Info creates a structure that holds the csrilu02 info data that is gathered during the analysis routines available. It should be destroyed at the end using hipsparseDestroyCsrilu02Info().

hipsparseDestroyCsrilu02Info()¶

hipsparseStatus_t hipsparseDestroyCsrilu02Info(csrilu02Info_t info)¶

Destroy a csrilu02 info structure.

hipsparseDestroyCsrilu02Info destroys a csrilu02 info structure.

hipsparseCreateCsric02Info()¶

hipsparseStatus_t hipsparseCreateCsric02Info(csric02Info_t *info)¶

Create a csric02 info structure.

hipsparseCreateCsric02Info creates a structure that holds the csric02 info data that is gathered during the analysis routines available. It should be destroyed at the end using hipsparseDestroyCsric02Info().

hipsparseDestroyCsric02Info()¶

hipsparseStatus_t hipsparseDestroyCsric02Info(csric02Info_t info)¶

Destroy a csric02 info structure.

hipsparseDestroyCsric02Info destroys a csric02 info structure.

hipsparseCreateCsru2csrInfo()¶

hipsparseStatus_t hipsparseCreateCsru2csrInfo(csru2csrInfo_t *info)¶

Create a csru2csr info structure.

hipsparseCreateCsru2csrInfo creates a structure that holds the csru2csr info data that is gathered during the analysis routines available. It should be destroyed at the end using hipsparseDestroyCsru2csrInfo().

hipsparseDestroyCsru2csrInfo()¶

hipsparseStatus_t hipsparseDestroyCsru2csrInfo(csru2csrInfo_t info)¶

Destroy a csru2csr info structure.

hipsparseDestroyCsru2csrInfo destroys a csru2csr info structure.

hipsparseCreateColorInfo()¶

hipsparseStatus_t hipsparseCreateColorInfo(hipsparseColorInfo_t *info)¶

Create a color info structure.

hipsparseCreateColorInfo creates a structure that holds the color info data that is gathered during the analysis routines available. It should be destroyed at the end using hipsparseDestroyColorInfo().

hipsparseDestroyColorInfo()¶

hipsparseStatus_t hipsparseDestroyColorInfo(hipsparseColorInfo_t info)¶

Destroy a color info structure.

hipsparseDestroyColorInfo destroys a color info structure.

hipsparseCreateCsrgemm2Info()¶

hipsparseStatus_t hipsparseCreateCsrgemm2Info(csrgemm2Info_t *info)¶

Create a csrgemm2 info structure.

hipsparseCreateCsrgemm2Info creates a structure that holds the csrgemm2 info data that is gathered during the analysis routines available. It should be destroyed at the end using hipsparseDestroyCsrgemm2Info().

hipsparseDestroyCsrgemm2Info()¶

hipsparseStatus_t hipsparseDestroyCsrgemm2Info(csrgemm2Info_t info)¶

Destroy a csrgemm2 info structure.

hipsparseDestroyCsrgemm2Info destroys a csrgemm2 info structure.

hipsparseCreatePruneInfo()¶

hipsparseStatus_t hipsparseCreatePruneInfo(pruneInfo_t *info)¶

Create a prune info structure.

hipsparseCreatePruneInfo creates a structure that holds the prune info data that is gathered during the analysis routines available. It should be destroyed at the end using hipsparseDestroyPruneInfo().

hipsparseDestroyPruneInfo()¶

hipsparseStatus_t hipsparseDestroyPruneInfo(pruneInfo_t info)¶

Destroy a prune info structure.

hipsparseDestroyPruneInfo destroys a prune info structure.

hipsparseCreateSpVec()¶

hipsparseStatus_t hipsparseCreateSpVec(hipsparseSpVecDescr_t *spVecDescr, int64_t size, int64_t nnz, void *indices, void *values, hipsparseIndexType_t idxType, hipsparseIndexBase_t idxBase, hipDataType valueType)¶

Description: Create a sparse vector.

hipsparseCreateSpVec creates a sparse vector descriptor. It should be destroyed at the end using hipsparseDestroyMatDescr().

hipsparseDestroySpVec()¶

hipsparseStatus_t hipsparseDestroySpVec(hipsparseSpVecDescr_t spVecDescr)¶

Description: Destroy a sparse vector.

hipsparseDestroySpVec destroys a sparse vector descriptor and releases all resources used by the descriptor.

hipsparseSpVecGet()¶

hipsparseStatus_t hipsparseSpVecGet(const hipsparseSpVecDescr_t spVecDescr, int64_t *size, int64_t *nnz, void **indices, void **values, hipsparseIndexType_t *idxType, hipsparseIndexBase_t *idxBase, hipDataType *valueType)¶

Description: Get the fields of the sparse vector descriptor.

hipsparseSpVecGet gets the fields of the sparse vector descriptor

hipsparseSpVecGetIndexBase()¶

hipsparseStatus_t hipsparseSpVecGetIndexBase(const hipsparseSpVecDescr_t spVecDescr, hipsparseIndexBase_t *idxBase)¶: Description: Get index base of a sparse vector.

hipsparseSpVecGetValues()¶

hipsparseStatus_t hipsparseSpVecGetValues(const hipsparseSpVecDescr_t spVecDescr, void **values)¶: Description: Get pointer to a sparse vector data array.

hipsparseSpVecSetValues()¶

hipsparseStatus_t hipsparseSpVecSetValues(hipsparseSpVecDescr_t spVecDescr, void *values)¶: Description: Set pointer of a sparse vector data array.

hipsparseCreateCoo()¶

hipsparseStatus_t hipsparseCreateCoo(hipsparseSpMatDescr_t *spMatDescr, int64_t rows, int64_t cols, int64_t nnz, void *cooRowInd, void *cooColInd, void *cooValues, hipsparseIndexType_t cooIdxType, hipsparseIndexBase_t idxBase, hipDataType valueType)¶

Description: Create a sparse COO matrix descriptor.

hipsparseCreateCoo creates a sparse COO matrix descriptor. It should be destroyed at the end using hipsparseDestroySpMat.

hipsparseCreateCooAoS()¶

hipsparseStatus_t hipsparseCreateCooAoS(hipsparseSpMatDescr_t *spMatDescr, int64_t rows, int64_t cols, int64_t nnz, void *cooInd, void *cooValues, hipsparseIndexType_t cooIdxType, hipsparseIndexBase_t idxBase, hipDataType valueType)¶

Description: Create a sparse COO (AoS) matrix descriptor.

hipsparseCreateCooAoS creates a sparse COO (AoS) matrix descriptor. It should be destroyed at the end using hipsparseDestroySpMat.

hipsparseCreateCsr()¶

hipsparseStatus_t hipsparseCreateCsr(hipsparseSpMatDescr_t *spMatDescr, int64_t rows, int64_t cols, int64_t nnz, void *csrRowOffsets, void *csrColInd, void *csrValues, hipsparseIndexType_t csrRowOffsetsType, hipsparseIndexType_t csrColIndType, hipsparseIndexBase_t idxBase, hipDataType valueType)¶

Description: Create a sparse CSR matrix descriptor.

hipsparseCreateCsr creates a sparse CSR matrix descriptor. It should be destroyed at the end using hipsparseDestroySpMat.

hipsparseCreateCsc()¶

hipsparseStatus_t hipsparseCreateCsc(hipsparseSpMatDescr_t *spMatDescr, int64_t rows, int64_t cols, int64_t nnz, void *cscColOffsets, void *cscRowInd, void *cscValues, hipsparseIndexType_t cscColOffsetsType, hipsparseIndexType_t cscRowIndType, hipsparseIndexBase_t idxBase, hipDataType valueType)¶

Description: Create a sparse CSC matrix descriptor.

hipsparseCreateCsr creates a sparse CSC matrix descriptor. It should be destroyed at the end using hipsparseDestroySpMat.

hipsparseCreateBlockedEll()¶

hipsparseStatus_t hipsparseCreateBlockedEll(hipsparseSpMatDescr_t *spMatDescr, int64_t rows, int64_t cols, int64_t ellBlockSize, int64_t ellCols, void *ellColInd, void *ellValue, hipsparseIndexType_t ellIdxType, hipsparseIndexBase_t idxBase, hipDataType valueType)¶

Description: Create a sparse Blocked ELL matrix descriptor.

hipsparseCreateCsr creates a sparse Blocked ELL matrix descriptor. It should be destroyed at the end using hipsparseDestroySpMat.

hipsparseDestroySpMat()¶

hipsparseStatus_t hipsparseDestroySpMat(hipsparseSpMatDescr_t spMatDescr)¶

Description: Destroy a sparse matrix descriptor.

hipsparseDestroySpMat destroys a sparse matrix descriptor and releases all resources used by the descriptor.

hipsparseCooGet()¶

hipsparseStatus_t hipsparseCooGet(const hipsparseSpMatDescr_t spMatDescr, int64_t *rows, int64_t *cols, int64_t *nnz, void **cooRowInd, void **cooColInd, void **cooValues, hipsparseIndexType_t *idxType, hipsparseIndexBase_t *idxBase, hipDataType *valueType)¶

Description: Get pointers of a sparse COO matrix.

hipsparseCooGet gets the fields of the sparse COO matrix descriptor

hipsparseCooAoSGet()¶

hipsparseStatus_t hipsparseCooAoSGet(const hipsparseSpMatDescr_t spMatDescr, int64_t *rows, int64_t *cols, int64_t *nnz, void **cooInd, void **cooValues, hipsparseIndexType_t *idxType, hipsparseIndexBase_t *idxBase, hipDataType *valueType)¶

Description: Get pointers of a sparse COO (AoS) matrix.

hipsparseCooAoSGet gets the fields of the sparse COO (AoS) matrix descriptor

hipsparseCsrGet()¶

hipsparseStatus_t hipsparseCsrGet(const hipsparseSpMatDescr_t spMatDescr, int64_t *rows, int64_t *cols, int64_t *nnz, void **csrRowOffsets, void **csrColInd, void **csrValues, hipsparseIndexType_t *csrRowOffsetsType, hipsparseIndexType_t *csrColIndType, hipsparseIndexBase_t *idxBase, hipDataType *valueType)¶

Description: Get pointers of a sparse CSR matrix.

hipsparseCsrGet gets the fields of the sparse CSR matrix descriptor

hipsparseBlockedEllGet()¶

hipsparseStatus_t hipsparseBlockedEllGet(const hipsparseSpMatDescr_t spMatDescr, int64_t *rows, int64_t *cols, int64_t *ellBlockSize, int64_t *ellCols, void **ellColInd, void **ellValue, hipsparseIndexType_t *ellIdxType, hipsparseIndexBase_t *idxBase, hipDataType *valueType)¶

Description: Get pointers of a sparse blocked ELL matrix.

hipsparseBlockedEllGet gets the fields of the sparse blocked ELL matrix descriptor

hipsparseCsrSetPointers()¶

hipsparseStatus_t hipsparseCsrSetPointers(hipsparseSpMatDescr_t spMatDescr, void *csrRowOffsets, void *csrColInd, void *csrValues)¶

Description: Set pointers of a sparse CSR matrix.

hipsparseCsrSetPointers sets the fields of the sparse CSR matrix descriptor

hipsparseCscSetPointers()¶

hipsparseStatus_t hipsparseCscSetPointers(hipsparseSpMatDescr_t spMatDescr, void *cscColOffsets, void *cscRowInd, void *cscValues)¶

Description: Set pointers of a sparse CSC matrix.

hipsparseCscSetPointers sets the fields of the sparse CSC matrix descriptor

hipsparseCooSetPointers()¶

hipsparseStatus_t hipsparseCooSetPointers(hipsparseSpMatDescr_t spMatDescr, void *cooRowInd, void *cooColInd, void *cooValues)¶

Description: Set pointers of a sparse COO matrix.

hipsparseCooSetPointers sets the fields of the sparse COO matrix descriptor

hipsparseSpMatGetSize()¶

hipsparseStatus_t hipsparseSpMatGetSize(hipsparseSpMatDescr_t spMatDescr, int64_t *rows, int64_t *cols, int64_t *nnz)¶: Description: Get the sizes of a sparse matrix.

hipsparseSpMatGetFormat()¶

hipsparseStatus_t hipsparseSpMatGetFormat(const hipsparseSpMatDescr_t spMatDescr, hipsparseFormat_t *format)¶: Description: Get the format of a sparse matrix.

hipsparseSpMatGetIndexBase()¶

hipsparseStatus_t hipsparseSpMatGetIndexBase(const hipsparseSpMatDescr_t spMatDescr, hipsparseIndexBase_t *idxBase)¶: Description: Get the index base of a sparse matrix.

hipsparseSpMatGetValues()¶

hipsparseStatus_t hipsparseSpMatGetValues(hipsparseSpMatDescr_t spMatDescr, void **values)¶: Description: Get the pointer of the values array of a sparse matrix.

hipsparseSpMatSetValues()¶

hipsparseStatus_t hipsparseSpMatSetValues(hipsparseSpMatDescr_t spMatDescr, void *values)¶: Description: Set the pointer of the values array of a sparse matrix.

hipsparseSpMatGetAttribute()¶

hipsparseStatus_t hipsparseSpMatGetAttribute(hipsparseSpMatDescr_t spMatDescr, hipsparseSpMatAttribute_t attribute, void *data, size_t dataSize)¶: Description: Get attribute from sparse matrix descriptor.

hipsparseSpMatSetAttribute()¶

hipsparseStatus_t hipsparseSpMatSetAttribute(hipsparseSpMatDescr_t spMatDescr, hipsparseSpMatAttribute_t attribute, const void *data, size_t dataSize)¶: Description: Set attribute in sparse matrix descriptor.

hipsparseCreateDnVec()¶

hipsparseStatus_t hipsparseCreateDnVec(hipsparseDnVecDescr_t *dnVecDescr, int64_t size, void *values, hipDataType valueType)¶

Description: Create dense vector.

hipsparseCreateDnVec creates a dense vector descriptor. It should be destroyed at the end using hipsparseDestroyDnVec().

hipsparseDestroyDnVec()¶

hipsparseStatus_t hipsparseDestroyDnVec(hipsparseDnVecDescr_t dnVecDescr)¶

Description: Destroy dense vector.

hipsparseDestroyDnVec destroys a dense vector descriptor and releases all resources used by the descriptor.

hipsparseDnVecGet()¶

hipsparseStatus_t hipsparseDnVecGet(const hipsparseDnVecDescr_t dnVecDescr, int64_t *size, void **values, hipDataType *valueType)¶

Description: Get the fields from a dense vector.

hipsparseDnVecGet gets the fields of the dense vector descriptor

hipsparseDnVecGetValues()¶

hipsparseStatus_t hipsparseDnVecGetValues(const hipsparseDnVecDescr_t dnVecDescr, void **values)¶

Description: Get value pointer from a dense vector.

hipsparseDnVecGetValues gets the fields of the dense vector descriptor

hipsparseDnVecSetValues()¶

hipsparseStatus_t hipsparseDnVecSetValues(hipsparseDnVecDescr_t dnVecDescr, void *values)¶

Description: Set value pointer of a dense vector.

hipsparseDnVecSetValues sets the fields of the dense vector descriptor

hipsparseCreateDnMat()¶

hipsparseStatus_t hipsparseCreateDnMat(hipsparseDnMatDescr_t *dnMatDescr, int64_t rows, int64_t cols, int64_t ld, void *values, hipDataType valueType, hipsparseOrder_t order)¶

Description: Create dense matrix.

hipsparseCreateDnMat creates a dense matrix descriptor. It should be destroyed at the end using hipsparseDestroyDnMat().

hipsparseDestroyDnMat()¶

hipsparseStatus_t hipsparseDestroyDnMat(hipsparseDnMatDescr_t dnMatDescr)¶

Description: Destroy dense matrix.

hipsparseDestroyDnMat destroys a dense matrix descriptor and releases all resources used by the descriptor.

hipsparseDnMatGet()¶

hipsparseStatus_t hipsparseDnMatGet(const hipsparseDnMatDescr_t dnMatDescr, int64_t *rows, int64_t *cols, int64_t *ld, void **values, hipDataType *valueType, hipsparseOrder_t *order)¶: Description: Get fields from a dense matrix.

hipsparseDnMatGetValues()¶

hipsparseStatus_t hipsparseDnMatGetValues(const hipsparseDnMatDescr_t dnMatDescr, void **values)¶: Description: Get value pointer from a dense matrix.

hipsparseDnMatSetValues()¶

hipsparseStatus_t hipsparseDnMatSetValues(hipsparseDnMatDescr_t dnMatDescr, void *values)¶: Description: Set value pointer of a dense matrix.