rocblas_ssyrk_batched Interface Reference

rocblas_ssyrk_batched Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_ssyrk_batched Interface Reference
hipfort_rocblas::rocblas_ssyrk_batched Interface Reference

BLAS Level 3 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_ssyrk_batched_ (handle, uplo, transa, n, k, alpha, a, lda, beta, c, ldc, batch_count)
 

Detailed Description

BLAS Level 3 API.

The syrk_batched functions perform a batch of the matrix-matrix operations for a symmetric rank-k update:

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

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

op( A_i ) = A_i, and A_i is n by k if transA == rocblas_operation_none
op( A_i ) = A_i^T and A_i is k by n if transA == rocblas_operation_transpose
Parameters
[in]handle- [rocblas_handle] handle to the rocBLAS library context queue.
[in]uplo- [rocblas_fill]
  • rocblas_fill_upper: C_i is an upper triangular matrix.
  • rocblas_fill_lower: C_i is a lower triangular matrix.
[in]transA- [rocblas_operation]
  • rocblas_operation_transpose: op(A) = A^T
  • rocblas_operation_none: op(A) = A
  • rocblas_operation_conjugate_transpose: op(A) = A^T
  • rocblas_operation_conjugate_transpose is not supported for complex types. See cherk and zherk.
[in]n- [rocblas_int] n specifies the number of rows and columns of C_i. 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, A is not referenced and A need not be set before entry.
[in]A- device array of device pointers storing each matrix_i A of dimension (lda, k) when transA is rocblas_operation_none. Otherwise, of dimension (lda, n).
[in]lda- [rocblas_int] lda specifies the first dimension of A_i.
  • 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- device array of device pointers storing each matrix C_i on the GPU. Only the upper/lower triangular part of each C_i is accessed.
[in]ldc- [rocblas_int] ldc specifies the first dimension of C. ldc >= max( 1, n ).
[in]batch_count- [rocblas_int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ rocblas_ssyrk_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_ssyrk_batched::rocblas_ssyrk_batched_ ( 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,
integer(c_int), value  batch_count 
)

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