rocsparse_sgthr Interface Reference

• hipfort_rocsparse
• rocsparse_sgthr

Public Member Functions | List of all members

hipfort_rocsparse::rocsparse_sgthr Interface Reference

Gather elements from a dense vector and store them in a sparse vector. More...

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_sgthr_ (handle, nnz, y, x_val, x_ind, idx_base)
integer(kind(rocsparse_status_success)) function	rocsparse_sgthr_rank_0 (handle, nnz, y, x_val, x_ind, idx_base)
integer(kind(rocsparse_status_success)) function	rocsparse_sgthr_rank_1 (handle, nnz, y, x_val, x_ind, idx_base)

Detailed Description

Gather elements from a dense vector and store them in a sparse vector.

rocsparse_gthr gathers the elements that are listed in x_ind from the dense vector \(y\) and stores them in the sparse vector \(x\).

for(i = 0; i < nnz; ++i)

{

x_val[i] = y[x_ind[i]];

}

Note

This function is non-blocking and executed asynchronously with respect to the host. It can return before the actual computation has finished.

This routine supports execution in a hipGraph context.

Parameters

[in]	handle	- handle to the rocSPARSE library context queue.
[in]	nnz	- number of non-zero entries of \(x\).
[in]	y	- array of values in dense format.
[out]	x_val	- array of nnz elements containing the values of \(x\).
[in]	x_ind	- array of nnz elements containing the indices of the non-zero values of \(x\).
[in]	idx_base	- rocsparse_index_base_zero or rocsparse_index_base_one.

Return values

rocsparse_status_success	the operation completed successfully.
rocsparse_status_invalid_handle	the library context was not initialized.
rocsparse_status_invalid_value	idx_base is invalid.
rocsparse_status_invalid_size	nnz is invalid.
rocsparse_status_invalid_pointer	y, x_val, or x_ind pointer is invalid.

Example

Member Function/Subroutine Documentation

◆ rocsparse_sgthr_()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_sgthr::rocsparse_sgthr_	(	type(c_ptr), value	handle,
		integer(c_int), value	nnz,
		type(c_ptr), value	y,
		type(c_ptr), value	x_val,
		type(c_ptr), value	x_ind,
		integer(kind(rocsparse_index_base_zero)), value	idx_base
	)

◆ rocsparse_sgthr_rank_0()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_sgthr::rocsparse_sgthr_rank_0	(	type(c_ptr)	handle,
		integer(c_int)	nnz,
		real(c_float), target	y,
		real(c_float), target	x_val,
		integer(c_int), target	x_ind,
		integer(kind(rocsparse_index_base_zero))	idx_base
	)

◆ rocsparse_sgthr_rank_1()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_sgthr::rocsparse_sgthr_rank_1	(	type(c_ptr)	handle,
		integer(c_int)	nnz,
		real(c_float), dimension(:), target	y,
		real(c_float), dimension(:), target	x_val,
		integer(c_int), dimension(:), target	x_ind,
		integer(kind(rocsparse_index_base_zero))	idx_base
	)

---

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

• hipfort_rocsparse.F90