rocsparse_coosort_by_row Interface Reference

rocsparse_coosort_by_row Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_coosort_by_row Interface Reference

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

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_coosort_by_row_ (handle, m, n, nnz, coo_row_ind, coo_col_ind, perm, temp_buffer)

integer(kind(rocsparse_status_success)) function	rocsparse_coosort_by_row_rank_0 (handle, m, n, nnz, coo_row_ind, coo_col_ind, perm, temp_buffer)

integer(kind(rocsparse_status_success)) function	rocsparse_coosort_by_row_rank_1 (handle, m, n, nnz, coo_row_ind, coo_col_ind, perm, temp_buffer)

Detailed Description

Sort a sparse COO matrix by row.

rocsparse_coosort_by_row sorts a matrix in COO format by row. The sorted permutation vector perm can be used to obtain sorted coo_val array. In this case, perm must be initialized as the identity permutation, see rocsparse_create_identity_permutation().

rocsparse_coosort_by_row requires extra temporary storage buffer that has to be allocated by the user. Storage buffer size can be determined by rocsparse_coosort_buffer_size().

Note: perm 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 may return before the actual computation has finished.

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,out]	coo_row_ind	array of `nnz` elements containing the row indices of the sparse COO matrix.
[in,out]	coo_col_ind	array of `nnz` elements containing the column indices of the sparse COO matrix.
[in,out]	perm	array of `nnz` integers containing the unsorted map indices, can be `NULL`.
[in]	temp_buffer	temporary storage buffer allocated by the user, size is returned by rocsparse_coosort_buffer_size().

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 `temp_buffer` pointer is invalid.
rocsparse_status_internal_error	an internal error occurred.

Example: The following example sorts a \(3 \times 3\) COO matrix by row indices.
/ 1 2 3

/ A = 4 5 6

/ 7 8 9

rocsparse_int m = 3;

rocsparse_int n = 3;

rocsparse_int nnz = 9;

coo_row_ind[nnz] = {0, 1, 2, 0, 1, 2, 0, 1, 2};/ device memory

coo_col_ind[nnz] = {0, 0, 0, 1, 1, 1, 2, 2, 2};/ device memory

coo_val[nnz] = {1, 4, 7, 2, 5, 8, 3, 6, 9};/ device memory

/ Create permutation vector perm as the identity map

rocsparse_int* perm;

hipMalloc((void**)&perm, sizeof(rocsparse_int) * nnz);

rocsparse_create_identity_permutation(handle, nnz, perm);

/ Allocate temporary buffer

size_t buffer_size;

void* temp_buffer;

rocsparse_coosort_buffer_size(handle,

m,

n,

nnz,

coo_row_ind,

coo_col_ind,

&buffer_size);

hipMalloc(&temp_buffer, buffer_size);

/ Sort the COO matrix

rocsparse_coosort_by_row(handle,

m,

n,

nnz,

coo_row_ind,

coo_col_ind,

perm,

temp_buffer);

/ Gather sorted coo_val array

float* coo_val_sorted;

hipMalloc((void**)&coo_val_sorted, sizeof(float) * nnz);

rocsparse_sgthr(handle, nnz, coo_val, coo_val_sorted, perm, rocsparse_index_base_zero);

/ Clean up

hipFree(temp_buffer);

hipFree(perm);

hipFree(coo_val);

hipfort_enums::memory
@ memory
Definition: hipfort_enums.f:50

hipfort_enums::the
@ the
Definition: hipfort_enums.f:49

hipfort_rocsparse_enums::rocsparse_index_base_zero
@ rocsparse_index_base_zero
Definition: hipfort_rocsparse_enums.f:40

Member Function/Subroutine Documentation