rocblas_chpmv_batched Interface Reference

rocblas_chpmv_batched Interface Reference#

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

BLAS Level 2 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_chpmv_batched_ (handle, uplo, n, alpha, ap, x, incx, beta, y, incy, batch_count)
 

Detailed Description

BLAS Level 2 API.

The hpmv_batched functions perform the matrix-vector operation: 

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 matrix, supplied in packed form (see description below), 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 Hermitian matrix A_i is supplied in AP.
  • rocblas_fill_lower: the lower triangular part of each Hermitian matrix A_i is supplied in AP.
[in]n- [rocblas_int] the order of each matrix A_i.
[in]alpha- device pointer or host pointer to scalar alpha.
[in]AP- device pointer of device pointers storing the packed version of the specified triangular portion of each Hermitian matrix A_i. Each A_i is of at least size ((n * (n + 1)) / 2). 
    if uplo == rocblas_fill_upper:
        The upper triangular portion of each Hermitian matrix A_i is supplied.
        The matrix is compacted so that each AP_i 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: (rocblas_fill_upper; n = 3)
            (1, 0) (2, 1) (3, 2)
            (2,-1) (4, 0) (5,-1) ---> [(1,0),(2,1),(4,0),(3,2),(5,-1),(6,0)]
            (3,-2) (5, 1) (6, 0)

    if uplo == rocblas_fill_lower:
        The lower triangular portion of each Hermitian matrix A_i is supplied.
        The matrix is compacted so that each AP_i contains the triangular
        portion
        column-by-column
        so that:
        AP(0) = A(0,0)
        AP(1) = A(1,0)
        AP(2) = A(2,1), etc.
        Ex: (rocblas_fill_lower; n = 3)
            (1, 0) (2, 1) (3, 2)
            (2,-1) (4, 0) (5,-1) ---> [(1,0),(2,-1),(3,-2),(4,0),(5,1),(6,0)]
            (3,-2) (5, 1) (6, 0)
Note that the imaginary parts of the diagonal elements are not accessed and are assumed to be 0.
[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_chpmv_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_chpmv_batched::rocblas_chpmv_batched_ ( type(c_ptr), value  handle,
integer(kind(rocblas_fill_upper)), value  uplo,
integer(c_int), value  n,
complex(c_float_complex)  alpha,
type(c_ptr), value  ap,
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: