Computes a matrix-matrix product where one input matrix is triangular and one input matrix is general.
event trmm(queue &exec_queue, uplo upper_lower, transpose transa, diag unit_diag, std::int64_t m, std::int64_t n, T alpha, const T* a, std::int64_t lda, T* b, std::int64_t ldb, const vector_class<event> &dependencies = {});
trmm supports the following precisions and devices:
T | Devices Supported |
---|---|
float | Host, CPU, and GPU |
double | Host, CPU, and GPU |
std::complex<float> | Host, CPU, and GPU |
std::complex<double> | Host, CPU, and GPU |
The trmm routines compute a scalar-matrix-matrix product where one of the matrices in the multiplication is triangular. The argument left_right determines if the triangular matrix, A, is on the left of the multiplication (left_right = side::left) or on the right (left_right = side::right). Depending on left_right. The operation is defined as
B <- alpha*op(A)*B
or
B <- alpha*B*op(A)
where:
op(A) is one of op(A) = A, or op(A) = AT, or op(A) = AH,
alpha is a scalar,
A is a triangular matrix, and B is a general matrix.
Here B is m x n and A is either m x m or n x n, depending on left_right.
The queue where the routine should be executed.
Specifies whether A is on the left side of the multiplication (side::left) or on the right side (side::right). See Data Types for more details.
Specifies whether the matrix A is upper or lower triangular. See Data Types for more details.
Specifies op(A), the transposition operation applied to A. See Data Types for more details.
Specifies whether A is assumed to be unit triangular (all diagonal elements are 1). See Data Types for more details.
Specifies the number of rows of B. The value of m must be at least zero.
Specifies the number of columns of B. The value of n must be at least zero.
Scaling factor for the matrix-matrix product.
Pointer to input matrix A. Must have size at least lda*m if left_right = side::left, or lda*n if left_right = side::right. See Matrix and Vector Storage for more details.
Leading dimension of A. Must be at least m if left_right = side::left, and at least n if left_right = side::right. Must be positive.
Pointer to input/output matrix B. It must have size at least ldb*n if column major layout is used to store matrices or at least ldb*m if row major layout is used to store matrices. See Matrix and Vector Storage for more details.
Leading dimension of B. It must be positive and at least m if column major layout is used to store matrices or at least n if column major layout is used to store matrices.
List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.
Pointer to the output matrix, overwritten by alpha*op(A)*B or alpha*B*op(A).
If alpha = 0, matrix B is set to zero, and A and B do not need to be initialized at entry.
Output event to wait on to ensure computation is complete.