rocsparse_csrsort Interface Reference

rocsparse_csrsort Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_csrsort Interface Reference

Sort a sparse CSR matrix. More...

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_csrsort_ (handle, m, n, nnz, descr, csr_row_ptr, csr_col_ind, perm, temp_buffer)

integer(kind(rocsparse_status_success)) function	rocsparse_csrsort_rank_0 (handle, m, n, nnz, descr, csr_row_ptr, csr_col_ind, perm, temp_buffer)

integer(kind(rocsparse_status_success)) function	rocsparse_csrsort_rank_1 (handle, m, n, nnz, descr, csr_row_ptr, csr_col_ind, perm, temp_buffer)

Detailed Description

Sort a sparse CSR matrix.

rocsparse_csrsort sorts a matrix in CSR format. The sorted permutation vector perm can be used to obtain sorted csr_val array. In this case, perm must be initialized as the identity permutation, see rocsparse_create_identity_permutation().

rocsparse_csrsort requires extra temporary storage buffer that has to be allocated by the user. Storage buffer size can be determined by rocsparse_csrsort_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 CSR matrix.
[in]	n	number of columns of the sparse CSR matrix.
[in]	nnz	number of non-zero entries of the sparse CSR matrix.
[in]	descr	descriptor of the sparse CSR matrix. Currently, only `rocsparse_matrix_type_general` is supported.
[in]	csr_row_ptr	array of `m+1` elements that point to the start of every row of the sparse CSR matrix.
[in,out]	csr_col_ind	array of `nnz` elements containing the column indices of the sparse CSR 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_csrsort_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	`descr`, `csr_row_ptr`, `csr_col_ind` or `temp_buffer` pointer is invalid.
rocsparse_status_internal_error	an internal error occurred.
rocsparse_status_not_implemented	`rocsparse_matrix_type` != `rocsparse_matrix_type_general`.

Example: The following example sorts a \(3 \times 3\) CSR matrix.
/ 1 2 3

/ A = 4 5 6

/ 7 8 9

rocsparse_int m = 3;

rocsparse_int n = 3;

rocsparse_int nnz = 9;

csr_row_ptr[m + 1] = {0, 3, 6, 9};/ device memory

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

csr_val[nnz] = {3, 1, 2, 4, 5, 6, 7, 9, 8};/ 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_csrsort_buffer_size(handle, m, n, nnz, csr_row_ptr, csr_col_ind, &buffer_size);

hipMalloc(&temp_buffer, buffer_size);

/ Sort the CSR matrix

rocsparse_csrsort(handle, m, n, nnz, descr, csr_row_ptr, csr_col_ind, perm, temp_buffer);

/ Gather sorted csr_val array

float* csr_val_sorted;

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

rocsparse_sgthr(handle, nnz, csr_val, csr_val_sorted, perm, rocsparse_index_base_zero);

/ Clean up

hipFree(temp_buffer);

hipFree(perm);

hipFree(csr_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