6. mcSPARSE辅助函数参考

6.1. mcsparseCreateColorInfo()

mcsparseStatus_t
mcsparseCreateColorInfo(mcsparseColorInfo_t* info)

此函数创建 mcsparseColorInfo_t 结构体,并初始化为默认值。

输入

info

指向 mcsparseColorInfo_t 结构体的指针

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.2. mcsparseCreateMatDescr()

mcsparseStatus_t
mcsparseCreateMatDescr(mcsparseMatDescr_t *descrA)

此函数初始化矩阵描述符。 它将字段 MatrixTypeIndexBase 分别设置为默认值 MCSPARSE_MATRIX_TYPE_GENERALMCSPARSE_INDEX_BASE_ZERO,其他字段保持未初始化。

输入

descrA

指向矩阵描述符的指针。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.3. mcsparseDestroyColorInfo()

mcsparseStatus_t
mcsparseDestroyColorInfo(mcsparseColorInfo_t info)

此函数销毁并释放结构体所需的内存。

输入

info

指向 csrcolor() 结构体的指针。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.4. mcsparseDestroyMatDescr()

mcsparseStatus_t
mcsparseDestroyMatDescr(mcsparseMatDescr_t descrA)

此函数释放分配给矩阵描述符的内存。

输入

descrA

矩阵描述符。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.5. mcsparseGetMatDiagType()

mcsparseDiagType_t
mcsparseGetMatDiagType(const mcsparseMatDescr_t descrA)

此函数返回矩阵描述符 descrADiagType 字段。

输入

descrA

矩阵描述符。

返回

DiagType

枚举diagType类型之一。

6.6. mcsparseGetMatFillMode()

mcsparseFillMode_t
mcsparseGetMatFillMode(const mcsparseMatDescr_t descrA)

此函数返回矩阵描述符 descrAFillMode 字段。

输入

descrA

矩阵描述符。

返回

FillMode

枚举fillMode类型之一。

6.7. mcsparseGetMatIndexBase()

mcsparseIndexBase_t
mcsparseGetMatIndexBase(const mcsparseMatDescr_t descrA)

此函数返回矩阵描述符 descrAIndexBase 字段

输入

descrA

矩阵描述符。

返回

IndexBase

枚举indexBase类型之一。

6.8. mcsparseGetMatType()

mcsparseMatrixType_t
mcsparseGetMatType(const mcsparseMatDescr_t descrA)

此函数返回矩阵描述符 descrAMatrixType 字段。

输入

descrA

矩阵描述符。

返回

MatrixType

枚举matrixType类型之一。

6.9. mcsparseSetMatDiagType()

mcsparseStatus_t
mcsparseSetMatDiagType(mcsparseMatDescr_t descrA,
                        mcsparseDiagType_t diagType)

此函数设置矩阵描述符 descrADiagType 字段。

输入

diagType

枚举diagType类型之一。

输出

descrA

矩阵描述符。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.10. mcsparseSetMatFillMode()

mcsparseStatus_t
mcsparseSetMatFillMode(mcsparseMatDescr_t descrA,
                        mcsparseFillMode_t fillMode)

此函数设置矩阵描述符 descrAFillMode 字段。

输入

fillMode

枚举fillMode类型之一。

输出

descrA

矩阵描述符。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.11. mcsparseSetMatIndexBase()

mcsparseStatus_t
mcsparseSetMatIndexBase(mcsparseMatDescr_t descrA,
                        mcsparseIndexBase_t base)

此函数设置矩阵描述符 descrAIndexBase 字段。

输入

base

枚举indexBase类型之一。

输出

descrA

矩阵描述符。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.12. mcsparseSetMatType()

mcsparseStatus_t
mcsparseSetMatType(mcsparseMatDescr_t descrA, mcsparseMatrixType_t type)

此函数设置矩阵描述符 descrAMatrixType 字段

输入

type

枚举matrixType类型之一。

输出

descrA

矩阵描述符。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.13. mcsparseCreateCsrsv2Info()

mcsparseStatus_t
mcsparseCreateCsrsv2Info(csrsv2Info_t *info);

此函数创建csrsv2的求解和分析结构,并初始化为默认值。

输入

info

指向csrsv2的求解和分析结构的指针。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.14. mcsparseDestroyCsrsv2Info()

mcsparseStatus_t
mcsparseDestroyCsrsv2Info(csrsv2Info_t info);

此函数销毁并释放结构体所需的内存。

输入

info

求解结构体 (csrsv2_solve) 和分析结构体 (csrsv2_analysis)

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.15. mcsparseCreateCsrsm2Info()

mcsparseStatus_t
mcsparseCreateCsrsm2Info(csrsm2Info_t *info);

此函数创建csrsm2的求解和分析结构,并初始化为默认值。

输入

info

指向csrsm2的求解和分析结构的指针。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.16. mcsparseDestroyCsrsm2Info()

mcsparseStatus_t
mcsparseDestroyCsrsm2Info(csrsm2Info_t info);

此函数销毁并释放结构所需的内存。

输入

info

求解结构体 (csrsm2_solve) 和分析结构体 (csrsm2_analysis)

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.17. mcsparseCreateCsric02Info()

mcsparseStatus_t
mcsparseCreateCsric02Info(csric02Info_t *info);

此函数创建不完全Cholesky的求解结构体和分析结构体,并初始化为默认值。

输入

info

指向不完全Cholesky求解结构体和分析结构体的指针。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.18. mcsparseDestroyCsric02Info()

mcsparseStatus_t
mcsparseDestroyCsric02Info(csric02Info_t info);

此函数会销毁并释放由结构体所需的内存。

输入

info

求解结构体 (csric02_solve) 和分析结构体 (csric02_analysis)

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.19. mcsparseCreateCsrilu02Info()

mcsparseStatus_t
mcsparseCreateCsrilu02Info(csrilu02Info_t *info);

此函数创建不完全LU分解中的求解结构体和分析结构体,并初始化为默认值。

输入

info

指向不完全LU求解结构体和分析结构体的指针。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.20. mcsparseDestroyCsrilu02Info()

mcsparseStatus_t
mcsparseDestroyCsrilu02Info(csrilu02Info_t info);

此函数销毁并释放结构体所需的内存。

输入

info

求解结构体 (csrilu02_solve) 和分析结构体 (csrilu02_analysis)

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.21. mcsparseCreateBsrsv2Info()

mcsparseStatus_t
mcsparseCreateBsrsv2Info(bsrsv2Info_t *info);

此函数创建BSRSV2中的求解结构体和分析结构体,并初始化默认值。

输入

info

指向BSRSV2求解结构体和分析结构体的指针。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.22. mcsparseDestroyBsrsv2Info()

mcsparseStatus_t
mcsparseDestroyBsrsv2Info(bsrsv2Info_t info);

此函数销毁并释放结构体所需的内存。

输入

info

求解结构体 (bsrsv2_solve) 和分析结构体 (bsrsv2_analysis)

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.23. mcsparseCreateCsrgemm2Info()

mcsparseStatus_t
mcsparseCreateCsrgemm2Info(csrgemm2Info_t *info);

此函数创建一般稀疏矩阵乘法的分析结构体,并将其初始化。

输入

info

指向一般稀疏矩阵乘法分析结构体的指针。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.24. mcsparseDestroyCsrgemm2Info()

mcsparseStatus_t
mcsparseDestroyCsrgemm2Info(csrgemm2Info_t info);

此函数销毁并释放结构体所需的内存。

输入

info

csrgemm2的不透明结构体。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.25. mcsparseCreatePruneInfo()

mcsparseStatus_t
mcsparseCreatePruneInfo(pruneInfo_t *info);

此函数创建了名为 prune 的结构体,并初始化为默认值。

输入

info

指向 prune 结构体的指针。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t

6.26. mcsparseDestroyPruneInfo()

mcsparseStatus_t
mcsparseDestroyPruneInfo(pruneInfo_t info);

此函数销毁并释放了结构体所需的任何内存。

输入

info

prune 结构体。

有关返回状态的描述,请参见 4.2 mcsparseStatus_t