hipblasssbmv Interface Reference

hipblasssbmv Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasssbmv Interface Reference
hipfort_hipblas::hipblasssbmv Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblasssbmv_ (handle, uplo, n, k, alpha, ap, lda, x, incx, beta, y, incy)
 
integer(kind(hipblas_status_success)) function hipblasssbmv_rank_0 (handle, uplo, n, k, alpha, ap, lda, x, incx, beta, y, incy)
 
integer(kind(hipblas_status_success)) function hipblasssbmv_rank_1 (handle, uplo, n, k, alpha, ap, lda, x, incx, beta, y, incy)
 
integer(kind(hipblas_status_success)) function hipblasssbmv_full_rank (handle, uplo, n, k, alpha, ap, lda, x, incx, beta, y, incy)
 

Detailed Description

BLAS Level 2 API.

The sbmv functions perform the matrix-vector operation:

y := alpha*A*x + beta*y,

where alpha and beta are scalars, x and y are n-element vectors, and A should contain an upper or lower triangular n by n symmetric banded matrix.

  • Supported precisions in rocBLAS : s and d.
  • Supported precisions in cuBLAS : s and d.
Parameters
[in]handle- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in]uplo- [hipblasFillMode_t] specifies either upper (HIPBLAS_FILL_MODE_UPPER) or lower (HIPBLAS_FILL_MODE_LOWER):
  • If HIPBLAS_FILL_MODE_UPPER, the lower part of A is not referenced.
  • If HIPBLAS_FILL_MODE_LOWER, the upper part of A is not referenced.
[in]n- [int]
[in]k- [int] specifies the number of sub- and super-diagonals.
[in]alphaspecifies the scalar alpha.
[in]AP- pointer storing matrix A on the GPU.
[in]lda- [int] specifies the leading dimension of matrix A.
[in]x- pointer storing vector x on the GPU.
[in]incx- [int] specifies the increment for the elements of x.
[in]beta- specifies the scalar beta.
[out]y- pointer storing vector y on the GPU.
[in]incy- [int] specifies the increment for the elements of y.

Member Function/Subroutine Documentation

◆ hipblasssbmv_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssbmv::hipblasssbmv_ ( type(c_ptr), value  handle,
integer(kind(hipblas_fill_mode_upper)), value  uplo,
integer(c_int), value  n,
integer(c_int), value  k,
real(c_float)  alpha,
type(c_ptr), value  ap,
integer(c_int), value  lda,
type(c_ptr), value  x,
integer(c_int), value  incx,
real(c_float)  beta,
type(c_ptr), value  y,
integer(c_int), value  incy 
)

◆ hipblasssbmv_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssbmv::hipblasssbmv_full_rank ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
integer(c_int)  k,
real(c_float)  alpha,
real(c_float), dimension(:,:), target  ap,
integer(c_int)  lda,
real(c_float), dimension(:), target  x,
integer(c_int)  incx,
real(c_float)  beta,
real(c_float), dimension(:), target  y,
integer(c_int)  incy 
)

◆ hipblasssbmv_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssbmv::hipblasssbmv_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
integer(c_int)  k,
real(c_float)  alpha,
real(c_float), target  ap,
integer(c_int)  lda,
real(c_float), target  x,
integer(c_int)  incx,
real(c_float)  beta,
real(c_float), target  y,
integer(c_int)  incy 
)

◆ hipblasssbmv_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssbmv::hipblasssbmv_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
integer(c_int)  k,
real(c_float)  alpha,
real(c_float), dimension(:), target  ap,
integer(c_int)  lda,
real(c_float), dimension(:), target  x,
integer(c_int)  incx,
real(c_float)  beta,
real(c_float), dimension(:), target  y,
integer(c_int)  incy 
)

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