Skip to main content
`Ctrl`+`K`

# rocSPARSE data types

## rocsparse_handle

typedef struct _rocsparse_handle *rocsparse_handle

  Handle to the rocSPARSE library context queue.

  The rocSPARSE handle is a structure holding the rocSPARSE library context. It must be initialized using rocsparse_create_handle() and the returned handle must be passed to all subsequent library function calls. It should be destroyed at the end using rocsparse_destroy_handle().

## rocsparse_error

typedef struct _rocsparse_error *rocsparse_error

  Descriptor of the error.

  The rocSPARSE error descriptor is a structure holding the information related to an error that occured during the execution of a rocSPARSE routine. It should be destroyed using rocsparse_destroy_error().

## rocsparse_int

typedef int32_t rocsparse_int

  Specifies rocSPARSE integer type (defaults to int32_t).

  Note

  When rocSPARSE is built with rocsparse_ILP64, rocsparse_int is typedef to int64_t.

## rocsparse_bfloat16

struct rocsparse_bfloat16

  Struct to represent a 16 bit brain floating-point number.

## rocsparse_float_complex

struct rocsparse_float_complex

  Struct to represent a complex number with float precision real and imaginary parts.

## rocsparse_double_complex

struct rocsparse_double_complex

  Struct to represent a complex number with double precision real and imaginary parts.

## rocsparse_mat_descr

typedef struct _rocsparse_mat_descr *rocsparse_mat_descr

  Descriptor of the matrix.

  The rocSPARSE matrix descriptor is a structure holding all properties of a matrix. It must be initialized using rocsparse_create_mat_descr() and the returned descriptor must be passed to all subsequent library calls that involve the matrix. It should be destroyed at the end using rocsparse_destroy_mat_descr().

## rocsparse_mat_info

typedef struct _rocsparse_mat_info *rocsparse_mat_info

  Info structure to hold all matrix meta data.

  The rocSPARSE matrix info is a structure holding all matrix information that is gathered during analysis routines. It must be initialized using rocsparse_create_mat_info() and the returned info structure must be passed to all subsequent library calls that require additional matrix information. It should be destroyed at the end using rocsparse_destroy_mat_info().

## rocsparse_hyb_mat

typedef struct _rocsparse_hyb_mat *rocsparse_hyb_mat

  HYB matrix storage format.

  The rocSPARSE HYB matrix structure holds the HYB matrix. It must be initialized using rocsparse_create_hyb_mat() and the returned HYB matrix must be passed to all subsequent library calls that involve the matrix. It should be destroyed at the end using rocsparse_destroy_hyb_mat().

For more details on the HYB format, see HYB storage format.

## rocsparse_spvec_descr

typedef struct _rocsparse_spvec_descr *rocsparse_spvec_descr

  Generic API descriptor of the sparse vector.

  The rocSPARSE sparse vector descriptor is a structure holding all properties of a sparse vector. It must be initialized using rocsparse_create_spvec_descr() and the returned descriptor must be passed to all subsequent generic API library calls that involve the sparse vector. It should be destroyed at the end using rocsparse_destroy_spvec_descr().

## rocsparse_const_spvec_descr

typedef struct _rocsparse_spvec_descr const *rocsparse_const_spvec_descr

  Generic API descriptor of the sparse vector.

  The rocSPARSE constant sparse vector descriptor is a structure holding all properties of a sparse vector. It must be initialized using rocsparse_create_const_spvec_descr() and the returned descriptor must be passed to all subsequent generic API library calls that involve the sparse vector. It should be destroyed at the end using rocsparse_destroy_spvec_descr().

## rocsparse_spmat_descr

typedef struct _rocsparse_spmat_descr *rocsparse_spmat_descr

  Generic API descriptor of the sparse matrix.

  The rocSPARSE sparse matrix descriptor is a structure holding all properties of a sparse matrix. It must be initialized using rocsparse_create_coo_descr(), rocsparse_create_coo_aos_descr(), rocsparse_create_bsr_descr(), rocsparse_create_csr_descr(), rocsparse_create_csc_descr(), rocsparse_create_ell_descr(), or rocsparse_create_bell_descr() and the returned descriptor must be passed to all subsequent generic API library calls that involve the sparse matrix. It should be destroyed at the end using rocsparse_destroy_spmat_descr().

## rocsparse_const_spmat_descr

typedef struct _rocsparse_spmat_descr const *rocsparse_const_spmat_descr

  Generic API descriptor of the sparse matrix.

  The rocSPARSE constant sparse matrix descriptor is a structure holding all properties of a sparse matrix. It must be initialized using rocsparse_create_const_coo_descr(), rocsparse_create_const_csr_descr(), rocsparse_create_const_csc_descr(), or rocsparse_create_const_bell_descr() and the returned descriptor must be passed to all subsequent generic API library calls that involve the sparse matrix. It should be destroyed at the end using rocsparse_destroy_spmat_descr().

## rocsparse_dnvec_descr

typedef struct _rocsparse_dnvec_descr *rocsparse_dnvec_descr

  Generic API descriptor of the dense vector.

  The rocSPARSE dense vector descriptor is a structure holding all properties of a dense vector. It must be initialized using rocsparse_create_dnvec_descr() and the returned descriptor must be passed to all subsequent generic API library calls that involve the dense vector. It should be destroyed at the end using rocsparse_destroy_dnvec_descr().

## rocsparse_const_dnvec_descr

typedef struct _rocsparse_dnvec_descr const *rocsparse_const_dnvec_descr

  Generic API descriptor of the dense vector.

  The rocSPARSE constant dense vector descriptor is a structure holding all properties of a dense vector. It must be initialized using rocsparse_create_const_dnvec_descr() and the returned descriptor must be passed to all subsequent generic API library calls that involve the dense vector. It should be destroyed at the end using rocsparse_destroy_dnvec_descr().

## rocsparse_dnmat_descr

typedef struct _rocsparse_dnmat_descr *rocsparse_dnmat_descr

  Generic API descriptor of the dense matrix.

  The rocSPARSE dense matrix descriptor is a structure holding all properties of a dense matrix. It must be initialized using rocsparse_create_dnmat_descr() and the returned descriptor must be passed to all subsequent generic API library calls that involve the dense matrix. It should be destroyed at the end using rocsparse_destroy_dnmat_descr().

## rocsparse_const_dnmat_descr

typedef struct _rocsparse_dnmat_descr const *rocsparse_const_dnmat_descr

  Generic API descriptor of the dense matrix.

  The rocSPARSE constant dense matrix descriptor is a structure holding all properties of a dense matrix. It must be initialized using rocsparse_create_const_dnmat_descr() and the returned descriptor must be passed to all subsequent generic API library calls that involve the dense matrix. It should be destroyed at the end using rocsparse_destroy_dnmat_descr().

## rocsparse_color_info

typedef struct _rocsparse_color_info *rocsparse_color_info

  Coloring info structure to hold data gathered during analysis and later used in rocSPARSE sparse matrix coloring routines.

  The rocSPARSE color info is a structure holding coloring data that is gathered during analysis routines. It must be initialized using rocsparse_create_color_info() and the returned info structure must be passed to all subsequent library calls that require coloring information. It should be destroyed at the end using rocsparse_destroy_color_info().

## rocsparse_sparse_to_sparse_descr

typedef struct _rocsparse_sparse_to_sparse_descr *rocsparse_sparse_to_sparse_descr

  rocsparse_sparse_to_sparse_descr is a structure holding the rocsparse sparse_to_sparse descr data. It must be initialized using the rocsparse_create_sparse_to_sparse_descr() routine. It should be destroyed at the end using rocsparse_destroy_sparse_to_sparse_descr().

## rocsparse_extract_descr

typedef struct _rocsparse_extract_descr *rocsparse_extract_descr

  rocsparse_extract_descr is a structure holding the rocsparse extract descr data. It must be initialized using the rocsparse_create_extract_descr() routine. It should be destroyed at the end using rocsparse_destroy_extract_descr().