hipsparsexcoosortbycolumn Interface Reference

• hipfort_hipsparse
• hipsparsexcoosortbycolumn

Public Member Functions | List of all members

hipfort_hipsparse::hipsparsexcoosortbycolumn Interface Reference

Sort a sparse COO matrix by column. More...

Public Member Functions
integer(kind(hipsparse_status_success)) function	hipsparsexcoosortbycolumn_ (handle, m, n, nnz, coorows, coocols, p, pbuffer)
integer(kind(hipsparse_status_success)) function	hipsparsexcoosortbycolumn_rank_0 (handle, m, n, nnz, coorows, coocols, p, pbuffer)
integer(kind(hipsparse_status_success)) function	hipsparsexcoosortbycolumn_rank_1 (handle, m, n, nnz, coorows, coocols, p, pbuffer)

Detailed Description

Sort a sparse COO matrix by column.

hipsparseXcoosortByColumn sorts a matrix in COO format by column. The sorted permutation vector P can be used to obtain the sorted cooVal array. In this case, P must be initialized as the identity permutation. See hipsparseCreateIdentityPermutation(). To apply the permutation vector to the COO values, see hipsparseSgthr "hipsparseXgthr()".

hipsparseXcoosortByColumn requires an extra temporary storage buffer that must be allocated by the user. The storage buffer size can be determined by hipsparseXcoosort_bufferSizeExt().

Note

P can be NULL if a sorted permutation vector is not required.

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

Parameters

[in]	handle	- handle to the hipSPARSE 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,out]	cooRows	- array of nnz elements containing the row indices of the sparse COO matrix.
[in,out]	cooCols	- array of nnz elements containing the column indices of the sparse COO matrix.
[in,out]	P	- array of nnz integers containing the unsorted map indices. Can be NULL.
[in]	pBuffer	- temporary storage buffer allocated by the user. The size is returned by hipsparseXcoosort_bufferSizeExt().

Return values

HIPSPARSE_STATUS_SUCCESS	the operation completed successfully.
HIPSPARSE_STATUS_INVALID_VALUE	handle, m, n, nnz, cooRows, cooCols, or pBuffer pointer is invalid.
HIPSPARSE_STATUS_INTERNAL_ERROR	an internal error occurred.

Member Function/Subroutine Documentation

◆ hipsparsexcoosortbycolumn_()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsexcoosortbycolumn::hipsparsexcoosortbycolumn_	(	type(c_ptr), value	handle,
		integer(c_int), value	m,
		integer(c_int), value	n,
		integer(c_int), value	nnz,
		type(c_ptr), value	coorows,
		type(c_ptr), value	coocols,
		type(c_ptr), value	p,
		type(c_ptr), value	pbuffer
	)

◆ hipsparsexcoosortbycolumn_rank_0()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsexcoosortbycolumn::hipsparsexcoosortbycolumn_rank_0	(	type(c_ptr)	handle,
		integer(c_int)	m,
		integer(c_int)	n,
		integer(c_int)	nnz,
		integer(c_int), target	coorows,
		integer(c_int), target	coocols,
		integer(c_int), target	p,
		type(c_ptr)	pbuffer
	)

◆ hipsparsexcoosortbycolumn_rank_1()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsexcoosortbycolumn::hipsparsexcoosortbycolumn_rank_1	(	type(c_ptr)	handle,
		integer(c_int)	m,
		integer(c_int)	n,
		integer(c_int)	nnz,
		integer(c_int), dimension(:), target	coorows,
		integer(c_int), dimension(:), target	coocols,
		integer(c_int), dimension(:), target	p,
		type(c_ptr)	pbuffer
	)

---

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

• hipfort_hipsparse.F90