trmm
Computes a matrix-matrix product where one input matrix is triangular
and other matrix is general.
Description
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
). The operation is defined as:If (
left_right
= side::left
),
If (
left_right
= side::right
),
where:
- op(A) is one of op(A) =A, or op(A) =AT, or op(A) =AH
- alphais a scalar
- Ais eithermxmornxntriangular matrix
- Bismxngeneral matrix
trmm
supports the following precisions:T |
---|
float |
double |
std::complex<float> |
std::complex<double> |
trmm (Buffer Version)
Syntax
namespace oneapi::mkl::blas::column_major {
void trmm(sycl::queue &queue,
oneapi::mkl::uplo upper_lower,
oneapi::mkl::transpose trans,
oneapi::mkl::diag unit_diag,
std::int64_t m,
std::int64_t n,
T alpha,
sycl::buffer<T,1> &a,
std::int64_t lda,
sycl::buffer<T,1> &b,
std::int64_t ldb)
}
namespace oneapi::mkl::blas::row_major {
void trmm(sycl::queue &queue,
oneapi::mkl::uplo upper_lower,
oneapi::mkl::transpose trans,
oneapi::mkl::diag unit_diag,
std::int64_t m,
std::int64_t n,
T alpha,
sycl::buffer<T,1> &a,
std::int64_t lda,
sycl::buffer<T,1> &b,
std::int64_t ldb)
}
Input Parameters
- queue
- The queue where the routine should be executed.
- left_right
- Specifies whether matrixAis on the left side or right side of the multiplication. See Data Types for more details.
- upper_lower
- Specifies whether matrixAis upper or lower triangular. See Data Types for more details.
- trans
- unit_diag
- Specifies whether matrixAis unit triangular or not. See Data Types for more details.
- m
- Number of rows of matrixB. Must be at least zero.
- n
- Number of columns of matrixB. Must be at least zero.
- alpha
- Scaling factor for matrix-matrix product.
- a
- Buffer holding input matrixA. Size of the buffer must be at leastlda*mifleft_right=side::leftorlda*nifleft_right=side::right. See Matrix Storage for more details.
- lda
- Leading dimension of matrixA. Must be at leastmifleft_right=side::leftor at leastnifleft_right=side::right. Must be positive.
- b
- Buffer holding input matrixB. Size of the buffer must be at leastldb*nif column major layout or at leastldb*mif row major layout is used. See Matrix Storage for more details.
- ldb
- Leading dimension of matrixB. Must be at leastmif column major layout or at leastnif row major layout is used. Must be positive.
Output Parameters
- b
- Output buffer overwritten byalpha* op(A) *Bifleft_right=side::leftoralpha*B* op(A) ifleft_right=side::right.Ifalpha= 0, matrixBis set to zero, andAandBdo not need to be initialized at entry.
trmm (USM Version)
Syntax
namespace oneapi::mkl::blas::column_major {
sycl::event trmm(sycl::queue &queue,
oneapi::mkl::uplo upper_lower,
oneapi::mkl::transpose trans,
oneapi::mkl::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 std::vector<sycl::event> &dependencies = {})
}
namespace oneapi::mkl::blas::row_major {
sycl::event trmm(sycl::queue &queue,
oneapi::mkl::uplo upper_lower,
oneapi::mkl::transpose trans,
oneapi::mkl::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 std::vector<sycl::event> &dependencies = {})
}
Input Parameters
- queue
- The queue where the routine should be executed.
- left_right
- Specifies whether matrixAis on the left side or right side of the multiplication. See Data Types for more details.
- upper_lower
- Specifies whether matrixAis upper or lower triangular. See Data Types for more details.
- trans
- unit_diag
- Specifies whether matrixAis unit triangular or not. See Data Types for more details.
- m
- Number of rows of matrixB. Must be at least zero.
- n
- Number of columns of matrixB. Must be at least zero.
- alpha
- Scaling factor for matrix-matrix product.
- a
- Pointer to input matrixA. Size of the array must be at leastlda*mifleft_right=side::leftorlda*nifleft_right=side::right. See Matrix Storage for more details.
- lda
- Leading dimension of matrixA. Must be at leastmifleft_right=side::leftor at leastnifleft_right=side::right. Must be positive.
- b
- Pointer to input matrixB. Size of the array must be at leastldb*nif column major layout or at leastldb*mif row major layout is used. See Matrix Storage for more details.
- ldb
- Leading dimension of matrixB. Must be at leastmif column major layout or at leastnif row major layout is used. Must be positive.
- dependencies
- List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.
Output Parameters
- b
- Pointer to output matrix overwritten byalpha* op(A) *Bifleft_right=side::leftoralpha*B* op(A) ifleft_right=side::right.Ifalpha= 0, matrixBis set to zero, andAandBdo not need to be initialized at entry.
Return Values
Output event to wait on to ensure computation is complete.