hipblasstrmmbatched Interface Reference

hipblasstrmmbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasstrmmbatched Interface Reference
Public Member Functions | List of all members
hipfort_hipblas::hipblasstrmmbatched Interface Reference

BLAS Level 3 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblasstrmmbatched_ (handle, side, uplo, transa, diag, m, n, alpha, a, lda, b, ldb, c, ldc, batchcount)
 

Detailed Description

BLAS Level 3 API.

The trmmBatched functions perform one of the batched matrix-matrix operations: 

C_i := alpha*op( A_i )*B_i, or C_i := alpha*B_i*op( A_i ) for i = 0, 1, ... batchCount
-1

where alpha is a scalar, B_i and C_i are m by n matrices, A_i is a unit, non-unit, upper, or lower triangular matrix, and op( A_i ) is one of: 

op( A_i ) = A_i   or   op( A_i ) = A_i^T   or   op( A_i ) = A_i^H.

Note that trmmBatched can provide in-place functionality by passing in the same address for both matrices B and C and by setting ldb equal to ldc.

  • Supported precisions in rocBLAS : s, d, c, and z.
  • Supported precisions in cuBLAS : No support.
Parameters
[in]handle- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in]side- [hipblasSideMode_t] Specifies whether op(A_i) multiplies B_i from the left or right as follows:
  • HIPBLAS_SIDE_LEFT: B_i := alpha*op( A_i )*B_i.
  • HIPBLAS_SIDE_RIGHT: B_i := alpha*B_i*op( A_i ).
[in]uplo- [hipblasFillMode_t] Specifies whether the matrix A is an upper or lower triangular matrix as follows:
  • HIPBLAS_FILL_MODE_UPPER: A is an upper triangular matrix.
  • HIPBLAS_FILL_MODE_LOWER: A is a lower triangular matrix.
[in]transA- [hipblasOperation_t] Specifies the form of op(A_i) to be used in the matrix multiplication as follows:
  • HIPBLAS_OP_N: op(A_i) = A_i.
  • HIPBLAS_OP_T: op(A_i) = A_i^T.
  • HIPBLAS_OP_C: op(A_i) = A_i^H.
[in]diag- [hipblasDiagType_t] Specifies whether or not A_i is unit triangular as follows:
  • HIPBLAS_DIAG_UNIT: A_i is assumed to be unit triangular.
  • HIPBLAS_DIAG_NON_UNIT: A_i is not assumed to be unit triangular.
[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 is not referenced and B_i does not need to be set before entry.
[in]A- Device 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 side == HIPBLAS_SIDE_LEFT and is n when side == HIPBLAS_SIDE_RIGHT.
  • When uplo == HIPBLAS_FILL_MODE_UPPER, the leading k by k upper triangular part of the array A must contain the upper triangular matrix and the strictly lower triangular part of A is not referenced.
  • When uplo == HIPBLAS_FILL_MODE_LOWER, the leading k by k lower triangular part of the array A must contain the lower triangular matrix and the strictly upper triangular part of A is not referenced.
  • Note that when diag == HIPBLAS_DIAG_UNIT, the diagonal elements of A_i are not referenced either, but are assumed to be unity.
[in]lda- [int] lda specifies the first dimension of A.
  • If side == HIPBLAS_SIDE_LEFT, lda >= max( 1, m ).
  • If side == HIPBLAS_SIDE_RIGHT, lda >= max( 1, n ).
[in,out]B- device array of device pointers storing each matrix B_i of dimension (ldb, n) on the GPU.
[in]ldb- [int] ldb specifies the first dimension of B_i. ldb >= max( 1, m ).
[in]C- device array of device pointers storing each matrix C_i of dimension (ldc, n) on the GPU. Users can pass in the same matrices B to parameter C to achieve in-place functionality of trmmBatched.
[in]ldc- ldc specifies the first dimension of C_i. ldc >= max( 1, m ).
[in]batchCount- [int] number of instances i in the batch.

Member Function/Subroutine Documentation

◆ hipblasstrmmbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstrmmbatched::hipblasstrmmbatched_ ( type(c_ptr), value  handle,
integer(kind(hipblas_side_left)), value  side,
integer(kind(hipblas_fill_mode_upper)), value  uplo,
integer(kind(hipblas_op_n)), value  transa,
integer(kind(hipblas_diag_non_unit)), value  diag,
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,
type(c_ptr), value  c,
integer(c_int), value  ldc,
integer(c_int), value  batchcount 
)
The documentation for this interface was generated from the following file: