hipblasdspr2 Interface Reference

hipblasdspr2 Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasdspr2 Interface Reference
hipfort_hipblas::hipblasdspr2 Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblasdspr2_ (handle, uplo, n, alpha, x, incx, y, incy, AP)
 
integer(kind(hipblas_status_success)) function hipblasdspr2_rank_0 (handle, uplo, n, alpha, x, incx, y, incy, AP)
 
integer(kind(hipblas_status_success)) function hipblasdspr2_rank_1 (handle, uplo, n, alpha, x, incx, y, incy, AP)
 

Detailed Description

BLAS Level 2 API.

spr2 performs the matrix-vector operation

A := A + alpha*x*y**T + alpha*y*x**T

where alpha is a scalar, x and y are vectors, and A is an n by n symmetric matrix, supplied in packed form.

Parameters
[in]handle[hipblasHandle_t] handle to the hipblas library context queue.
[in]uplo[hipblasFillMode_t] specifies whether the upper 'HIPBLAS_FILL_MODE_UPPER' or lower 'HIPBLAS_FILL_MODE_LOWER' HIPBLAS_FILL_MODE_UPPER: The upper triangular part of A is supplied in AP. HIPBLAS_FILL_MODE_LOWER: The lower triangular part of A is supplied in AP.
[in]n[int] the number of rows and columns of matrix A, must be at least 0.
[in]alphadevice pointer or host pointer to scalar alpha.
[in]xdevice pointer storing vector x.
[in]incx[int] specifies the increment for the elements of x.
[in]ydevice pointer storing vector y.
[in]incy[int] specifies the increment for the elements of y.
[in,out]APdevice pointer storing the packed version of the specified triangular portion of the symmetric matrix A. Of at least size ((n * (n + 1)) 2). if uplo == HIPBLAS_FILL_MODE_UPPER: The upper triangular portion of the symmetric matrix A is supplied. The matrix is compacted so that AP contains the triangular portion column-by-column so that: AP(0) = A(0,0) AP(1) = A(0,1) AP(2) = A(1,1), etc. Ex: (HIPBLAS_FILL_MODE_UPPER; n = 4) 1 2 4 7 2 3 5 8 --—> [1, 2, 3, 4, 5, 6, 7, 8, 9, 0] 4 5 6 9 7 8 9 0 if uplo == HIPBLAS_FILL_MODE_LOWER: The lower triangular portion of the symmetric matrix A is supplied. The matrix is compacted so that AP contains the triangular portion column-by-column so that: AP(0) = A(0,0) AP(1) = A(1,0) AP(n) = A(2,1), etc. Ex: (HIPBLAS_FILL_MODE_LOWER; n = 4) 1 2 3 4 2 5 6 7 --—> [1, 2, 3, 4, 5, 6, 7, 8, 9, 0] 3 6 8 9 4 7 9 0

Member Function/Subroutine Documentation

◆ hipblasdspr2_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasdspr2::hipblasdspr2_ ( type(c_ptr), value  handle,
integer(kind(hipblas_fill_mode_upper)), value  uplo,
integer(c_int), value  n,
real(c_double)  alpha,
type(c_ptr), value  x,
integer(c_int), value  incx,
type(c_ptr), value  y,
integer(c_int), value  incy,
type(c_ptr), value  AP 
)

◆ hipblasdspr2_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasdspr2::hipblasdspr2_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
real(c_double)  alpha,
real(c_double), target  x,
integer(c_int)  incx,
real(c_double), target  y,
integer(c_int)  incy,
type(c_ptr)  AP 
)

◆ hipblasdspr2_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasdspr2::hipblasdspr2_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
real(c_double)  alpha,
real(c_double), dimension(:), target  x,
integer(c_int)  incx,
real(c_double), dimension(:), target  y,
integer(c_int)  incy,
type(c_ptr)  AP 
)

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