rocblas_sgbmv_batched Interface Reference

rocblas_sgbmv_batched Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_sgbmv_batched Interface Reference
hipfort_rocblas::rocblas_sgbmv_batched Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_sgbmv_batched_ (handle, trans, m, n, kl, ku, alpha, a, lda, x, incx, beta, y, incy, batch_count)
 

Detailed Description

BLAS Level 2 API.

The gbmv_batched functions perform one of the matrix-vector operations:

y_i := alpha*A_i*x_i    + beta*y_i,   or
y_i := alpha*A_i**T*x_i + beta*y_i,   or
y_i := alpha*A_i**H*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 m by n banded matrix with kl sub-diagonals and ku super-diagonals, for i = 1, ..., batch_count.

Parameters
[in]handle- [rocblas_handle] handle to the rocBLAS library context queue.
[in]trans- [rocblas_operation] indicates whether matrix A is tranposed (conjugated) or not.
[in]m- [rocblas_int] number of rows of each matrix A_i.
[in]n- [rocblas_int] number of columns of each matrix A_i.
[in]kl- [rocblas_int] number of sub-diagonals of each A_i.
[in]ku- [rocblas_int] number of super-diagonals of each A_i.
[in]alpha- device pointer or host pointer to scalar alpha.
[in]A- device array of device pointers storing each banded matrix A_i. The leading (kl + ku + 1) by n part of the matrix contains the coefficients of the banded matrix. The leading diagonal resides in row (ku + 1) with the first super-diagonal above on the RHS of row ku. The first sub-diagonal resides below on the LHS of row ku + 2. This propagates up and down across sub/super-diagonals.
  Ex: (m = n = 7; ku = 2, kl = 2)
  1 2 3 0 0 0 0             0 0 3 3 3 3 3
  4 1 2 3 0 0 0             0 2 2 2 2 2 2
  5 4 1 2 3 0 0    ---->    1 1 1 1 1 1 1
  0 5 4 1 2 3 0             4 4 4 4 4 4 0
  0 0 5 4 1 2 3             5 5 5 5 5 0 0
  0 0 0 5 4 1 2             0 0 0 0 0 0 0
  0 0 0 0 5 4 1             0 0 0 0 0 0 0
Note that empty elements that do not correspond to data will not be referenced.
[in]lda- [rocblas_int] specifies the leading dimension of each A_i. Must be >= (kl + ku + 1)
[in]x- device array of device pointers storing each vector x_i.
[in]incx- [rocblas_int] specifies the increment for the elements of each x_i.
[in]beta- device pointer or host pointer to scalar beta.
[in,out]y- device array of device pointers storing each vector y_i.
[in]incy- [rocblas_int] specifies the increment for the elements of each y_i.
[in]batch_count- [rocblas_int] specifies the number of instances in the batch.

Member Function/Subroutine Documentation

◆ rocblas_sgbmv_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_sgbmv_batched::rocblas_sgbmv_batched_ ( type(c_ptr), value  handle,
integer(kind(rocblas_operation_none)), value  trans,
integer(c_int), value  m,
integer(c_int), value  n,
integer(c_int), value  kl,
integer(c_int), value  ku,
real(c_float)  alpha,
type(c_ptr), value  a,
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,
integer(c_int), value  batch_count 
)

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