rocblas_zherk_batched Interface Reference

rocblas_zherk_batched Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_zherk_batched Interface Reference
hipfort_rocblas::rocblas_zherk_batched Interface Reference

! More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_zherk_batched_ (handle, uplo, transA, n, k, alpha, A, lda, beta, C, ldc, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zherk_batched_full_rank (handle, uplo, transA, n, k, alpha, A, lda, beta, C, ldc, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zherk_batched_rank_0 (handle, uplo, transA, n, k, alpha, A, lda, beta, C, ldc, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zherk_batched_rank_1 (handle, uplo, transA, n, k, alpha, A, lda, beta, C, ldc, batch_count)
 

Detailed Description

!

BLAS Level 3 API

\details

herk_batched performs a batch of the matrix-matrix operations for a Hermitian rank-k update

C_i := alphaop( A_i )op( A_i )^H + betaC_i

where  alpha and beta are scalars, op(A) is an n by k matrix, and
C_i is a n x n Hermitian matrix stored as either upper or lower.

    op( A_i ) = A_i, and A_i is n by k if transA == rocblas_operation_none
    op( A_i ) = A_i^H and A_i is k by n if transA == rocblas_operation_conjugate_transpose

@param[in]
handle    [rocblas_handle]
          handle to the rocblas library context queue.

@param[in]
uplo    [rocblas_fill]
        rocblas_fill_upper:  C_i is an upper triangular matrix
        rocblas_fill_lower:  C_i is a  lower triangular matrix

@param[in]
transA  [rocblas_operation]
        rocblas_operation_conjugate_transpose: op(A) = A^H
        rocblas_operation_none:                op(A) = A

@param[in]
n       [rocblas_int]
        n specifies the number of rows and columns of C_i. n >= 0.

@param[in]
k       [rocblas_int]
        k specifies the number of columns of op(A). k >= 0.

@param[in]
alpha
        alpha specifies the scalar alpha. When alpha is
        zero then A is not referenced and A need not be set before
        entry.

@param[in]
A       device array of device pointers storing each matrix_i A of dimension (lda, k)
        when transA is rocblas_operation_none, otherwise of dimension (lda, n)

@param[in]
lda     [rocblas_int]
        lda specifies the first dimension of A_i.
        if transA = rocblas_operation_none,  lda >= max( 1, n ),
        otherwise lda >= max( 1, k ).

@param[in]
beta
        beta specifies the scalar beta. When beta is
        zero then C need not be set before entry.

@param[in]
C       device array of device pointers storing each matrix C_i on the GPU.
        The imaginary component of the diagonal elements are not used but are set to zero unless quick return.

@param[in]
ldc    [rocblas_int]
       ldc specifies the first dimension of C. ldc >= max( 1, n ).
@param[in]
batch_count [rocblas_int]
            number of instances in the batch.

Member Function/Subroutine Documentation

◆ rocblas_zherk_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zherk_batched::rocblas_zherk_batched_ ( type(c_ptr), value  handle,
integer(kind(rocblas_fill_upper)), value  uplo,
integer(kind(rocblas_operation_none)), value  transA,
integer(c_int), value  n,
integer(c_int), value  k,
real(c_double)  alpha,
type(c_ptr)  A,
integer(c_int), value  lda,
real(c_double)  beta,
type(c_ptr)  C,
integer(c_int), value  ldc,
integer(c_int), value  batch_count 
)

◆ rocblas_zherk_batched_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zherk_batched::rocblas_zherk_batched_full_rank ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  transA,
integer(c_int)  n,
integer(c_int)  k,
real(c_double)  alpha,
complex(c_double_complex), dimension(:,:,:), target  A,
integer(c_int)  lda,
real(c_double)  beta,
complex(c_double_complex), dimension(:,:,:), target  C,
integer(c_int)  ldc,
integer(c_int)  batch_count 
)

◆ rocblas_zherk_batched_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zherk_batched::rocblas_zherk_batched_rank_0 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  transA,
integer(c_int)  n,
integer(c_int)  k,
real(c_double)  alpha,
complex(c_double_complex), target  A,
integer(c_int)  lda,
real(c_double)  beta,
complex(c_double_complex), target  C,
integer(c_int)  ldc,
integer(c_int)  batch_count 
)

◆ rocblas_zherk_batched_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zherk_batched::rocblas_zherk_batched_rank_1 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  transA,
integer(c_int)  n,
integer(c_int)  k,
real(c_double)  alpha,
complex(c_double_complex), dimension(:), target  A,
integer(c_int)  lda,
real(c_double)  beta,
complex(c_double_complex), dimension(:), target  C,
integer(c_int)  ldc,
integer(c_int)  batch_count 
)

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