Exported rocSPARSE functions

Contents

Exported rocSPARSE functions#

This topic provides a list of the exported rocSPARSE functions in various categories.

ROC-TX functions#

Function name

rocsparse_enable_roctx()

rocsparse_disable_roctx()

rocsparse_state_roctx()

Auxiliary functions#

Function name

rocsparse_create_handle()

rocsparse_destroy_handle()

rocsparse_set_stream()

rocsparse_get_stream()

rocsparse_set_pointer_mode()

rocsparse_get_pointer_mode()

rocsparse_get_version()

rocsparse_get_git_rev()

rocsparse_destroy_error()

rocsparse_error_get_message()

rocsparse_create_mat_descr()

rocsparse_destroy_mat_descr()

rocsparse_copy_mat_descr()

rocsparse_set_mat_index_base()

rocsparse_get_mat_index_base()

rocsparse_set_mat_type()

rocsparse_get_mat_type()

rocsparse_set_mat_fill_mode()

rocsparse_get_mat_fill_mode()

rocsparse_set_mat_diag_type()

rocsparse_get_mat_diag_type()

rocsparse_set_mat_storage_mode()

rocsparse_get_mat_storage_mode()

rocsparse_create_hyb_mat()

rocsparse_destroy_hyb_mat()

rocsparse_copy_hyb_mat()

rocsparse_create_mat_info()

rocsparse_copy_mat_info()

rocsparse_destroy_mat_info()

rocsparse_create_color_info()

rocsparse_destroy_color_info()

rocsparse_copy_color_info()

rocsparse_create_spvec_descr()

rocsparse_destroy_spvec_descr()

rocsparse_spvec_get()

rocsparse_spvec_get_index_base()

rocsparse_spvec_get_values()

rocsparse_spvec_set_values()

rocsparse_create_coo_descr()

rocsparse_create_coo_aos_descr()

rocsparse_create_csr_descr()

rocsparse_create_csc_descr()

rocsparse_create_ell_descr()

rocsparse_create_bsr_descr()

rocsparse_create_bell_descr()

rocsparse_create_const_coo_descr()

rocsparse_create_const_csr_descr()

rocsparse_create_const_csc_descr()

rocsparse_create_const_bell_descr()

rocsparse_destroy_spmat_descr()

rocsparse_create_extract_descr()

rocsparse_destroy_extract_descr()

rocsparse_create_sparse_to_sparse_descr()

rocsparse_destroy_sparse_to_sparse_descr()

rocsparse_sparse_to_sparse_permissive()

rocsparse_create_spgeam_descr()

rocsparse_destroy_spgeam_descr()

rocsparse_spgeam_set_input()

rocsparse_spgeam_get_output()

rocsparse_create_spmv_descr()

rocsparse_destroy_spmv_descr()

rocsparse_spmv_set_input()

rocsparse_coo_get()

rocsparse_coo_aos_get()

rocsparse_csr_get()

rocsparse_ell_get()

rocsparse_bell_get()

rocsparse_coo_set_pointers()

rocsparse_coo_aos_set_pointers()

rocsparse_csr_set_pointers()

rocsparse_csc_set_pointers()

rocsparse_ell_set_pointers()

rocsparse_bsr_set_pointers()

rocsparse_spmat_get_size()

rocsparse_spmat_get_nnz()

rocsparse_spmat_get_format()

rocsparse_spmat_get_index_base()

rocsparse_spmat_get_values()

rocsparse_spmat_set_values()

rocsparse_spmat_get_strided_batch()

rocsparse_spmat_set_strided_batch()

rocsparse_coo_set_strided_batch()

rocsparse_csr_set_strided_batch()

rocsparse_csc_set_strided_batch()

rocsparse_spmat_get_attribute()

rocsparse_spmat_set_attribute()

rocsparse_create_dnvec_descr()

rocsparse_create_const_dnvec_descr()

rocsparse_destroy_dnvec_descr()

rocsparse_dnvec_get()

rocsparse_dnvec_get_values()

rocsparse_dnvec_set_values()

