LabVIEW Multicore Analysis and Sparse Matrix Toolkit API Reference

trmm - Triangular Matrix-Matrix Product VI

  • Updated2023-02-21
  • 8 minute(s) read

trmm - Triangular Matrix-Matrix Product VI

Owning Palette: Basic Linear Algebra Subroutines VIs

Requires: Multicore Analysis and Sparse Matrix Toolkit

Calculates the product of a triangular matrix and another matrix.

Wire data to the A and B inputs to determine the polymorphic instance to use.

Details  

dtrmm - Triangular Matrix-Matrix Product (DBL)

side A specifies the position of op(A) in the calculation.

0Right—Specifies that this VI calculates the result of alpha*B*op(A).
1Left (default)—Specifies that this VI calculates the result of alpha*op(A)*B.
operation A specifies the operation to perform on matrix A that results in matrix op(A).

0Direct (default)
1Conjugated & Transposed
2Transposed
A specifies a triangular matrix. This VI multiplies the first K rows and K columns of op(A) by B. If you set side A to Left, K equals the number of row in B. If you set side A to Right, K equals the number of columns in B. A must have at least K row and K columns.
B specifies a matrix.
matrix A type specifies whether A is an upper or lower triangular matrix.

2Lower Triangular—Specifies that A is a lower triangular matrix.
3Upper Triangular (default)—Specifies that A is an upper triangular matrix.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
alpha specifies a scalar that scales B*op(A) or op(A)*B. The default is 1.
diagonal A specifies the value of the diagonal elements of A.

0Non-unit (default)—Specifies that this VI uses the original diagonal elements of A
1Unit—Specifies that this VI uses the value of 1 for all diagonal elements of A.
dtrmm is a matrix of the same size as B that returns the result of alpha*op(A)*B or alpha*B*op(A).
error out contains error information. This output provides standard error out functionality.

strmm - Triangular Matrix-Matrix Product (SGL)

side A specifies the position of op(A) in the calculation.

0Right—Specifies that this VI calculates the result of alpha*B*op(A).
1Left (default)—Specifies that this VI calculates the result of alpha*op(A)*B.
operation A specifies the operation to perform on matrix A that results in matrix op(A).

0Direct (default)
1Conjugated & Transposed
2Transposed
A specifies a triangular matrix. This VI multiplies the first K rows and K columns of op(A) by B. If you set side A to Left, K equals the number of row in B. If you set side A to Right, K equals the number of columns in B. A must have at least K row and K columns.
B specifies a matrix.
matrix A type specifies whether A is an upper or lower triangular matrix.

2Lower Triangular—Specifies that A is a lower triangular matrix.
3Upper Triangular (default)—Specifies that A is an upper triangular matrix.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
alpha specifies a scalar that scales B*op(A) or op(A)*B. The default is 1.
diagonal A specifies the value of the diagonal elements of A.

0Non-unit (default)—Specifies that this VI uses the original diagonal elements of A
1Unit—Specifies that this VI uses the value of 1 for all diagonal elements of A.
strmm is a matrix of the same size as B that returns the result of alpha*op(A)*B or alpha*B*op(A).
error out contains error information. This output provides standard error out functionality.

ztrmm - Triangular Matrix-Matrix Product (CDB)

side A specifies the position of op(A) in the calculation.

0Right—Specifies that this VI calculates the result of alpha*B*op(A).
1Left (default)—Specifies that this VI calculates the result of alpha*op(A)*B.
operation A specifies the operation to perform on matrix A that results in matrix op(A).

0Direct (default)
1Conjugated & Transposed
2Transposed
A specifies a triangular matrix. This VI multiplies the first K rows and K columns of op(A) by B. If you set side A to Left, K equals the number of row in B. If you set side A to Right, K equals the number of columns in B. A must have at least K row and K columns.
B specifies a matrix.
matrix A type specifies whether A is an upper or lower triangular matrix.

2Lower Triangular—Specifies that A is a lower triangular matrix.
3Upper Triangular (default)—Specifies that A is an upper triangular matrix.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
alpha specifies a scalar that scales B*op(A) or op(A)*B. The default is 1.
diagonal A specifies the value of the diagonal elements of A.

0Non-unit (default)—Specifies that this VI uses the original diagonal elements of A
1Unit—Specifies that this VI uses the value of 1 for all diagonal elements of A.
ztrmm is a matrix of the same size as B that returns the result of alpha*op(A)*B or alpha*B*op(A).
error out contains error information. This output provides standard error out functionality.

ctrmm - Triangular Matrix-Matrix Product (CSG)

side A specifies the position of op(A) in the calculation.

0Right—Specifies that this VI calculates the result of alpha*B*op(A).
1Left (default)—Specifies that this VI calculates the result of alpha*op(A)*B.
operation A specifies the operation to perform on matrix A that results in matrix op(A).

0Direct (default)
1Conjugated & Transposed
2Transposed
A specifies a triangular matrix. This VI multiplies the first K rows and K columns of op(A) by B. If you set side A to Left, K equals the number of row in B. If you set side A to Right, K equals the number of columns in B. A must have at least K row and K columns.
B specifies a matrix.
matrix A type specifies whether A is an upper or lower triangular matrix.

2Lower Triangular—Specifies that A is a lower triangular matrix.
3Upper Triangular (default)—Specifies that A is an upper triangular matrix.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
alpha specifies a scalar that scales B*op(A) or op(A)*B. The default is 1.
diagonal A specifies the value of the diagonal elements of A.

0Non-unit (default)—Specifies that this VI uses the original diagonal elements of A
1Unit—Specifies that this VI uses the value of 1 for all diagonal elements of A.
ctrmm is a matrix of the same size as B that returns the result of alpha*op(A)*B or alpha*B*op(A).
error out contains error information. This output provides standard error out functionality.

trmm - Triangular Matrix-Matrix Product Details

The following table lists the support characteristics of this VI.

Supported on RT targets Yes
Suitable for bounded execution times on RT No

Log in to get a better experience