rocsparse_coosort_buffer_size Interface Reference

• hipfort_rocsparse
• rocsparse_coosort_buffer_size

Public Member Functions | List of all members

hipfort_rocsparse::rocsparse_coosort_buffer_size Interface Reference

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_coosort_buffer_size_ (handle, m, n, nnz, coo_row_ind, coo_col_ind, buffer_size)
integer(kind(rocsparse_status_success)) function	rocsparse_coosort_buffer_size_rank_0 (handle, m, n, nnz, coo_row_ind, coo_col_ind, buffer_size)
integer(kind(rocsparse_status_success)) function	rocsparse_coosort_buffer_size_rank_1 (handle, m, n, nnz, coo_row_ind, coo_col_ind, buffer_size)

Detailed Description

rocsparse_coosort_buffer_size returns the size of the temporary storage buffer that is required by rocsparse_coosort_by_row() and rocsparse_coosort_by_column(). The temporary storage buffer has to be allocated by the user.

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]	m	- number of rows of the sparse COO matrix.
[in]	n	- number of columns of the sparse COO matrix.
[in]	nnz	- number of non-zero entries of the sparse COO matrix.
[in]	coo_row_ind	- array of nnz elements containing the row indices of the sparse COO matrix.
[in]	coo_col_ind	- array of nnz elements containing the column indices of the sparse COO matrix.
[out]	buffer_size	- number of bytes of the temporary storage buffer required by rocsparse_coosort_by_row() and rocsparse_coosort_by_column().

Return values

rocsparse_status_success	the operation completed successfully.
rocsparse_status_invalid_handle	the library context was not initialized.
rocsparse_status_invalid_size	m, n, or nnz is invalid.
rocsparse_status_invalid_pointer	coo_row_ind, coo_col_ind, or buffer_size pointer is invalid.
rocsparse_status_internal_error	an internal error occurred.

Member Function/Subroutine Documentation

◆ rocsparse_coosort_buffer_size_()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_coosort_buffer_size::rocsparse_coosort_buffer_size_	(	type(c_ptr), value	handle,
		integer(c_int), value	m,
		integer(c_int), value	n,
		integer(c_int), value	nnz,
		type(c_ptr), value	coo_row_ind,
		type(c_ptr), value	coo_col_ind,
		integer(c_size_t)	buffer_size
	)

◆ rocsparse_coosort_buffer_size_rank_0()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_coosort_buffer_size::rocsparse_coosort_buffer_size_rank_0	(	type(c_ptr)	handle,
		integer(c_int)	m,
		integer(c_int)	n,
		integer(c_int)	nnz,
		integer(c_int), target	coo_row_ind,
		integer(c_int), target	coo_col_ind,
		integer(c_size_t)	buffer_size
	)

◆ rocsparse_coosort_buffer_size_rank_1()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_coosort_buffer_size::rocsparse_coosort_buffer_size_rank_1	(	type(c_ptr)	handle,
		integer(c_int)	m,
		integer(c_int)	n,
		integer(c_int)	nnz,
		integer(c_int), dimension(:), target	coo_row_ind,
		integer(c_int), dimension(:), target	coo_col_ind,
		integer(c_size_t)	buffer_size
	)

---

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

• hipfort_rocsparse.F90