rocsparse_create_dnmat_descr()

rocsparse_create_const_dnmat_descr()

rocsparse_destroy_dnmat_descr()

rocsparse_dnmat_get()

rocsparse_dnmat_get_values()

rocsparse_dnmat_set_values()

rocsparse_dnmat_get_strided_batch()

rocsparse_dnmat_set_strided_batch()

Sparse level 1 functions#

Function name	single	double	single complex	double complex
`rocsparse_Xaxpyi()`	x	x	x	x
`rocsparse_Xdoti()`	x	x	x	x
`rocsparse_Xdotci()`			x	x
`rocsparse_Xgthr()`	x	x	x	x
`rocsparse_Xgthrz()`	x	x	x	x
`rocsparse_Xroti()`	x	x
`rocsparse_Xsctr()`	x	x	x	x

Sparse level 2 functions#

Function name	single	double	single complex	double complex
`rocsparse_Xbsrmv_analysis()`	x	x	x	x
`rocsparse_bsrmv_clear()`
`rocsparse_Xbsrmv()`	x	x	x	x
`rocsparse_Xbsrxmv()`	x	x	x	x
`rocsparse_Xbsrsv_buffer_size()`	x	x	x	x
`rocsparse_Xbsrsv_analysis()`	x	x	x	x
`rocsparse_bsrsv_zero_pivot()`
`rocsparse_bsrsv_clear()`
`rocsparse_Xbsrsv_solve()`	x	x	x	x
`rocsparse_Xcoomv()`	x	x	x	x
`rocsparse_Xcsrmv_analysis()`	x	x	x	x
`rocsparse_csrmv_clear()`
`rocsparse_Xcsrmv()`	x	x	x	x
`rocsparse_Xcsrsv_buffer_size()`	x	x	x	x
`rocsparse_Xcsrsv_analysis()`	x	x	x	x
`rocsparse_csrsv_zero_pivot()`
`rocsparse_csrsv_clear()`
`rocsparse_Xcsrsv_solve()`	x	x	x	x
`rocsparse_Xcsritsv_buffer_size()`	x	x	x	x
`rocsparse_Xcsritsv_analysis()`	x	x	x	x
`rocsparse_csritsv_zero_pivot()`
`rocsparse_csritsv_clear()`
`rocsparse_Xcsritsv_solve()`	x	x	x	x
`rocsparse_Xcsritsv_solve_ex()`	x	x	x	x
`rocsparse_Xellmv()`	x	x	x	x
`rocsparse_Xhybmv()`	x	x	x	x
`rocsparse_Xgebsrmv()`	x	x	x	x
`rocsparse_Xgemvi_buffer_size()`	x	x	x	x
`rocsparse_Xgemvi()`	x	x	x	x

Sparse level 3 functions#

Function name	single	double	single complex	double complex
`rocsparse_Xbsrmm()`	x	x	x	x
`rocsparse_Xgebsrmm()`	x	x	x	x
`rocsparse_Xcsrmm()`	x	x	x	x
`rocsparse_Xcsrsm_buffer_size()`	x	x	x	x
`rocsparse_Xcsrsm_analysis()`	x	x	x	x
`rocsparse_csrsm_zero_pivot()`
`rocsparse_csrsm_clear()`
`rocsparse_Xcsrsm_solve()`	x	x	x	x
`rocsparse_Xbsrsm_buffer_size()`	x	x	x	x
`rocsparse_Xbsrsm_analysis()`	x	x	x	x
`rocsparse_bsrsm_zero_pivot()`
`rocsparse_bsrsm_clear()`
`rocsparse_Xbsrsm_solve()`	x	x	x	x
`rocsparse_Xgemmi()`	x	x	x	x

Sparse extra functions#

