rocblas_strmm Interface Reference#
hipfort_rocblas::rocblas_strmm Interface Reference
BLAS Level 3 API. More...
Public Member Functions | |
| integer(kind(rocblas_status_success)) function | rocblas_strmm_ (handle, side, uplo, transa, diag, m, n, alpha, a, lda, b, ldb, c, ldc) |
| integer(kind(rocblas_status_success)) function | rocblas_strmm_rank_0 (handle, side, uplo, transa, diag, m, n, alpha, a, lda, b, ldb, c, ldc) |
| integer(kind(rocblas_status_success)) function | rocblas_strmm_rank_1 (handle, side, uplo, transa, diag, m, n, alpha, a, lda, b, ldb, c, ldc) |
| integer(kind(rocblas_status_success)) function | rocblas_strmm_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 ),
The Legacy BLAS in-place trmm functionality:
B := alpha*op( A )*B, or B := alpha*B*op( A ),
is available by setting pointer C equal to pointer B, and ldc equal to ldb.
alpha is a scalar, B is an m by n matrix, C 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.
When uplo == rocblas_fill_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. Here, k is m when side == rocblas_side_left and is n when side == rocblas_side_right.
When uplo == rocblas_fill_lower, the leading k by k lower triangular part of the array Amust contain the lower triangular matrix and the strictly upper triangular part of A is not referenced. Here, k is m when side == rocblas_side_left and is n when side == rocblas_side_right.
Note that when diag == rocblas_diagonal_unit, the diagonal elements of A are not referenced either but are assumed to be unity.
- Parameters
-
[in] handle - [rocblas_handle] handle to the rocBLAS library context queue. [in] side - [rocblas_side] Specifies whether op(A) multiplies B from the left or right as follows: - rocblas_side_left: C := alpha*op( A )*B
- rocblas_side_right: C := alpha*B*op( A )
[in] uplo - [rocblas_fill] Specifies whether the matrix A is an upper or lower triangular matrix as follows: - rocblas_fill_upper: A is an upper triangular matrix.
- rocblas_fill_lower: A is a lower triangular matrix.
[in] transA - [rocblas_operation] Specifies the form of op(A) to be used in the matrix multiplication as follows: - rocblas_operation_none: op(A) = A
- rocblas_operation_transpose: op(A) = A^T
- rocblas_operation_conjugate_transpose: op(A) = A^H
[in] diag - [rocblas_diagonal] Specifies whether or not A is unit triangular as follows: - rocblas_diagonal_unit: A is assumed to be unit triangular.
- rocblas_diagonal_non_unit: A is not assumed to be unit triangular.
[in] m - [rocblas_int] m specifies the number of rows of B. m >= 0. [in] n - [rocblas_int] n specifies the number of columns of B. n >= 0. [in] alpha alpha specifies the scalar alpha. When alpha is zero, 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 == rocblas_side_left and is n when side == rocblas_side_right. - When uplo == rocblas_fill_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 == rocblas_fill_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 == rocblas_diagonal_unit the diagonal elements of A are not referenced either but are assumed to be unity.
[in] lda - [rocblas_int] lda specifies the first dimension of A. - If side == rocblas_side_left, lda >= max( 1, m ).
- If side == rocblas_side_right, lda >= max( 1, n ).
[in] B - Device pointer to the matrix B on the GPU. [in] ldb - [rocblas_int] ldb specifies the first dimension of B. ldb >= max( 1, m ). [out] C - Device pointer to the matrix C on the GPU. [in] ldc - [rocblas_int] ldc specifies the first dimension of C. ldc >= max( 1, m). If B and C are pointers to the same matrix, ldc must equal ldb or rocblas_status_invalid_value will be returned.
Member Function/Subroutine Documentation
◆ rocblas_strmm_()
| integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_strmm::rocblas_strmm_ | ( | type(c_ptr), value | handle, |
| integer(kind(rocblas_side_left)), value | side, | ||
| integer(kind(rocblas_fill_upper)), value | uplo, | ||
| integer(kind(rocblas_operation_none)), value | transa, | ||
| integer(kind(rocblas_diagonal_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 | ||
| ) |
◆ rocblas_strmm_full_rank()
| integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_strmm::rocblas_strmm_full_rank | ( | type(c_ptr) | handle, |
| integer(kind(rocblas_side_left)) | side, | ||
| integer(kind(rocblas_fill_upper)) | uplo, | ||
| integer(kind(rocblas_operation_none)) | transa, | ||
| integer(kind(rocblas_diagonal_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 | ||
| ) |
◆ rocblas_strmm_rank_0()
| integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_strmm::rocblas_strmm_rank_0 | ( | type(c_ptr) | handle, |
| integer(kind(rocblas_side_left)) | side, | ||
| integer(kind(rocblas_fill_upper)) | uplo, | ||
| integer(kind(rocblas_operation_none)) | transa, | ||
| integer(kind(rocblas_diagonal_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 | ||
| ) |
◆ rocblas_strmm_rank_1()
| integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_strmm::rocblas_strmm_rank_1 | ( | type(c_ptr) | handle, |
| integer(kind(rocblas_side_left)) | side, | ||
| integer(kind(rocblas_fill_upper)) | uplo, | ||
| integer(kind(rocblas_operation_none)) | transa, | ||
| integer(kind(rocblas_diagonal_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: