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

rocblas_zgeam_batched Interface Reference

rocblas_zgeam_batched Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_zgeam_batched Interface Reference
hipfort_rocblas::rocblas_zgeam_batched Interface Reference

BLAS Level 3 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_zgeam_batched_ (handle, transA, transB, m, n, alpha, A, lda, beta, B, ldb, C, ldc, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zgeam_batched_full_rank (handle, transA, transB, m, n, alpha, A, lda, beta, B, ldb, C, ldc, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zgeam_batched_rank_0 (handle, transA, transB, m, n, alpha, A, lda, beta, B, ldb, C, ldc, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zgeam_batched_rank_1 (handle, transA, transB, m, n, alpha, A, lda, beta, B, ldb, C, ldc, batch_count)
 

Detailed Description

BLAS Level 3 API.

geam_batched performs one of the batched matrix-matrix operations

C_i = alpha*op( A_i ) + beta*op( B_i )  for i = 0, 1, ... batch_count - 1

where alpha and beta are scalars, and op(A_i), op(B_i) and C_i are m by n matrices and op( X ) is one of

op( X ) = X      or
op( X ) = X**T
Parameters
[in]handle[rocblas_handle] handle to the rocblas library context queue.
[in]transA[rocblas_operation] specifies the form of op( A )
[in]transB[rocblas_operation] specifies the form of op( B )
[in]m[rocblas_int] matrix dimension m.
[in]n[rocblas_int] matrix dimension n.
[in]alphadevice pointer or host pointer specifying the scalar alpha.
[in]Adevice array of device pointers storing each matrix A_i on the GPU. Each A_i is of dimension ( lda, k ), where k is m when transA == rocblas_operation_none and is n when transA == rocblas_operation_transpose.
[in]lda[rocblas_int] specifies the leading dimension of A.
[in]betadevice pointer or host pointer specifying the scalar beta.
[in]Bdevice array of device pointers storing each matrix B_i on the GPU. Each B_i is of dimension ( ldb, k ), where k is m when transB == rocblas_operation_none and is n when transB == rocblas_operation_transpose.
[in]ldb[rocblas_int] specifies the leading dimension of B.
[in,out]Cdevice array of device pointers storing each matrix C_i on the GPU. Each C_i is of dimension ( ldc, n ).
[in]ldc[rocblas_int] specifies the leading dimension of C.
[in]batch_count[rocblas_int] number of instances i in the batch.

Member Function/Subroutine Documentation

◆ rocblas_zgeam_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zgeam_batched::rocblas_zgeam_batched_ ( type(c_ptr), value  handle,
integer(kind(rocblas_operation_none)), value  transA,
integer(kind(rocblas_operation_none)), value  transB,
integer(c_int), value  m,
integer(c_int), value  n,
complex(c_double_complex)  alpha,
type(c_ptr)  A,
integer(c_int), value  lda,
complex(c_double_complex)  beta,
type(c_ptr)  B,
integer(c_int), value  ldb,
type(c_ptr)  C,
integer(c_int), value  ldc,
integer(c_int), value  batch_count 
)

◆ rocblas_zgeam_batched_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zgeam_batched::rocblas_zgeam_batched_full_rank ( type(c_ptr)  handle,
integer(kind(rocblas_operation_none))  transA,
integer(kind(rocblas_operation_none))  transB,
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)  beta,
complex(c_double_complex), dimension(:,:,:), target  B,
integer(c_int)  ldb,
complex(c_double_complex), dimension(:,:,:), target  C,
integer(c_int)  ldc,
integer(c_int)  batch_count 
)

◆ rocblas_zgeam_batched_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zgeam_batched::rocblas_zgeam_batched_rank_0 ( type(c_ptr)  handle,
integer(kind(rocblas_operation_none))  transA,
integer(kind(rocblas_operation_none))  transB,
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)  beta,
complex(c_double_complex), target  B,
integer(c_int)  ldb,
complex(c_double_complex), target  C,
integer(c_int)  ldc,
integer(c_int)  batch_count 
)

◆ rocblas_zgeam_batched_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zgeam_batched::rocblas_zgeam_batched_rank_1 ( type(c_ptr)  handle,
integer(kind(rocblas_operation_none))  transA,
integer(kind(rocblas_operation_none))  transB,
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)  beta,
complex(c_double_complex), dimension(:), target  B,
integer(c_int)  ldb,
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: