rocsparse_sgemvi Interface Reference

rocsparse_sgemvi Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_sgemvi Interface Reference

Dense matrix sparse vector multiplication. More...

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_sgemvi_ (handle, trans, m, n, alpha, a, lda, nnz, x_val, x_ind, beta, y, idx_base, temp_buffer)

integer(kind(rocsparse_status_success)) function	rocsparse_sgemvi_rank_0 (handle, trans, m, n, alpha, a, lda, nnz, x_val, x_ind, beta, y, idx_base, temp_buffer)

integer(kind(rocsparse_status_success)) function	rocsparse_sgemvi_rank_1 (handle, trans, m, n, alpha, a, lda, nnz, x_val, x_ind, beta, y, idx_base, temp_buffer)

integer(kind(rocsparse_status_success)) function	rocsparse_sgemvi_full_rank (handle, trans, m, n, alpha, a, lda, nnz, x_val, x_ind, beta, y, idx_base, temp_buffer)

Detailed Description

Dense matrix sparse vector multiplication.

rocsparse_gemvi multiplies the scalar \(\alpha\) with a dense \(m \times n\) matrix \(A\) and the sparse vector \(x\) and adds the result to the dense vector \(y\) that is multiplied by the scalar \(\beta\), such that

\[ y := \alpha \cdot op(A) \cdot x + \beta \cdot y, \]

with

\[ op(A) = \left\{ \begin{array}{ll} A, & \text{if trans == rocsparse_operation_none} \end{array} \right. \]

Performing the above operation involves two steps. First, call rocsparse_Xgemvi_buffer_size() to determine the size of the temporary storage buffer. Next, allocate this temporary buffer and pass it to rocsparse_gemvi to complete the computation. After all calls to rocsparse_gemvi are complete, the temporary storage buffer can be freed.

Note: This function is non-blocking and executed asynchronously with respect to the host. It can return before the actual computation has finished.; Currently, only trans == rocsparse_operation_none is supported.; This routine supports execution in a hipGraph context.

Parameters

[in]	handle	- handle to the rocSPARSE library context queue.
[in]	trans	- matrix operation type.
[in]	m	- number of rows of the dense matrix.
[in]	n	- number of columns of the dense matrix.
[in]	alpha	- scalar \(\alpha\).
[in]	A	- pointer to the dense matrix.
[in]	lda	- leading dimension of the dense matrix.
[in]	nnz	- number of non-zero entries in the sparse vector.
[in]	x_val	- array of `nnz` elements containing the values of the sparse vector.
[in]	x_ind	- array of `nnz` elements containing the indices of the sparse vector.
[in]	beta	- scalar \(\beta\).
[in,out]	y	- array of `m` elements ( \(op(A) == A\)) or `n` elements ( \(op(A) == A^T\) or \(op(A) == A^H\)).
[in]	idx_base	- rocsparse_index_base_zero or rocsparse_index_base_one.
[in]	temp_buffer	- temporary storage buffer.

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`, `lda`, or `nnz` is invalid.
rocsparse_status_invalid_pointer	`alpha`, `A`, `x_val`, `x_ind`, `beta`, `y`, or `temp_buffer` pointer is invalid.
rocsparse_status_not_implemented	`trans` != `rocsparse_operation_none` or `rocsparse_matrix_type` != `rocsparse_matrix_type_general`.

Example

Member Function/Subroutine Documentation