rocsparse_csrgemm_nnz Interface Reference

rocsparse_csrgemm_nnz Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_csrgemm_nnz Interface Reference

Sparse matrix sparse matrix multiplication using CSR storage format. More...

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_csrgemm_nnz_ (handle, trans_A, trans_B, m, n, k, descr_A, nnz_A, csr_row_ptr_A, csr_col_ind_A, descr_B, nnz_B, csr_row_ptr_B, csr_col_ind_B, descr_D, nnz_D, csr_row_ptr_D, csr_col_ind_D, descr_C, csr_row_ptr_C, nnz_C, info_C, temp_buffer)

integer(kind(rocsparse_status_success)) function	rocsparse_csrgemm_nnz_rank_0 (handle, trans_A, trans_B, m, n, k, descr_A, nnz_A, csr_row_ptr_A, csr_col_ind_A, descr_B, nnz_B, csr_row_ptr_B, csr_col_ind_B, descr_D, nnz_D, csr_row_ptr_D, csr_col_ind_D, descr_C, csr_row_ptr_C, nnz_C, info_C, temp_buffer)

integer(kind(rocsparse_status_success)) function	rocsparse_csrgemm_nnz_rank_1 (handle, trans_A, trans_B, m, n, k, descr_A, nnz_A, csr_row_ptr_A, csr_col_ind_A, descr_B, nnz_B, csr_row_ptr_B, csr_col_ind_B, descr_D, nnz_D, csr_row_ptr_D, csr_col_ind_D, descr_C, csr_row_ptr_C, nnz_C, info_C, temp_buffer)

Detailed Description

Sparse matrix sparse matrix multiplication using CSR storage format.

rocsparse_csrgemm_nnz computes the total CSR non-zero elements and the CSR row offsets, that point to the start of every row of the sparse CSR matrix, of the resulting multiplied matrix C. It is assumed that csr_row_ptr_C has been allocated with size m + 1. The required buffer size can be obtained by rocsparse_scsrgemm_buffer_size(), rocsparse_dcsrgemm_buffer_size(), rocsparse_ccsrgemm_buffer_size() and rocsparse_zcsrgemm_buffer_size(), respectively.

Note: This function is non blocking and executed asynchronously with respect to the host. It may return before the actual computation has finished.; Please note, that for matrix products with more than 8192 intermediate products per row, additional temporary storage buffer is allocated by the algorithm.; Currently, only trans_A == trans_B == rocsparse_operation_none is supported.; Currently, only rocsparse_matrix_type_general is supported.

Parameters

[in]	handle	handle to the rocsparse library context queue.
[in]	trans_A	matrix \(A\) operation type.
[in]	trans_B	matrix \(B\) operation type.
[in]	m	number of rows of the sparse CSR matrix \(op(A)\) and \(C\).
[in]	n	number of columns of the sparse CSR matrix \(op(B)\) and \(C\).
[in]	k	number of columns of the sparse CSR matrix \(op(A)\) and number of rows of the sparse CSR matrix \(op(B)\).
[in]	descr_A	descriptor of the sparse CSR matrix \(A\). Currenty, only `rocsparse_matrix_type_general` is supported.
[in]	nnz_A	number of non-zero entries of the sparse CSR matrix \(A\).
[in]	csr_row_ptr_A	array of `m+1` elements ( \(op(A) == A\), `k+1` otherwise) that point to the start of every row of the sparse CSR matrix \(op(A)\).
[in]	csr_col_ind_A	array of `nnz_A` elements containing the column indices of the sparse CSR matrix \(A\).
[in]	descr_B	descriptor of the sparse CSR matrix \(B\). Currenty, only `rocsparse_matrix_type_general` is supported.
[in]	nnz_B	number of non-zero entries of the sparse CSR matrix \(B\).
[in]	csr_row_ptr_B	array of `k+1` elements ( \(op(B) == B\), `m+1` otherwise) that point to the start of every row of the sparse CSR matrix \(op(B)\).
[in]	csr_col_ind_B	array of `nnz_B` elements containing the column indices of the sparse CSR matrix \(B\).
[in]	descr_D	descriptor of the sparse CSR matrix \(D\). Currenty, only `rocsparse_matrix_type_general` is supported.
[in]	nnz_D	number of non-zero entries of the sparse CSR matrix \(D\).
[in]	csr_row_ptr_D	array of `m+1` elements that point to the start of every row of the sparse CSR matrix \(D\).
[in]	csr_col_ind_D	array of `nnz_D` elements containing the column indices of the sparse CSR matrix \(D\).
[in]	descr_C	descriptor of the sparse CSR matrix \(C\). Currenty, only `rocsparse_matrix_type_general` is supported.
[out]	csr_row_ptr_C	array of `m+1` elements that point to the start of every row of the sparse CSR matrix \(C\).
[out]	nnz_C	pointer to the number of non-zero entries of the sparse CSR matrix \(C\).
[in]	info_C	structure that holds meta data for the sparse CSR matrix \(C\).
[in]	temp_buffer	temporary storage buffer allocated by the user, size is returned by rocsparse_scsrgemm_buffer_size(), rocsparse_dcsrgemm_buffer_size(), rocsparse_ccsrgemm_buffer_size() or rocsparse_zcsrgemm_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`, `k`, `nnz_A`, `nnz_B` or `nnz_D` is invalid.
rocsparse_status_invalid_pointer	`descr_A`, `csr_row_ptr_A`, `csr_col_ind_A`, `descr_B`, `csr_row_ptr_B`, `csr_col_ind_B`, `descr_D`, `csr_row_ptr_D`, `csr_col_ind_D`, `descr_C`, `csr_row_ptr_C`, `nnz_C`, `info_C` or `temp_buffer` is invalid.
rocsparse_status_memory_error	additional buffer for long rows could not be allocated.
rocsparse_status_not_implemented	`trans_A` != `rocsparse_operation_none`, `trans_B` != `rocsparse_operation_none`, or `rocsparse_matrix_type` != `rocsparse_matrix_type_general`.

Member Function/Subroutine Documentation