rocsparse_axpby Interface Reference

rocsparse_axpby Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_axpby Interface Reference
hipfort_rocsparse::rocsparse_axpby Interface Reference

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

Public Member Functions

integer(kind(rocsparse_status_success)) function rocsparse_axpby_ (handle, alpha, x, beta, y)

Detailed Description

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

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

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

for(i = 0; i < nnz; ++i)
y[x_ind[i]] = alpha * x_val[i] + beta * y[x_ind[i]]
This function is non blocking and executed asynchronously with respect to the host. It may return before the actual computation has finished.
[in]handlehandle to the rocsparse library context queue.
[in]alphascalar \(\alpha\).
[in]xsparse matrix descriptor.
[in]betascalar \(\beta\).
[in,out]ydense matrix descriptor.
Return values
rocsparse_status_successthe operation completed successfully.
rocsparse_status_invalid_handlethe library context was not initialized.
rocsparse_status_invalid_pointeralpha, x, beta or y pointer is invalid.

Member Function/Subroutine Documentation

◆ rocsparse_axpby_()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_axpby::rocsparse_axpby_ ( type(c_ptr), value  handle,
type(c_ptr), value  alpha,
type(c_ptr), value  x,
type(c_ptr), value  beta,
type(c_ptr), value  y 

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