rocblas_ssymm Interface Reference

rocblas_ssymm Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_ssymm Interface Reference
hipfort_rocblas::rocblas_ssymm Interface Reference

BLAS Level 3 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_ssymm_ (handle, side, uplo, m, n, alpha, a, lda, b, ldb, beta, c, ldc)
 
integer(kind(rocblas_status_success)) function rocblas_ssymm_rank_0 (handle, side, uplo, m, n, alpha, a, lda, b, ldb, beta, c, ldc)
 
integer(kind(rocblas_status_success)) function rocblas_ssymm_rank_1 (handle, side, uplo, m, n, alpha, a, lda, b, ldb, beta, c, ldc)
 
integer(kind(rocblas_status_success)) function rocblas_ssymm_full_rank (handle, side, uplo, m, n, alpha, a, lda, b, ldb, beta, c, ldc)
 

Detailed Description

BLAS Level 3 API.

The symm functions perform one of the matrix-matrix operations:

C := alpha*A*B + beta*C if side == rocblas_side_left,
C := alpha*B*A + beta*C if side == rocblas_side_right,

where alpha and beta are scalars, B and C are m by n matrices, and A is a symmetric matrix stored as either upper or lower.

Parameters
[in]handle- [rocblas_handle] handle to the rocBLAS library context queue.
[in]side- [rocblas_side]
  • rocblas_side_left: C := alpha*A*B + beta*C
  • rocblas_side_right: C := alpha*B*A + beta*C
[in]uplo- [rocblas_fill]
  • rocblas_fill_upper: A is an upper triangular matrix
  • rocblas_fill_lower: A is a lower triangular matrix
[in]m- [rocblas_int] m specifies the number of rows of B and C. m >= 0.
[in]n- [rocblas_int] n specifies the number of columns of B and C. n >= 0.
[in]alphaalpha specifies the scalar alpha. When alpha is zero, A and B are not referenced.
[in]A- pointer storing matrix A on the GPU.
  • A is m by m if side == rocblas_side_left.
  • A is n by n if side == rocblas_side_right.
  • Only the upper/lower triangular part is accessed.
[in]lda- [rocblas_int] lda specifies the first dimension of A.
  • If side = rocblas_side_left, lda >= max( 1, m ).
  • Otherwise, lda >= max( 1, n ).
[in]B- pointer storing matrix B on the GPU. Matrix dimension is m by n.
[in]ldb- [rocblas_int] ldb specifies the first dimension of B. ldb >= max( 1, m ).
[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. Matrix dimension is m by n.
[in]ldc- [rocblas_int] ldc specifies the first dimension of C. ldc >= max( 1, m ).

Member Function/Subroutine Documentation

◆ rocblas_ssymm_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_ssymm::rocblas_ssymm_ ( type(c_ptr), value  handle,
integer(kind(rocblas_side_left)), value  side,
integer(kind(rocblas_fill_upper)), value  uplo,
integer(c_int), value  m,
integer(c_int), value  n,
real(c_float)  alpha,
type(c_ptr), value  a,
integer(c_int), value  lda,
type(c_ptr), value  b,
integer(c_int), value  ldb,
real(c_float)  beta,
type(c_ptr), value  c,
integer(c_int), value  ldc 
)

◆ rocblas_ssymm_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_ssymm::rocblas_ssymm_full_rank ( type(c_ptr)  handle,
integer(kind(rocblas_side_left))  side,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  m,
integer(c_int)  n,
real(c_float)  alpha,
real(c_float), dimension(:,:), target  a,
integer(c_int)  lda,
real(c_float), dimension(:,:), target  b,
integer(c_int)  ldb,
real(c_float)  beta,
real(c_float), dimension(:,:), target  c,
integer(c_int)  ldc 
)

◆ rocblas_ssymm_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_ssymm::rocblas_ssymm_rank_0 ( type(c_ptr)  handle,
integer(kind(rocblas_side_left))  side,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  m,
integer(c_int)  n,
real(c_float)  alpha,
real(c_float), target  a,
integer(c_int)  lda,
real(c_float), target  b,
integer(c_int)  ldb,
real(c_float)  beta,
real(c_float), target  c,
integer(c_int)  ldc 
)

◆ rocblas_ssymm_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_ssymm::rocblas_ssymm_rank_1 ( type(c_ptr)  handle,
integer(kind(rocblas_side_left))  side,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  m,
integer(c_int)  n,
real(c_float)  alpha,
real(c_float), dimension(:), target  a,
integer(c_int)  lda,
real(c_float), dimension(:), target  b,
integer(c_int)  ldb,
real(c_float)  beta,
real(c_float), dimension(:), target  c,
integer(c_int)  ldc 
)

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