hipblasztrmm Interface Reference#
hipfort_hipblas::hipblasztrmm Interface Reference
BLAS Level 3 API. More...
Public Member Functions | |
| integer(kind(hipblas_status_success)) function | hipblasztrmm_ (handle, side, uplo, transA, diag, m, n, alpha, A, lda, B, ldb) |
| integer(kind(hipblas_status_success)) function | hipblasztrmm_full_rank (handle, side, uplo, transA, diag, m, n, alpha, A, lda, B, ldb) |
| integer(kind(hipblas_status_success)) function | hipblasztrmm_rank_0 (handle, side, uplo, transA, diag, m, n, alpha, A, lda, B, ldb) |
| integer(kind(hipblas_status_success)) function | hipblasztrmm_rank_1 (handle, side, uplo, transA, diag, m, n, alpha, A, lda, B, ldb) |
Detailed Description
BLAS Level 3 API.
trmm performs one of the matrix-matrix operations
B := alpha*op( A )*B, or B := alpha*B*op( A )
where alpha is a scalar, B is an m by n matrix, A is a unit, or 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.
- 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: B := alpha*op( A )*B. HIPBLAS_SIDE_RIGHT: B := 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. m >= 0. [in] n [int] n specifies the number of columns of B. n >= 0. [in] alpha alpha specifies the scalar alpha. When alpha is zero then A is not referenced and B need not 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.
- Parameters
-
[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 first matrix B_0 on the GPU. On entry, the leading m by n part of the array B must contain the matrix B, and on exit is overwritten by the transformed matrix. [in] ldb [int] ldb specifies the first dimension of B. ldb >= max( 1, m ).
Member Function/Subroutine Documentation
◆ hipblasztrmm_()
| integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasztrmm::hipblasztrmm_ | ( | 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, | ||
| complex(c_double_complex) | alpha, | ||
| type(c_ptr), value | A, | ||
| integer(c_int), value | lda, | ||
| type(c_ptr), value | B, | ||
| integer(c_int), value | ldb | ||
| ) |
◆ hipblasztrmm_full_rank()
| integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasztrmm::hipblasztrmm_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, | ||
| 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 | ||
| ) |
◆ hipblasztrmm_rank_0()
| integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasztrmm::hipblasztrmm_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, | ||
| 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 | ||
| ) |
◆ hipblasztrmm_rank_1()
| integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasztrmm::hipblasztrmm_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, | ||
| 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 | ||
| ) |
The documentation for this interface was generated from the following file: