5. mcSPARSE管理函数参考

本章节描述管理库的mcSPARSE函数。

5.1. mcsparseCreate()

mcsparseStatus_t
mcsparseCreate(mcsparseHandle_t *handle)

此函数初始化mcSPARSE库并在mcSPARSE上下文中创建一个句柄。 必须在调用任何其他 mcSPARSE API 函数之前调用此函数。 它分配访问GPU所需的硬件资源。

参数	输入/输出	含义
handle	输入	指向mcSPARSE上下文句柄的指针。

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

5.2. mcsparseDestroy()

mcsparseStatus_t
mcsparseDestroy(mcsparseHandle_t handle)

此函数用于释放mcSPARSE库所使用的CPU端资源。 GPU端资源的释放可能会延迟到应用程序关闭时。

参数	输入/输出	含义
handle	输入	处理mcSPARSE上下文的句柄。

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

5.3. mcsparseGetErrorName()

const char*
mcsparseGetErrorString(mcsparseStatus_t status)

此函数返回错误代码枚举名称的字符串表示。 如果错误代码未被识别，则返回 unrecognized error code。

参数	输入/输出	含义
status	输入	要转换为字符串的错误代码。
const char*	输出	指向以NULL结尾字符串的指针。

5.4. mcsparseGetErrorString()

const char*
mcsparseGetErrorString(mcsparseStatus_t status)

返回错误代码的描述字符串。 如果错误代码未被识别，则返回 unrecognized error code。

参数	输入/输出	含义
status	输入	要转换为字符串的错误代码。
const char*	输出	指向以NULL结尾字符串的指针。

5.5. mcsparseGetProperty()

mcsparseStatus_t
mcsparseGetProperty(libraryPropertyType type,
                     int*                value)

此函数返回请求属性的值。 支持的属性类型，请参见下方 libraryPropertyType 。

参数	输入/输出	含义
type	输入	请求的属性。
value	输出	请求属性的值。

libraryPropertyType （在 library_types.h 中定义）：

值	含义
MAJOR_VERSION	枚举器，用于查询主要版本号。
MINOR_VERSION	枚举器，用于查询次要版本号。
PATCH_LEVEL	用于标识补丁级别的编号。

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

5.6. mcsparseGetVersion()

mcsparseStatus_t
mcsparseGetVersion(mcsparseHandle_t handle,
                     int*             version)

此函数返回mcSPARSE库的版本号。

参数	输入/输出	含义
handle	输入	mcSPARSE句柄
version	输出	库的版本号

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

5.7. mcsparseGetPointerMode()

mcsparseStatus_t
mcsparseGetPointerMode(mcsparseHandlet handle,
                        mcsparsePointerMode_t *mode)

此函数获取mcSPARSE库使用的指针模式。更多详细信息，请参见 4.4 mcsparsePointerMode_t。

参数	输入/输出	含义
handle	输入	处理mcSPARSE上下文的句柄。
mode	输出	枚举指针模式类型之一。

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

5.8. mcsparseSetPointerMode()

mcsparseStatus_t
mcsparseSetPointerMode(mcsparseHandle_t handle,
                        mcsparsePointerMode_t mode)

此函数设置mcSPARSE库使用的指针模式。 默认是将值通过引用传递到主机上。更多详细信息，请参见 4.4 mcsparsePointerMode_t。

参数	输入/输出	含义
handle	输入	处理mcSPARSE上下文的句柄。
mode	输入	枚举指针模式类型之一。

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

5.9. mcsparseGetStream()

mcsparseStatus_t
mcsparseGetStream(mcsparseHandle_t handle, macaStream_t *streamId)

此函数获取mcSPARSE库的流，该流用于执行所有对mcSPARSE库函数的调用。 如果mcSPARSE库的流未进行设置，则所有核都使用默认的NULL流。

参数	输入/输出	含义
handle	输入	处理mcSPARSE上下文的句柄。
streamId	输出	库使用的流(stream)

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

5.10. mcsparseSetStream()

mcsparseStatus_t
mcsparseSetStream(mcsparseHandle_t handle, macaStream_t streamId)

此函数设置mcSPARSE库要使用的流，用于执行其例程。

参数	输入/输出	含义
handle	输入	处理mcSPARSE上下文的句柄。
streamId	输入	库使用的流(stream)

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