rocblas_zhpr_batched Interface Reference

rocblas_zhpr_batched Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_zhpr_batched Interface Reference
hipfort_rocblas::rocblas_zhpr_batched Interface Reference

! More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_zhpr_batched_ (handle, uplo, n, alpha, x, incx, AP, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zhpr_batched_full_rank (handle, uplo, n, alpha, x, incx, AP, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zhpr_batched_rank_0 (handle, uplo, n, alpha, x, incx, AP, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zhpr_batched_rank_1 (handle, uplo, n, alpha, x, incx, AP, batch_count)
 

Detailed Description

!

BLAS Level 2 API

\details
xHPR_BATCHED performs the matrix-vector operations

    A_i := A_i + alphax_ix_iH

where alpha is a real scalar, x_i is a vector, and A_i is an
n by n symmetric matrix, supplied in packed form, for i = 1, ..., batch_count.

@param[in]
handle    [rocblas_handle]
          handle to the rocblas library context queue.
@param[in]
uplo      [rocblas_fill]
          specifies whether the upper 'rocblas_fill_upper' or lower 'rocblas_fill_lower'
          rocblas_fill_upper: The upper triangular part of each A_i is supplied in AP.
          rocblas_fill_lower: The lower triangular part of each A_i is supplied in AP.
@param[in]
n         [rocblas_int]
          the number of rows and columns of each matrix A_i, must be at least 0.
@param[in]
alpha
          device pointer or host pointer to scalar alpha.
@param[in]
x         device array of device pointers storing each vector x_i.
@param[in]
incx      [rocblas_int]
          specifies the increment for the elements of each x_i.
@param[inout]
AP        device array of device pointers storing the packed version of the specified triangular portion of
          each Hermitian matrix A_i of at least size ((n  (n + 1))  2). Array is of at least size batch_count.
          if uplo == rocblas_fill_upper:
            The upper triangular portion of each Hermitian matrix A_i is supplied.
            The matrix is compacted so that AP 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) (4,9)
                    (2,-1) (3, 0) (5,3)  -----> [(1,0), (2,1), (3,0), (4,9), (5,3), (6,0)]
                    (4,-9) (5,-3) (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 AP 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) (4,9)
                    (2,-1) (3, 0) (5,3)  -----> [(1,0), (2,-1), (4,-9), (3,0), (5,-3), (6,0)]
                    (4,-9) (5,-3) (6,0)
        Note that the imaginary part of the diagonal elements are not accessed and are assumed
        to be 0.
@param[in]
batch_count [rocblas_int]
            number of instances in the batch.

Member Function/Subroutine Documentation

◆ rocblas_zhpr_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zhpr_batched::rocblas_zhpr_batched_ ( type(c_ptr), value  handle,
integer(kind(rocblas_fill_upper)), value  uplo,
integer(c_int), value  n,
real(c_double)  alpha,
type(c_ptr)  x,
integer(c_int), value  incx,
type(c_ptr)  AP,
integer(c_int), value  batch_count 
)

◆ rocblas_zhpr_batched_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zhpr_batched::rocblas_zhpr_batched_full_rank ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
real(c_double)  alpha,
complex(c_double_complex), dimension(:,:), target  x,
integer(c_int)  incx,
type(c_ptr)  AP,
integer(c_int)  batch_count 
)

◆ rocblas_zhpr_batched_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zhpr_batched::rocblas_zhpr_batched_rank_0 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
real(c_double)  alpha,
complex(c_double_complex), target  x,
integer(c_int)  incx,
type(c_ptr)  AP,
integer(c_int)  batch_count 
)

◆ rocblas_zhpr_batched_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zhpr_batched::rocblas_zhpr_batched_rank_1 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
real(c_double)  alpha,
complex(c_double_complex), dimension(:), target  x,
integer(c_int)  incx,
type(c_ptr)  AP,
integer(c_int)  batch_count 
)

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