hipblassyrkex Interface Reference

hipblassyrkex Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblassyrkex Interface Reference
hipfort_hipblas::hipblassyrkex Interface Reference

BLAS EX API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblassyrkex_ (handle, uplo, transa, n, k, alpha, a, atype, lda, beta, c, ctype, ldc, computetype)
 

Detailed Description

BLAS EX API.

The syrkEx function performs one of the matrix-matrix operations for a symmetric rank-k update:

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

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

op( A ) = A, and A is n by k if transA == HIPBLAS_OP_N
op( A ) = A^T and A is k by n if transA == HIPBLAS_OP_T
  • Supported types are determined by the backend. See the rocBLAS or cuBLAS documentation.
Parameters
[in]handle- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in]uplo- [hipblasFillMode_t] Specifies whether the matrix C is an upper or lower triangular matrix as follows:
  • HIPBLAS_FILL_MODE_UPPER: C is an upper triangular matrix.
  • HIPBLAS_FILL_MODE_LOWER: C is a lower triangular matrix.
[in]transA- [hipblasOperation_t] specifies the form of op( A ).
[in]n- [int] matrix dimension n.
[in]k- [int] matrix dimension k.
[in]alpha- [const void *] device pointer or host pointer specifying the scalar alpha. Same datatype as computeType.
[in]A- [void *] device pointer storing matrix A.
[in]aType[hipDataType] specifies the datatype of matrix A.
[in]lda- [int] specifies the leading dimension of A.
[in]beta- [const void *] device pointer or host pointer specifying the scalar beta. Same datatype as computeType.
[in]C- [void *] device pointer storing matrix C.
[in]cType[hipDataType] specifies the datatype of matrix C.
[in]ldc- [int] specifies the leading dimension of C.
[in]computeType[hipDataType] specifies the datatype of the computation.

Member Function/Subroutine Documentation

◆ hipblassyrkex_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassyrkex::hipblassyrkex_ ( 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,
type(c_ptr), value  alpha,
type(c_ptr), value  a,
integer(kind(hip_r_32f)), value  atype,
integer(c_int), value  lda,
type(c_ptr), value  beta,
type(c_ptr), value  c,
integer(kind(hip_r_32f)), value  ctype,
integer(c_int), value  ldc,
integer(kind(hip_r_32f)), value  computetype 
)

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