hipblaszsymmbatched Interface Reference

hipblaszsymmbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblaszsymmbatched Interface Reference
hipfort_hipblas::hipblaszsymmbatched Interface Reference

BLAS Level 3 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblaszsymmbatched_ (handle, side, uplo, m, n, alpha, A, lda, B, ldb, beta, C, ldc, batchCount)
 
integer(kind(hipblas_status_success)) function hipblaszsymmbatched_full_rank (handle, side, uplo, m, n, alpha, A, lda, B, ldb, beta, C, ldc, batchCount)
 
integer(kind(hipblas_status_success)) function hipblaszsymmbatched_rank_0 (handle, side, uplo, m, n, alpha, A, lda, B, ldb, beta, C, ldc, batchCount)
 
integer(kind(hipblas_status_success)) function hipblaszsymmbatched_rank_1 (handle, side, uplo, m, n, alpha, A, lda, B, ldb, beta, C, ldc, batchCount)
 

Detailed Description

BLAS Level 3 API.

symmBatched performs a batch of the matrix-matrix operations:

C_i := alpha*A_i*B_i + beta*C_i if side == HIPBLAS_SIDE_LEFT, C_i := alpha*B_i*A_i + beta*C_i if side == HIPBLAS_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[hipblasHandle_t] handle to the hipblas library context queue.
[in]side[hipblasSideMode_t] HIPBLAS_SIDE_LEFT: C_i := alpha*A_i*B_i + beta*C_i HIPBLAS_SIDE_RIGHT: C_i := alpha*B_i*A_i + beta*C_i
[in]uplo[hipblasFillMode_t] HIPBLAS_FILL_MODE_UPPER: A_i is an upper triangular matrix HIPBLAS_FILL_MODE_LOWER: A_i is a lower triangular matrix
[in]m[int] m specifies the number of rows of B_i and C_i. m >= 0.
[in]n[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 == HIPBLAS_SIDE_LEFT A_i 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_i. if side = HIPBLAS_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[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[int] ldc specifies the first dimension of C_i. ldc >= max( 1, m )
[in]batchCount[int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ hipblaszsymmbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszsymmbatched::hipblaszsymmbatched_ ( 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)  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  batchCount 
)

◆ hipblaszsymmbatched_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszsymmbatched::hipblaszsymmbatched_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,
integer(c_int)  batchCount 
)

◆ hipblaszsymmbatched_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszsymmbatched::hipblaszsymmbatched_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,
integer(c_int)  batchCount 
)

◆ hipblaszsymmbatched_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszsymmbatched::hipblaszsymmbatched_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,
integer(c_int)  batchCount 
)

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