rocsparse_ell_get Interface Reference

rocsparse_ell_get Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_ell_get Interface Reference

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

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_ell_get_ (descr, rows, cols, ell_col_ind, ell_val, ell_width, idx_type, idx_base, data_type)

Get the fields of the sparse ELL matrix descriptor.

rocsparse_ell_get gets the fields of the sparse ELL matrix descriptor.

Parameters

[in]	descr	- the pointer to the sparse ELL matrix descriptor.
[out]	rows	- number of rows in the ELL matrix.
[out]	cols	- number of columns in the ELL matrix.
[out]	ell_col_ind	- column indices of the ELL matrix. Must be an array of length `rows*ell_width`.
[out]	ell_val	- values of the ELL matrix. Must be an array of length `rows*ell_width`.
[out]	ell_width	- width of the ELL matrix.
[out]	idx_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`, `ell_col_ind`, or `ell_val` is invalid.
rocsparse_status_invalid_size	if `rows`, `cols`, or `ell_width` is invalid.
rocsparse_status_invalid_value	if `idx_type`, `idx_base`, or `data_type` is invalid.

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_ell_get::rocsparse_ell_get_	(	type(c_ptr), value	descr,
		integer(c_int64_t)	rows,
		integer(c_int64_t)	cols,
		type(c_ptr)	ell_col_ind,
		type(c_ptr)	ell_val,
		type(c_ptr), value	ell_width,
		type(c_ptr), value	idx_type,
		type(c_ptr), value	idx_base,
		type(c_ptr), value	data_type
	)

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