Function name	single	double	single complex	double complex
`rocsparse_bsrgeam_nnzb()`
`rocsparse_Xbsrgeam()`	x	x	x	x
`rocsparse_Xbsrgemm_buffer_size()`	x	x	x	x
`rocsparse_bsrgemm_nnzb()`
`rocsparse_Xbsrgemm()`	x	x	x	x
`rocsparse_csrgeam_nnz()`
`rocsparse_Xcsrgeam()`	x	x	x	x
`rocsparse_Xcsrgemm_buffer_size()`	x	x	x	x
`rocsparse_csrgemm_nnz()`
`rocsparse_csrgemm_symbolic()`
`rocsparse_Xcsrgemm()`	x	x	x	x
`rocsparse_Xcsrgemm_numeric()`	x	x	x	x

Preconditioner functions#

Function name	single	double	single complex	double complex
`rocsparse_Xbsric0_buffer_size()`	x	x	x	x
`rocsparse_Xbsric0_analysis()`	x	x	x	x
`rocsparse_bsric0_zero_pivot()`
`rocsparse_bsric0_clear()`
`rocsparse_Xbsric0()`	x	x	x	x
`rocsparse_Xbsrilu0_buffer_size()`	x	x	x	x
`rocsparse_Xbsrilu0_analysis()`	x	x	x	x
`rocsparse_bsrilu0_zero_pivot()`
`rocsparse_Xbsrilu0_numeric_boost()`	x	x	x	x
`rocsparse_bsrilu0_clear()`
`rocsparse_Xbsrilu0()`	x	x	x	x
`rocsparse_Xcsric0_buffer_size()`	x	x	x	x
`rocsparse_Xcsric0_analysis()`	x	x	x	x
`rocsparse_csric0_zero_pivot()`
`rocsparse_csric0_clear()`
`rocsparse_Xcsric0()`	x	x	x	x
`rocsparse_Xcsrilu0_buffer_size()`	x	x	x	x
`rocsparse_Xcsrilu0_numeric_boost()`	x	x	x	x
`rocsparse_Xcsrilu0_analysis()`	x	x	x	x
`rocsparse_csrilu0_zero_pivot()`
`rocsparse_csrilu0_clear()`
`rocsparse_Xcsrilu0()`	x	x	x	x
`rocsparse_csritilu0_buffer_size()`
`rocsparse_csritilu0_preprocess()`
`rocsparse_Xcsritilu0_compute()`	x	x	x	x
`rocsparse_Xcsritilu0_compute_ex()`	x	x	x	x
`rocsparse_Xcsritilu0_history()`	x	x	x	x
`rocsparse_Xgtsv_buffer_size()`	x	x	x	x
`rocsparse_Xgtsv()`	x	x	x	x
`rocsparse_Xgtsv_no_pivot_buffer_size()`	x	x	x	x
`rocsparse_Xgtsv_no_pivot()`	x	x	x	x
`rocsparse_Xgtsv_no_pivot_strided_batch_buffer_size()`	x	x	x	x
`rocsparse_Xgtsv_no_pivot_strided_batch()`	x	x	x	x
`rocsparse_Xgtsv_interleaved_batch_buffer_size()`	x	x	x	x
`rocsparse_Xgtsv_interleaved_batch()`	x	x	x	x
`rocsparse_Xgpsv_interleaved_batch_buffer_size()`	x	x	x	x
`rocsparse_Xgpsv_interleaved_batch()`	x	x	x	x

Conversion functions#

