rocblas_cherk Interface Reference

rocblas_cherk Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_cherk Interface Reference
hipfort_rocblas::rocblas_cherk Interface Reference

BLAS Level 3 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_cherk_ (handle, uplo, transa, n, k, alpha, a, lda, beta, c, ldc)
 
integer(kind(rocblas_status_success)) function rocblas_cherk_rank_0 (handle, uplo, transa, n, k, alpha, a, lda, beta, c, ldc)
 
integer(kind(rocblas_status_success)) function rocblas_cherk_rank_1 (handle, uplo, transa, n, k, alpha, a, lda, beta, c, ldc)
 
integer(kind(rocblas_status_success)) function rocblas_cherk_full_rank (handle, uplo, transa, n, k, alpha, a, lda, beta, c, ldc)
 

Detailed Description

BLAS Level 3 API.

The herk functions perform one of the matrix-matrix operations for a Hermitian rank-k update:

C := alpha*op( A )*op( A )^H + beta*C,

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

op( A ) = A, and A is n by k if transA == rocblas_operation_none
op( A ) = A^H and A is k by n if transA == rocblas_operation_conjugate_transpose
Parameters
[in]handle- [rocblas_handle] handle to the rocBLAS library context queue.
[in]uplo- [rocblas_fill]
  • rocblas_fill_upper: C is an upper triangular matrix.
  • rocblas_fill_lower: C is a lower triangular matrix.
[in]transA- [rocblas_operation]
  • rocblas_operation_conjugate_transpose: op(A) = A^H
  • rocblas_operation_none: op(A) = A
[in]n- [rocblas_int] n specifies the number of rows and columns of C. n >= 0.
[in]k- [rocblas_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]A- pointer storing matrix A on the GPU. Matrix dimension is ( lda, k ) when transA = rocblas_operation_none. Otherwise, (lda, n).
[in]lda- [rocblas_int] lda specifies the first dimension of A.
  • If transA = rocblas_operation_none, lda >= max( 1, n ).
  • Otherwise, lda >= max( 1, k ).
[in]betabeta specifies the scalar beta. When beta is zero, then C need not be set before entry.
[in]C- pointer storing matrix C on the GPU. The imaginary component of the diagonal elements are not used but are set to zero unless quick return. Only the upper/lower triangular part is accessed.
[in]ldc- [rocblas_int] ldc specifies the first dimension of C. ldc >= max( 1, n ).

Member Function/Subroutine Documentation

◆ rocblas_cherk_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_cherk::rocblas_cherk_ ( 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_float)  alpha,
type(c_ptr), value  a,
integer(c_int), value  lda,
real(c_float)  beta,
type(c_ptr), value  c,
integer(c_int), value  ldc 
)

◆ rocblas_cherk_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_cherk::rocblas_cherk_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_float)  alpha,
complex(c_float_complex), dimension(:,:), target  a,
integer(c_int)  lda,
real(c_float)  beta,
complex(c_float_complex), dimension(:,:), target  c,
integer(c_int)  ldc 
)

◆ rocblas_cherk_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_cherk::rocblas_cherk_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_float)  alpha,
complex(c_float_complex), target  a,
integer(c_int)  lda,
real(c_float)  beta,
complex(c_float_complex), target  c,
integer(c_int)  ldc 
)

◆ rocblas_cherk_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_cherk::rocblas_cherk_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_float)  alpha,
complex(c_float_complex), dimension(:), target  a,
integer(c_int)  lda,
real(c_float)  beta,
complex(c_float_complex), dimension(:), target  c,
integer(c_int)  ldc 
)

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