rocsparse_spvec_get Interface Reference

• hipfort_rocsparse
• rocsparse_spvec_get

Public Member Functions | List of all members

hipfort_rocsparse::rocsparse_spvec_get Interface Reference

Get the fields of the sparse vector descriptor. More...

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_spvec_get_ (descr, mysize, nnz, indices, values, idx_type, idx_base, data_type)

Detailed Description

Get the fields of the sparse vector descriptor.

rocsparse_spvec_get gets the fields of the sparse vector descriptor.

Parameters

[in]	descr	- the pointer to the sparse vector descriptor.
[out]	mySize	- size of the sparse vector.
[out]	nnz	- number of non-zeros in sparse vector.
[out]	indices	- indices of the sparse vector where non-zeros occur. Must be an array of length nnz.
[out]	values	- non-zero values in the sparse vector. Must be an array of length nnz.
[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, indices, or values is invalid.
rocsparse_status_invalid_size	if size or nnz is invalid.
rocsparse_status_invalid_value	if idx_type, idx_base, or data_type is invalid.

Member Function/Subroutine Documentation

◆ rocsparse_spvec_get_()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_spvec_get::rocsparse_spvec_get_	(	type(c_ptr), value	descr,
		type(c_ptr), value	mysize,
		integer(c_int64_t)	nnz,
		type(c_ptr)	indices,
		type(c_ptr)	values,
		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:

• hipfort_rocsparse.F90