Function name	single	double	single complex	double complex
`rocsparse_csr2coo()`
`rocsparse_csr2csc_buffer_size()`
`rocsparse_Xcsr2csc()`	x	x	x	x
`rocsparse_Xgebsr2gebsc_buffer_size()`	x	x	x	x
`rocsparse_Xgebsr2gebsc()`	x	x	x	x
`rocsparse_csr2ell_width()`
`rocsparse_Xcsr2ell()`	x	x	x	x
`rocsparse_Xcsr2hyb()`	x	x	x	x
`rocsparse_csr2bsr_nnz()`
`rocsparse_Xcsr2bsr()`	x	x	x	x
`rocsparse_csr2gebsr_nnz()`
`rocsparse_Xcsr2gebsr_buffer_size()`	x	x	x	x
`rocsparse_Xcsr2gebsr()`	x	x	x	x
`rocsparse_coo2csr()`
`rocsparse_ell2csr_nnz()`
`rocsparse_Xell2csr()`	x	x	x	x
`rocsparse_hyb2csr_buffer_size()`
`rocsparse_Xhyb2csr()`	x	x	x	x
`rocsparse_Xbsr2csr()`	x	x	x	x
`rocsparse_Xgebsr2csr()`	x	x	x	x
`rocsparse_Xgebsr2gebsr_buffer_size()`	x	x	x	x
`rocsparse_gebsr2gebsr_nnz()`
`rocsparse_Xgebsr2gebsr()`	x	x	x	x
`rocsparse_Xcsr2csr_compress()`	x	x	x	x
`rocsparse_create_identity_permutation()`
`rocsparse_inverse_permutation()`
`rocsparse_cscsort_buffer_size()`
`rocsparse_cscsort()`
`rocsparse_csrsort_buffer_size()`
`rocsparse_csrsort()`
`rocsparse_coosort_buffer_size()`
`rocsparse_coosort_by_row()`
`rocsparse_coosort_by_column()`
`rocsparse_Xdense2csr()`	x	x	x	x
`rocsparse_Xdense2csc()`	x	x	x	x
`rocsparse_Xdense2coo()`	x	x	x	x
`rocsparse_Xcsr2dense()`	x	x	x	x
`rocsparse_Xcsc2dense()`	x	x	x	x
`rocsparse_Xcoo2dense()`	x	x	x	x
`rocsparse_Xnnz_compress()`	x	x	x	x
`rocsparse_Xnnz()`	x	x	x	x
`rocsparse_Xprune_dense2csr_buffer_size()`	x	x
`rocsparse_Xprune_dense2csr_nnz()`	x	x
`rocsparse_Xprune_dense2csr()`	x	x
`rocsparse_Xprune_csr2csr_buffer_size()`	x	x
`rocsparse_Xprune_csr2csr_nnz()`	x	x
`rocsparse_Xprune_csr2csr()`	x	x
`rocsparse_Xprune_dense2csr_by_percentage_buffer_size()`	x	x
`rocsparse_Xprune_dense2csr_nnz_by_percentage()`	x	x
`rocsparse_Xprune_dense2csr_by_percentage()`	x	x
`rocsparse_Xprune_csr2csr_by_percentage_buffer_size()`	x	x
`rocsparse_Xprune_csr2csr_nnz_by_percentage()`	x	x
`rocsparse_Xprune_csr2csr_by_percentage()`	x	x
`rocsparse_Xbsrpad_value()`	x	x	x	x

Reordering functions#

Function name	single	double	single complex	double complex
`rocsparse_Xcsrcolor()`	x	x	x	x

Utility functions#

Function name	single	double	single complex	double complex
`rocsparse_Xcheck_matrix_csr_buffer_size()`	x	x	x	x
`rocsparse_Xcheck_matrix_csr()`	x	x	x	x
`rocsparse_Xcheck_matrix_csc_buffer_size()`	x	x	x	x
`rocsparse_Xcheck_matrix_csc()`	x	x	x	x
`rocsparse_Xcheck_matrix_coo_buffer_size()`	x	x	x	x
`rocsparse_Xcheck_matrix_coo()`	x	x	x	x
`rocsparse_Xcheck_matrix_gebsr_buffer_size()`	x	x	x	x
`rocsparse_Xcheck_matrix_gebsr()`	x	x	x	x
`rocsparse_Xcheck_matrix_gebsc_buffer_size()`	x	x	x	x
`rocsparse_Xcheck_matrix_gebsc()`	x	x	x	x
`rocsparse_Xcheck_matrix_ell_buffer_size()`	x	x	x	x
`rocsparse_Xcheck_matrix_ell()`	x	x	x	x
`rocsparse_check_matrix_hyb_buffer_size()`	x	x	x	x
`rocsparse_check_matrix_hyb()`	x	x	x	x

Sparse generic functions#

The generic API allows different combinations of data types and compute types to be used. See the specific routine documentation for details about the supported data types and compute types.