This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

hipblaszsymm Interface Reference

hipblaszsymm Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblaszsymm Interface Reference
hipfort_hipblas::hipblaszsymm Interface Reference

BLAS Level 3 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblaszsymm_ (handle, side, uplo, m, n, alpha, A, lda, B, ldb, beta, C, ldc)
 
integer(kind(hipblas_status_success)) function hipblaszsymm_full_rank (handle, side, uplo, m, n, alpha, A, lda, B, ldb, beta, C, ldc)
 
integer(kind(hipblas_status_success)) function hipblaszsymm_rank_0 (handle, side, uplo, m, n, alpha, A, lda, B, ldb, beta, C, ldc)
 
integer(kind(hipblas_status_success)) function hipblaszsymm_rank_1 (handle, side, uplo, m, n, alpha, A, lda, B, ldb, beta, C, ldc)
 

Detailed Description

BLAS Level 3 API.

symm performs one of the matrix-matrix operations:

C := alpha*A*B + beta*C if side == HIPBLAS_SIDE_LEFT, C := alpha*B*A + beta*C if side == HIPBLAS_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[hipblasHandle_t] handle to the hipblas library context queue.
[in]side[hipblasSideMode_t] HIPBLAS_SIDE_LEFT: C := alpha*A*B + beta*C HIPBLAS_SIDE_RIGHT: C := alpha*B*A + beta*C
[in]uplo[hipblasFillMode_t] HIPBLAS_FILL_MODE_UPPER: A is an upper triangular matrix HIPBLAS_FILL_MODE_LOWER: A is a lower triangular matrix
[in]m[int] m specifies the number of rows of B and C. m >= 0.
[in]n[int] n specifies the number of columns of B and C. n >= 0.
[in]alphaalpha specifies the scalar alpha. When alpha is zero then A and B are not referenced.
[in]Apointer storing matrix A on the GPU. A is m by m if side == HIPBLAS_SIDE_LEFT A is n by n if side == HIPBLAS_SIDE_RIGHT only the upper/lower triangular part is accessed.
[in]lda[int] lda specifies the first dimension of A. if side = HIPBLAS_SIDE_LEFT, lda >= max( 1, m ), otherwise lda >= max( 1, n ).
[in]Bpointer storing matrix B on the GPU. Matrix dimension is m by n
[in]ldb[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]Cpointer storing matrix C on the GPU. Matrix dimension is m by n
[in]ldc[int] ldc specifies the first dimension of C. ldc >= max( 1, m )

Member Function/Subroutine Documentation

◆ hipblaszsymm_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszsymm::hipblaszsymm_ ( type(c_ptr), value  handle,
integer(kind(hipblas_side_left)), value  side,
integer(kind(hipblas_fill_mode_upper)), value  uplo,
integer(c_int), value  m,
integer(c_int), value  n,
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,
complex(c_double_complex)  beta,
type(c_ptr), value  C,
integer(c_int), value  ldc 
)

◆ hipblaszsymm_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszsymm::hipblaszsymm_full_rank ( type(c_ptr)  handle,
integer(kind(hipblas_side_left))  side,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  m,
integer(c_int)  n,
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,
complex(c_double_complex)  beta,
complex(c_double_complex), dimension(:,:), target  C,
integer(c_int)  ldc 
)

◆ hipblaszsymm_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszsymm::hipblaszsymm_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_side_left))  side,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  m,
integer(c_int)  n,
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,
complex(c_double_complex)  beta,
complex(c_double_complex), target  C,
integer(c_int)  ldc 
)

◆ hipblaszsymm_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszsymm::hipblaszsymm_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_side_left))  side,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  m,
integer(c_int)  n,
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,
complex(c_double_complex)  beta,
complex(c_double_complex), dimension(:), target  C,
integer(c_int)  ldc 
)

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