hipblaszher2kbatched Interface Reference

hipblaszher2kbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblaszher2kbatched Interface Reference
hipfort_hipblas::hipblaszher2kbatched Interface Reference

BLAS Level 3 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblaszher2kbatched_ (handle, uplo, transA, n, k, alpha, A, lda, B, ldb, beta, C, ldc, batchCount)
 
integer(kind(hipblas_status_success)) function hipblaszher2kbatched_full_rank (handle, uplo, transA, n, k, alpha, A, lda, B, ldb, beta, C, ldc, batchCount)
 
integer(kind(hipblas_status_success)) function hipblaszher2kbatched_rank_0 (handle, uplo, transA, n, k, alpha, A, lda, B, ldb, beta, C, ldc, batchCount)
 
integer(kind(hipblas_status_success)) function hipblaszher2kbatched_rank_1 (handle, uplo, transA, n, k, alpha, A, lda, B, ldb, beta, C, ldc, batchCount)
 

Detailed Description

BLAS Level 3 API.

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

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

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

op( A_i ) = A_i, op( B_i ) = B_i, and A_i and B_i are n by k if trans == HIPBLAS_OP_N
op( A_i ) = A_i^H, op( B_i ) = B_i^H,  and A_i and B_i are k by n if trans == HIPBLAS_OP_C
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]trans[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 need not be set before entry.
[in]Adevice array of device pointers storing each matrix_i A of dimension (lda, k) when trans is HIPBLAS_OP_N, otherwise of dimension (lda, n)
[in]lda[int] lda specifies the first dimension of A_i. if trans = HIPBLAS_OP_N, lda >= max( 1, n ), otherwise lda >= max( 1, k ).
[in]Bdevice array of device pointers storing each matrix_i B of dimension (ldb, k) when trans is HIPBLAS_OP_N, otherwise of dimension (ldb, n)
[in]ldb[int] ldb specifies the first dimension of B_i. if trans = HIPBLAS_OP_N, ldb >= max( 1, n ), otherwise ldb >= max( 1, k ).
[in]betabeta specifies the scalar beta. When beta is zero then C need not be set before entry.
[in]Cdevice 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.
[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

◆ hipblaszher2kbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszher2kbatched::hipblaszher2kbatched_ ( 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,
complex(c_double_complex)  alpha,
type(c_ptr)  A,
integer(c_int), value  lda,
type(c_ptr)  B,
integer(c_int), value  ldb,
real(c_double)  beta,
type(c_ptr)  C,
integer(c_int), value  ldc,
integer(c_int), value  batchCount 
)

◆ hipblaszher2kbatched_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszher2kbatched::hipblaszher2kbatched_full_rank ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(kind(hipblas_op_n))  transA,
integer(c_int)  n,
integer(c_int)  k,
complex(c_double_complex)  alpha,
complex(c_double_complex), dimension(:,:,:), target  A,
integer(c_int)  lda,
complex(c_double_complex), dimension(:,:,:), target  B,
integer(c_int)  ldb,
real(c_double)  beta,
complex(c_double_complex), dimension(:,:,:), target  C,
integer(c_int)  ldc,
integer(c_int)  batchCount 
)

◆ hipblaszher2kbatched_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszher2kbatched::hipblaszher2kbatched_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(kind(hipblas_op_n))  transA,
integer(c_int)  n,
integer(c_int)  k,
complex(c_double_complex)  alpha,
complex(c_double_complex), target  A,
integer(c_int)  lda,
complex(c_double_complex), target  B,
integer(c_int)  ldb,
real(c_double)  beta,
complex(c_double_complex), target  C,
integer(c_int)  ldc,
integer(c_int)  batchCount 
)

◆ hipblaszher2kbatched_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszher2kbatched::hipblaszher2kbatched_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(kind(hipblas_op_n))  transA,
integer(c_int)  n,
integer(c_int)  k,
complex(c_double_complex)  alpha,
complex(c_double_complex), dimension(:), target  A,
integer(c_int)  lda,
complex(c_double_complex), dimension(:), target  B,
integer(c_int)  ldb,
real(c_double)  beta,
complex(c_double_complex), dimension(:), target  C,
integer(c_int)  ldc,
integer(c_int)  batchCount 
)

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