clSPARSE  v0.10.0.0
a software library containing Sparse functions written in OpenCL
Library setup or teardown functions

Functions to control the lifetime of the clSPARSE library. More...

CLSPARSE_EXPORT clsparseStatus clsparseSetup (void)
 Initialize the clsparse library. More...
 
CLSPARSE_EXPORT clsparseStatus clsparseTeardown (void)
 Finalize the usage of the clsparse library Frees all state allocated by the clsparse runtime and other internal data. More...
 
CLSPARSE_EXPORT clsparseStatus clsparseGetVersion (cl_uint *major, cl_uint *minor, cl_uint *patch, cl_uint *tweak)
 Query for the runtime clsparse library version info. More...
 

Detailed Description

Functions to control the lifetime of the clSPARSE library.

Function Documentation

CLSPARSE_EXPORT clsparseStatus clsparseGetVersion ( cl_uint *  major,
cl_uint *  minor,
cl_uint *  patch,
cl_uint *  tweak 
)

Query for the runtime clsparse library version info.

Parameters
[out]majorlibrary's major version
[out]minorlibrary's minor version
[out]patchlibrary's patch version
[out]tweaklibrary's tweak version
Returns
clsparseSuccess
CLSPARSE_EXPORT clsparseStatus clsparseSetup ( void  )

Initialize the clsparse library.

Note
Must be called before any other clsparse API function is invoked.
Returns
clsparseSuccess
Examples:
sample-axpy.cpp, sample-cg.cpp, sample-initialization-c.c, sample-initialization.cpp, sample-norm1-c.c, and sample-spmv.cpp.
CLSPARSE_EXPORT clsparseStatus clsparseTeardown ( void  )

Finalize the usage of the clsparse library Frees all state allocated by the clsparse runtime and other internal data.

Returns
clsparseSuccess
Examples:
sample-axpy.cpp, sample-cg.cpp, sample-initialization-c.c, sample-initialization.cpp, sample-norm1-c.c, and sample-spmv.cpp.