rocsparse_bsr_get Interface Reference

rocsparse_bsr_get Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_bsr_get Interface Reference

Get the fields of the sparse BSR matrix descriptor. More...

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_bsr_get_ (descr, brows, bcols, bnnz, block_dir, block_dim, bsr_row_ptr, bsr_col_ind, bsr_val, row_ptr_type, col_ind_type, idx_base, data_type)

Get the fields of the sparse BSR matrix descriptor.

rocsparse_bsr_get gets the fields of the sparse BSR matrix descriptor.

Parameters

[in]	descr	- the pointer to the sparse BSR matrix descriptor.
[out]	brows	- number of block rows in the BSR matrix.
[out]	bcols	- number of block columns in the BSR matrix.
[out]	bnnz	- number of non-zero blocks in the BSR matrix.
[out]	block_dir	- storage layout of the dense block matrices.
[out]	block_dim	- block dimension.
[out]	bsr_row_ptr	- row offsets of the BSR matrix. Must be an array of length `brows+1`.
[out]	bsr_col_ind	- column indices of the BSR matrix. Must be an array of length `bnnz`.
[out]	bsr_val	- values of the BSR matrix (must be array of length `bnnz` * `block_dim` * `block_dim` ).
[out]	row_ptr_type	- `rocsparse_indextype_i32` or `rocsparse_indextype_i64`.
[out]	col_ind_type	- `rocsparse_indextype_i32` or `rocsparse_indextype_i64`.
[out]	idx_base	- `rocsparse_index_base_zero` or `rocsparse_index_base_one`.
[out]	data_type	- `rocsparse_datatype_f32_r`, `rocsparse_datatype_f64_r`, `rocsparse_datatype_f32_c`, or `rocsparse_datatype_f64_c`.

Return values

rocsparse_status_success	the operation completed successfully.
rocsparse_status_invalid_pointer	if `descr`, `brows`, `bcols`, `bnnz`, `block_dir`, `block_dim`, `bsr_row_ptr`, `bsr_col_ind`, `bsr_val`, `row_ptr_type`, `col_ind_type`, `idx_base`, or `data_type` is invalid.
rocsparse_status_not_initialized	if `descr` has not been initialized.

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_bsr_get::rocsparse_bsr_get_	(	type(c_ptr), value	descr,
		type(c_ptr), value	brows,
		type(c_ptr), value	bcols,
		type(c_ptr), value	bnnz,
		type(c_ptr), value	block_dir,
		type(c_ptr), value	block_dim,
		type(c_ptr)	bsr_row_ptr,
		type(c_ptr)	bsr_col_ind,
		type(c_ptr)	bsr_val,
		type(c_ptr), value	row_ptr_type,
		type(c_ptr), value	col_ind_type,
		type(c_ptr), value	idx_base,
		type(c_ptr), value	data_type
	)

The documentation for this interface was generated from the following file: