hipsparsesaxpyi Interface Reference

• hipfort_hipsparse
• hipsparsesaxpyi

Public Member Functions | List of all members

hipfort_hipsparse::hipsparsesaxpyi Interface Reference

Scale a sparse vector and add it to a dense vector. More...

Public Member Functions
integer(kind(hipsparse_status_success)) function	hipsparsesaxpyi_ (handle, nnz, alpha, xval, xind, y, idxbase)
integer(kind(hipsparse_status_success)) function	hipsparsesaxpyi_rank_0 (handle, nnz, alpha, xval, xind, y, idxbase)
integer(kind(hipsparse_status_success)) function	hipsparsesaxpyi_rank_1 (handle, nnz, alpha, xval, xind, y, idxbase)

Detailed Description

Scale a sparse vector and add it to a dense vector.

hipsparseXaxpyi multiplies the sparse vector \(x\) with scalar \(\alpha\) and adds the result to the dense vector \(y\), such that

\[ y := y + \alpha \cdot x \]

for(i = 0; i < nnz; ++i)

{

y[xInd[i]] = y[xInd[i]] + alpha * xVal[i];

}

Note

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

If nnz is zero, the function returns successfully without modifying y. Duplicate indices in xInd will result in the corresponding values being added multiple times to the same location in y.

Deprecated:

This function is deprecated when using the CUDA backend (CUDA 11.0+) and will be removed in CUDA 12.0. This deprecation does not apply to the ROCm backend.

Parameters

[in]	handle	- handle to the hipSPARSE library context queue.
[in]	nnz	- number of non-zero entries of vector \(x\). Must be non-negative.
[in]	alpha	- scalar \(\alpha\).
[in]	xVal	- array of nnz elements containing the values of \(x\).
[in]	xInd	- array of nnz elements containing the indices of the non-zero values of \(x\).
[in,out]	y	- array of values in dense format. Must be pre-allocated with sufficient size to accommodate all indices specified in xInd.
[in]	idxBase	- index base. HIPSPARSE_INDEX_BASE_ZERO for zero-based indexing or HIPSPARSE_INDEX_BASE_ONE for one-based indexing.

Return values

HIPSPARSE_STATUS_SUCCESS	the operation completed successfully.
HIPSPARSE_STATUS_NOT_INITIALIZED	handle is not initialized.
HIPSPARSE_STATUS_INVALID_VALUE	handle is nullptr, nnz is negative, alpha, xVal, xInd, or y is nullptr when nnz is greater than zero, or idxBase is neither HIPSPARSE_INDEX_BASE_ZERO nor HIPSPARSE_INDEX_BASE_ONE.

Member Function/Subroutine Documentation

◆ hipsparsesaxpyi_()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsesaxpyi::hipsparsesaxpyi_	(	type(c_ptr), value	handle,
		integer(c_int), value	nnz,
		real(c_float)	alpha,
		type(c_ptr), value	xval,
		type(c_ptr), value	xind,
		type(c_ptr), value	y,
		integer(kind(hipsparse_index_base_zero)), value	idxbase
	)

◆ hipsparsesaxpyi_rank_0()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsesaxpyi::hipsparsesaxpyi_rank_0	(	type(c_ptr)	handle,
		integer(c_int)	nnz,
		real(c_float)	alpha,
		real(c_float), target	xval,
		integer(c_int), target	xind,
		real(c_float), target	y,
		integer(kind(hipsparse_index_base_zero))	idxbase
	)

◆ hipsparsesaxpyi_rank_1()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsesaxpyi::hipsparsesaxpyi_rank_1	(	type(c_ptr)	handle,
		integer(c_int)	nnz,
		real(c_float)	alpha,
		real(c_float), dimension(:), target	xval,
		integer(c_int), dimension(:), target	xind,
		real(c_float), dimension(:), target	y,
		integer(kind(hipsparse_index_base_zero))	idxbase
	)

---

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

• hipfort_hipsparse.F90