hipblascherkbatched Interface Reference

hipblascherkbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblascherkbatched Interface Reference
Public Member Functions | List of all members
hipfort_hipblas::hipblascherkbatched Interface Reference

BLAS Level 3 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblascherkbatched_ (handle, uplo, transa, n, k, alpha, ap, lda, beta, cp, ldc, batchcount)
 

Detailed Description

BLAS Level 3 API.

The herkBatched functions perform a batch of the matrix-matrix operations for a Hermitian rank-k update: 

C_i := alpha*op( A_i )*op( A_i )^H + beta*C_i

where alpha and beta are scalars, op(A) is an n by k matrix, and C_i is an 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 == HIPBLAS_OP_N
op( A_i ) = A_i^H and A_i is k by n if transA == HIPBLAS_OP_C
  • Supported precisions in rocBLAS : c and z.
  • Supported precisions in cuBLAS : No support.
Parameters
[in]handle- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in]uplo- [hipblasFillMode_t]
  • HIPBLAS_FILL_MODE_UPPER: C_i is an upper triangular matrix.
  • HIPBLAS_FILL_MODE_LOWER: C_i is a lower triangular matrix.
[in]transA- [hipblasOperation_t]
  • HIPBLAS_OP_C: op(A) = A^H
  • HIPBLAS_OP_N: op(A) = A
[in]n- [int] n specifies the number of rows and columns of C_i. n >= 0.
[in]k- [int] k specifies the number of columns of op(A). k >= 0.
[in]alphaalpha specifies the scalar alpha. When alpha is zero, then A is not referenced and A does not need to be set before entry.
[in]AP- device array of device pointers storing each matrix_i A of dimension (lda, k) when transA is HIPBLAS_OP_N. Otherwise, of dimension (lda, n).
[in]lda- [int] lda specifies the first dimension of A_i. If transA = HIPBLAS_OP_N, lda >= max( 1, n ). Otherwise, lda >= max( 1, k ).
[in]betabeta specifies the scalar beta. When beta is zero, then C does not need to be set before entry.
[in]CP- device array of device pointers storing each matrix C_i on the GPU. The imaginary components of the diagonal elements are not used but are set to zero, except for quick return.
[in]ldc- [int] ldc specifies the first dimension of C. ldc >= max( 1, n ).
[in]batchCount- [int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ hipblascherkbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblascherkbatched::hipblascherkbatched_ ( type(c_ptr), value  handle,
integer(kind(hipblas_fill_mode_upper)), value  uplo,
integer(kind(hipblas_op_n)), value  transa,
integer(c_int), value  n,
integer(c_int), value  k,
real(c_float)  alpha,
type(c_ptr), value  ap,
integer(c_int), value  lda,
real(c_float)  beta,
type(c_ptr), value  cp,
integer(c_int), value  ldc,
integer(c_int), value  batchcount 
)
The documentation for this interface was generated from the following file: