rocblas_ztrmm_outofplace_batched Interface Reference

rocblas_ztrmm_outofplace_batched Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_ztrmm_outofplace_batched Interface Reference

BLAS Level 3 API. More...

Public Member Functions
integer(kind(rocblas_status_success)) function	rocblas_ztrmm_outofplace_batched_ (handle, side, uplo, transa, diag, m, n, alpha, A, lda, B, ldb, C, ldc, batch_count)

integer(kind(rocblas_status_success)) function	rocblas_ztrmm_outofplace_batched_full_rank (handle, side, uplo, transa, diag, m, n, alpha, A, lda, B, ldb, C, ldc, batch_count)

integer(kind(rocblas_status_success)) function	rocblas_ztrmm_outofplace_batched_rank_0 (handle, side, uplo, transa, diag, m, n, alpha, A, lda, B, ldb, C, ldc, batch_count)

integer(kind(rocblas_status_success)) function	rocblas_ztrmm_outofplace_batched_rank_1 (handle, side, uplo, transa, diag, m, n, alpha, A, lda, B, ldb, C, ldc, batch_count)

Detailed Description

BLAS Level 3 API.

trmm_outofplace_batched performs 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, ... batch_count -1

where alpha is a scalar, B_i is an m by n matrix, A_i is a unit, or 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 trmm_outofplace_batched can provide in-place functionality in the same way as trmm_batched by passing in the same address for both matrices B and C.

Parameters

[in]	handle	[rocblas_handle] handle to the rocblas library context queue.
[in]	side	[rocblas_side] Specifies whether op(A_i) multiplies B_i from the left or right as follows: rocblas_side_left: C_i := alphaop( A_i )B_i. rocblas_side_right: C_i := alphaB_iop( A_i ).
[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_i) to be used in the matrix multiplication as follows: rocblas_operation_none: op(A_i) = A_i. rocblas_operation_transpose: op(A_i) = A_i^T. rocblas_operation_conjugate_transpose: op(A_i) = A_i^H.
[in]	diag	[rocblas_diagonal] Specifies whether or not A_i is unit triangular as follows: rocblas_diagonal_unit: A_i is assumed to be unit triangular. rocblas_diagonal_non_unit: A_i is not assumed to be unit triangular.
[in]	m	[rocblas_int] m specifies the number of rows of B_i. m >= 0.
[in]	n	[rocblas_int] n specifies the number of columns of B_i. n >= 0.
[in]	alpha	alpha specifies the scalar alpha. When alpha is zero then A_i is not referenced and B_i need not 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 == 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_i are not referenced either, but are assumed to be unity.

Parameters

[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 array of device pointers storing each matrix B_i on the GPU.
[in]	ldb	[rocblas_int] ldb specifies the first dimension of B_i. ldb >= max( 1, m ).
[out]	C	device array of device pointers storing each matrix C_i on the GPU.
[in]	ldc	[rocblas_int] ldc specifies the first dimension of C. ldc >= max( 1, m).
[in]	batch_count	[rocblas_int] number of instances i in the batch.

Member Function/Subroutine Documentation