hipblasssbmvstridedbatched Interface Reference

hipblasssbmvstridedbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasssbmvstridedbatched Interface Reference
hipfort_hipblas::hipblasssbmvstridedbatched Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblasssbmvstridedbatched_ (handle, uplo, n, k, alpha, ap, lda, stridea, x, incx, stridex, beta, y, incy, stridey, batchcount)
 
integer(kind(hipblas_status_success)) function hipblasssbmvstridedbatched_rank_0 (handle, uplo, n, k, alpha, ap, lda, stridea, x, incx, stridex, beta, y, incy, stridey, batchcount)
 
integer(kind(hipblas_status_success)) function hipblasssbmvstridedbatched_rank_1 (handle, uplo, n, k, alpha, ap, lda, stridea, x, incx, stridex, beta, y, incy, stridey, batchcount)
 
integer(kind(hipblas_status_success)) function hipblasssbmvstridedbatched_full_rank (handle, uplo, n, k, alpha, ap, lda, stridea, x, incx, stridex, beta, y, incy, stridey, batchcount)
 

Detailed Description

BLAS Level 2 API.

The sbmvStridedBatched functions perform the matrix-vector operation:

y_i := alpha*A_i*x_i + beta*y_i,

where (A_i, x_i, y_i) is the i-th instance of the batch, alpha and beta are scalars, x_i and y_i are vectors, and A_i is an n by n symmetric banded matrix, for i = 1, ..., batchCount. 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 : No support.
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] number of rows and columns of each matrix A_i.
[in]k- [int] specifies the number of sub- and super-diagonals.
[in]alphadevice pointer or host pointer to scalar alpha.
[in]AP- device pointer to the first matrix A_1 on the GPU.
[in]lda- [int] specifies the leading dimension of each matrix A_i.
[in]strideA- [hipblasStride] stride from the start of one matrix (A_i) to the next one (A_i+1).
[in]x- device pointer to the first vector x_1 on the GPU.
[in]incx- [int] specifies the increment for the elements of each vector x_i.
[in]stridex- [hipblasStride] stride from the start of one vector (x_i) to the next one (x_i+1). There are no restrictions placed on stridex. However, the user should ensure that stridex is of an appropriate size. This typically means stridex >= n * incx. stridex should be non zero.
[in]beta- device pointer or host pointer to scalar beta.
[out]y- device pointer to the first vector y_1 on the GPU.
[in]incy- [int] specifies the increment for the elements of each vector y_i.
[in]stridey- [hipblasStride] stride from the start of one vector (y_i) to the next one (y_i+1). There are no restrictions placed on stridey. However, the user should ensure that stridey is of an appropriate size. This typically means stridey >= n * incy. stridey should be non zero.
[in]batchCount- [int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ hipblasssbmvstridedbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssbmvstridedbatched::hipblasssbmvstridedbatched_ ( 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,
integer(c_int64_t), value  stridea,
type(c_ptr), value  x,
integer(c_int), value  incx,
integer(c_int64_t), value  stridex,
real(c_float)  beta,
type(c_ptr), value  y,
integer(c_int), value  incy,
integer(c_int64_t), value  stridey,
integer(c_int), value  batchcount 
)

◆ hipblasssbmvstridedbatched_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssbmvstridedbatched::hipblasssbmvstridedbatched_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,
integer(c_int64_t)  stridea,
real(c_float), dimension(:), target  x,
integer(c_int)  incx,
integer(c_int64_t)  stridex,
real(c_float)  beta,
real(c_float), dimension(:), target  y,
integer(c_int)  incy,
integer(c_int64_t)  stridey,
integer(c_int)  batchcount 
)

◆ hipblasssbmvstridedbatched_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssbmvstridedbatched::hipblasssbmvstridedbatched_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,
integer(c_int64_t)  stridea,
real(c_float), target  x,
integer(c_int)  incx,
integer(c_int64_t)  stridex,
real(c_float)  beta,
real(c_float), target  y,
integer(c_int)  incy,
integer(c_int64_t)  stridey,
integer(c_int)  batchcount 
)

◆ hipblasssbmvstridedbatched_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssbmvstridedbatched::hipblasssbmvstridedbatched_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,
integer(c_int64_t)  stridea,
real(c_float), dimension(:), target  x,
integer(c_int)  incx,
integer(c_int64_t)  stridex,
real(c_float)  beta,
real(c_float), dimension(:), target  y,
integer(c_int)  incy,
integer(c_int64_t)  stridey,
integer(c_int)  batchcount 
)

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