rocblas_zsymm_batched Interface Reference

rocblas_zsymm_batched Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_zsymm_batched Interface Reference
hipfort_rocblas::rocblas_zsymm_batched Interface Reference

BLAS Level 3 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_zsymm_batched_ (handle, side, uplo, m, n, alpha, A, lda, B, ldb, beta, C, ldc, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zsymm_batched_full_rank (handle, side, uplo, m, n, alpha, A, lda, B, ldb, beta, C, ldc, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zsymm_batched_rank_0 (handle, side, uplo, m, n, alpha, A, lda, B, ldb, beta, C, ldc, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zsymm_batched_rank_1 (handle, side, uplo, m, n, alpha, A, lda, B, ldb, beta, C, ldc, batch_count)
 

Detailed Description

BLAS Level 3 API.

symm_batched performs a batch of the matrix-matrix operations:

C_i := alpha*A_i*B_i + beta*C_i if side == rocblas_side_left, C_i := alpha*B_i*A_i + beta*C_i if side == rocblas_side_right,

where alpha and beta are scalars, B_i and C_i are m by n matrices, and A_i 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_i := alpha*A_i*B_i + beta*C_i rocblas_side_right: C_i := alpha*B_i*A_i + beta*C_i
[in]uplo[rocblas_fill] rocblas_fill_upper: A_i is an upper triangular matrix rocblas_fill_lower: A_i is a lower triangular matrix
[in]m[rocblas_int] m specifies the number of rows of B_i and C_i. m >= 0.
[in]n[rocblas_int] n specifies the number of columns of B_i and C_i. n >= 0.
[in]alphaalpha specifies the scalar alpha. When alpha is zero then A_i and B_i are not referenced.
[in]Adevice array of device pointers storing each matrix A_i on the GPU. A_i is m by m if side == rocblas_side_left A_i 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_i. if side = rocblas_side_left, lda >= max( 1, m ), otherwise lda >= max( 1, n ).
[in]Bdevice array of device pointers storing each matrix B_i on the GPU. Matrix dimension is m by n
[in]ldb[rocblas_int] ldb specifies the first dimension of B_i. ldb >= max( 1, m )
[in]betabeta specifies the scalar beta. When beta is zero then C_i need not be set before entry.
[in]Cdevice array of device pointers storing each matrix C_i on the GPU. Matrix dimension is m by n
[in]ldc[rocblas_int] ldc specifies the first dimension of C_i. ldc >= max( 1, m )
[in]batch_count[rocblas_int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ rocblas_zsymm_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zsymm_batched::rocblas_zsymm_batched_ ( 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,
complex(c_double_complex)  alpha,
type(c_ptr)  A,
integer(c_int), value  lda,
type(c_ptr)  B,
integer(c_int), value  ldb,
complex(c_double_complex)  beta,
type(c_ptr)  C,
integer(c_int), value  ldc,
integer(c_int), value  batch_count 
)

◆ rocblas_zsymm_batched_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zsymm_batched::rocblas_zsymm_batched_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,
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,
integer(c_int)  batch_count 
)

◆ rocblas_zsymm_batched_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zsymm_batched::rocblas_zsymm_batched_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,
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,
integer(c_int)  batch_count 
)

◆ rocblas_zsymm_batched_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zsymm_batched::rocblas_zsymm_batched_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,
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,
integer(c_int)  batch_count 
)

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