hipblaszherkx Interface Reference#
hipfort_hipblas::hipblaszherkx Interface Reference
BLAS Level 3 API. More...
Public Member Functions | |
integer(kind(hipblas_status_success)) function | hipblaszherkx_ (handle, uplo, transA, n, k, alpha, A, lda, B, ldb, beta, C, ldc) |
integer(kind(hipblas_status_success)) function | hipblaszherkx_full_rank (handle, uplo, transA, n, k, alpha, A, lda, B, ldb, beta, C, ldc) |
integer(kind(hipblas_status_success)) function | hipblaszherkx_rank_0 (handle, uplo, transA, n, k, alpha, A, lda, B, ldb, beta, C, ldc) |
integer(kind(hipblas_status_success)) function | hipblaszherkx_rank_1 (handle, uplo, transA, n, k, alpha, A, lda, B, ldb, beta, C, ldc) |
Detailed Description
BLAS Level 3 API.
herkx performs one of the matrix-matrix operations for a Hermitian rank-k update
C := alpha*op( A )*op( B )^H + beta*C
where alpha and beta are scalars, op(A) and op(B) are n by k matrices, and C is a n x n Hermitian matrix stored as either upper or lower. This routine should only be used when the caller can guarantee that the result of op( A )*op( B )^T will be Hermitian.
op( A ) = A, op( B ) = B, and A and B are n by k if trans == HIPBLAS_OP_N op( A ) = A^H, op( B ) = B^H, and A and B are k by n if trans == HIPBLAS_OP_C @param[in] handle [hipblasHandle_t] handle to the hipblas library context queue. @param[in] uplo [hipblasFillMode_t] HIPBLAS_FILL_MODE_UPPER: C is an upper triangular matrix HIPBLAS_FILL_MODE_LOWER: C is a lower triangular matrix @param[in] trans [hipblasOperation_t] HIPBLAS_OP_C: op( A ) = A^H, op( B ) = B^H HIPBLAS_OP_N: op( A ) = A, op( B ) = B @param[in] n [int] n specifies the number of rows and columns of C. n >= 0. @param[in] k [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 pointer storing matrix A on the GPU. Martrix dimension is ( lda, k ) when if trans = HIPBLAS_OP_N, otherwise (lda, n) only the upper/lower triangular part is accessed. @param[in] lda [int] lda specifies the first dimension of A. if trans = HIPBLAS_OP_N, lda >= max( 1, n ), otherwise lda >= max( 1, k ). @param[in] B pointer storing matrix B on the GPU. Martrix dimension is ( ldb, k ) when if trans = HIPBLAS_OP_N, otherwise (ldb, n) only the upper/lower triangular part is accessed. @param[in] ldb [int] ldb specifies the first dimension of B. if trans = HIPBLAS_OP_N, ldb >= max( 1, n ), otherwise ldb >= 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 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. @param[in] ldc [int] ldc specifies the first dimension of C. ldc >= max( 1, n ).
Member Function/Subroutine Documentation
◆ hipblaszherkx_()
integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszherkx::hipblaszherkx_ | ( | 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), value | A, | ||
integer(c_int), value | lda, | ||
type(c_ptr), value | B, | ||
integer(c_int), value | ldb, | ||
real(c_double) | beta, | ||
type(c_ptr), value | C, | ||
integer(c_int), value | ldc | ||
) |
◆ hipblaszherkx_full_rank()
integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszherkx::hipblaszherkx_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 | ||
) |
◆ hipblaszherkx_rank_0()
integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszherkx::hipblaszherkx_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 | ||
) |
◆ hipblaszherkx_rank_1()
integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszherkx::hipblaszherkx_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 | ||
) |
The documentation for this interface was generated from the following file: