rocblas_chbmv_batched Interface Reference

rocblas_chbmv_batched Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_chbmv_batched Interface Reference
Public Member Functions | List of all members
hipfort_rocblas::rocblas_chbmv_batched Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_chbmv_batched_ (handle, uplo, n, k, alpha, a, lda, x, incx, beta, y, incy, batch_count)
 

Detailed Description

BLAS Level 2 API.

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

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

where alpha and beta are scalars, x_i and y_i are n -element vectors, and A_i is an n by n Hermitian band matrix with k super-diagonals, for each batch in i = [1, batch_count ].

Parameters
[in]handle- [rocblas_handle] handle to the rocBLAS library context queue.
[in]uplo- [rocblas_fill]
  • rocblas_fill_upper: The upper triangular part of each A_i is being supplied.
  • rocblas_fill_lower: The lower triangular part of each A_i is being supplied.
[in]n- [rocblas_int] the order of each matrix A_i.
[in]k- [rocblas_int] the number of super-diagonals of each matrix A_i. Must be >= 0.
[in]alpha- device pointer or host pointer to scalar alpha.
[in]A- device array of device pointers storing each matrix A_i of dimension (lda, n). 
    if uplo == rocblas_fill_upper:
        The leading (k + 1) by n part of each A_i must contain the upper
        triangular band part of the Hermitian matrix, with the leading
        diagonal in row (k + 1), the first super-diagonal on the RHS
        of row k, and so forth.
        The top left k by x triangle of each A_i will not be referenced.
            Ex (upper, lda = n = 4, k = 1):
            A                             Represented matrix
            (0,0) (5,9) (6,8) (7,7)       (1, 0) (5, 9) (0, 0) (0, 0)
            (1,0) (2,0) (3,0) (4,0)       (5,-9) (2, 0) (6, 8) (0, 0)
            (0,0) (0,0) (0,0) (0,0)       (0, 0) (6,-8) (3, 0) (7, 7)
            (0,0) (0,0) (0,0) (0,0)       (0, 0) (0, 0) (7,-7) (4, 0)

    if uplo == rocblas_fill_lower:
        The leading (k + 1) by n part of each A_i must contain the lower
        triangular band part of the Hermitian matrix, with the leading
        diagonal in row (1), the first sub-diagonal on the LHS of
        row 2, and so forth.
        The bottom right k by k triangle of each A_i will not be referenced.
            Ex (lower, lda = 2, n = 4, k = 1):
            A                               Represented matrix
            (1,0) (2,0) (3,0) (4,0)         (1, 0) (5,-9) (0, 0) (0, 0)
            (5,9) (6,8) (7,7) (0,0)         (5, 9) (2, 0) (6,-8) (0, 0)
                                            (0, 0) (6, 8) (3, 0) (7,-7)
                                            (0, 0) (0, 0) (7, 7) (4, 0)

      As a Hermitian matrix, the imaginary part of the main diagonal
      of each A_i will not be referenced and is assumed to be == 0.
[in]lda- [rocblas_int] specifies the leading dimension of each A_i. Must be >= max(1, n).
[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 y.
[in]batch_count- [rocblas_int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ rocblas_chbmv_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_chbmv_batched::rocblas_chbmv_batched_ ( type(c_ptr), value  handle,
integer(kind(rocblas_fill_upper)), value  uplo,
integer(c_int), value  n,
integer(c_int), value  k,
complex(c_float_complex)  alpha,
type(c_ptr), value  a,
integer(c_int), value  lda,
type(c_ptr), value  x,
integer(c_int), value  incx,
complex(c_float_complex)  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: