hipblasstrmm Interface Reference

hipblasstrmm Interface Reference#

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

BLAS Level 3 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblasstrmm_ (handle, side, uplo, transa, diag, m, n, alpha, a, lda, b, ldb, c, ldc)
 
integer(kind(hipblas_status_success)) function hipblasstrmm_rank_0 (handle, side, uplo, transa, diag, m, n, alpha, a, lda, b, ldb, c, ldc)
 
integer(kind(hipblas_status_success)) function hipblasstrmm_rank_1 (handle, side, uplo, transa, diag, m, n, alpha, a, lda, b, ldb, c, ldc)
 
integer(kind(hipblas_status_success)) function hipblasstrmm_full_rank (handle, side, uplo, transa, diag, m, n, alpha, a, lda, b, ldb, c, ldc)
 

Detailed Description

BLAS Level 3 API.

The trmm functions perform one of the matrix-matrix operations: 

C := alpha*op( A )*B,   or   C := alpha*B*op( A )

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

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

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

  • Supported precisions in rocBLAS : s, d, c, and z.
  • Supported precisions in cuBLAS : s, d, c, and z.
Parameters
[in]handle- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in]side- [hipblasSideMode_t] Specifies whether op(A) multiplies B from the left or right as follows:
  • HIPBLAS_SIDE_LEFT: C := alpha*op( A )*B.
  • HIPBLAS_SIDE_RIGHT: C := alpha*B*op( A ).
[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) to be used in the matrix multiplication as follows:
  • HIPBLAS_OP_N: op(A) = A.
  • HIPBLAS_OP_T: op(A) = A^T.
  • HIPBLAS_OP_C: op(A) = A^H.
[in]diag- [hipblasDiagType_t] Specifies whether or not A is unit triangular as follows:
  • HIPBLAS_DIAG_UNIT: A is assumed to be unit triangular.
  • HIPBLAS_DIAG_NON_UNIT: A is not assumed to be unit triangular.
[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 is not referenced and B does not need to be set before entry.
[in]A- Device pointer to matrix A on the GPU. A has 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 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 pointer to the matrix B of dimension (ldb, n) on the GPU.
[in]ldb- [int] ldb specifies the first dimension of B. ldb >= max( 1, m ).
[in]C- Device pointer to the matrix C of dimension (ldc, n) on the GPU. Users can pass in the same matrix B to parameter C to achieve in-place functionality for trmm.
[in]ldc- [int] ldc specifies the first dimension of C. ldc >= max( 1, m ).

Member Function/Subroutine Documentation

◆ hipblasstrmm_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstrmm::hipblasstrmm_ ( 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 
)

◆ hipblasstrmm_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstrmm::hipblasstrmm_full_rank ( type(c_ptr)  handle,
integer(kind(hipblas_side_left))  side,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(kind(hipblas_op_n))  transa,
integer(kind(hipblas_diag_non_unit))  diag,
integer(c_int)  m,
integer(c_int)  n,
real(c_float)  alpha,
real(c_float), dimension(:,:), target  a,
integer(c_int)  lda,
real(c_float), dimension(:,:), target  b,
integer(c_int)  ldb,
real(c_float), dimension(:,:), target  c,
integer(c_int)  ldc 
)

◆ hipblasstrmm_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstrmm::hipblasstrmm_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_side_left))  side,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(kind(hipblas_op_n))  transa,
integer(kind(hipblas_diag_non_unit))  diag,
integer(c_int)  m,
integer(c_int)  n,
real(c_float)  alpha,
real(c_float), target  a,
integer(c_int)  lda,
real(c_float), target  b,
integer(c_int)  ldb,
real(c_float), target  c,
integer(c_int)  ldc 
)

◆ hipblasstrmm_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstrmm::hipblasstrmm_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_side_left))  side,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(kind(hipblas_op_n))  transa,
integer(kind(hipblas_diag_non_unit))  diag,
integer(c_int)  m,
integer(c_int)  n,
real(c_float)  alpha,
real(c_float), dimension(:), target  a,
integer(c_int)  lda,
real(c_float), dimension(:), target  b,
integer(c_int)  ldb,
real(c_float), dimension(:), target  c,
integer(c_int)  ldc 
)
The documentation for this interface was generated from the following file: