rocsparse_csc_get Interface Reference

rocsparse_csc_get Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_csc_get Interface Reference

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

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_csc_get_ (descr, rows, cols, nnz, csc_col_ptr, csc_row_ind, csc_val, col_ptr_type, row_ind_type, idx_base, data_type)

Get the fields of the sparse CSC matrix descriptor.

rocsparse_csc_get gets the fields of the sparse CSC matrix descriptor.

Parameters

[in]	descr	- the pointer to the sparse CSC matrix descriptor.
[out]	rows	- number of rows in the CSC matrix.
[out]	cols	- number of columns in the CSC matrix
[out]	nnz	- number of non-zeros in the CSC matrix.
[out]	csc_col_ptr	- column offsets of the CSC matrix. Must be an array of length `cols+1`.
[out]	csc_row_ind	- row indices of the CSC matrix. Must be an array of length `nnz`.
[out]	csc_val	- values of the CSC matrix. Must be an array of length `nnz`.
[out]	col_ptr_type	- `rocsparse_indextype_i32` or `rocsparse_indextype_i64`.
[out]	row_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`, `csc_col_ptr`, `csc_row_ind`, or `csr_val` is invalid.
rocsparse_status_invalid_size	if `rows`, `cols`, or `nnz` is invalid.
rocsparse_status_invalid_value	if `col_ptr_type`, `row_ind_type`, `idx_base`, or `data_type` is invalid.

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_csc_get::rocsparse_csc_get_	(	type(c_ptr), value	descr,
		integer(c_int64_t)	rows,
		integer(c_int64_t)	cols,
		integer(c_int64_t)	nnz,
		type(c_ptr)	csc_col_ptr,
		type(c_ptr)	csc_row_ind,
		type(c_ptr)	csc_val,
		type(c_ptr), value	col_ptr_type,
		type(c_ptr), value	row_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: