LabVIEW Multicore Analysis and Sparse Matrix Toolkit API Reference

Content Type
Programming Language
Current manual

symm - Symmetric Matrix-Matrix Product VI

symm - Symmetric Matrix-Matrix Product VI

Owning Palette: Basic Linear Algebra Subroutines VIs

Requires: Multicore Analysis and Sparse Matrix Toolkit

Calculates the product of a symmetric matrix and another matrix.

Wire data to the A, B, and C inputs to determine the polymorphic instance to use or manually select the instance.

Details  

dsymm - Symmetric Matrix-Matrix Product (DBL)

side A specifies the position of A in the calculation.

0Right—Specifies that this VI calculates the result of alpha*B*A + beta*C.
1Left (default)—Specifies that this VI calculates the result of alpha*A*B+beta*C.
A specifies a symmetric matrix. This VI multiplies the first K rows and K columns of the triangular component of A that you select for matrix A type by B. If you set side A to Left, K equals the number of rows in B. If you set side A to Right, K equals the number of columns in B. A must have at least K rows and K columns.
B specifies a matrix.
C specifies a matrix of dimensions greater than or equal to the dimensions of B. The default is a matrix of the same size as B with all elements equal to 0.
matrix A type specifies whether this VI uses the upper or lower triangular matrix component of A to calculate the product.

2Lower Triangular—Specifies that this VI uses the lower triangular matrix component of A.
3Upper Triangular (default)—Specifies that this VI uses the upper triangular matrix component of A.
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*A or A*B. The default is 1.
beta specifies a scalar that scales C. The default is 1.
dsymm returns a matrix of the same size as C. For elements of the first K rows and K columns, this VI returns the result of alpha*B*A + beta*C or alpha*A*B + beta*C. For any remaining elements, this VI returns the value of the element in C with the same index.
error out contains error information. This output provides standard error out functionality.

ssymm - Symmetric Matrix-Matrix Product (SGL)

side A specifies the position of A in the calculation.

0Right—Specifies that this VI calculates the result of alpha*B*A + beta*C.
1Left (default)—Specifies that this VI calculates the result of alpha*A*B+beta*C.
A specifies a symmetric matrix. This VI multiplies the first K rows and K columns of the triangular component of A that you select for matrix A type by b. If you set side A to Left, K equals the number of rows in B. If you set side A to Right, K equals the number of columns in B. A must have at least K rows and K columns.
B specifies a matrix.
C specifies a matrix of dimensions greater than or equal to the dimensions of B. The default is a matrix of the same size as B with all elements equal to zero.
matrix A type specifies whether this VI uses the upper or lower triangular matrix component of A to calculate the product.

2Lower Triangular—Specifies that this VI uses the lower triangular matrix component of A.
3Upper Triangular (default)—Specifies that this VI uses the upper triangular matrix component of A.
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*A or A*B. The default is 1.
beta specifies a scalar that scales C. The default is 1.
ssymm returns a matrix of the same size as C. For elements of the first K rows and K columns, this VI returns the result of alpha*B*A + beta*C or alpha*A*B + beta*C. For any remaining elements, this VI returns the value of the element in C with the same index.
error out contains error information. This output provides standard error out functionality.

zsymm - Symmetric Matrix-Matrix Product (CDB)

side A specifies the position of A in the calculation.

0Right—Specifies that this VI calculates the result of alpha*B*A + beta*C.
1Left (default)—Specifies that this VI calculates the result of alpha*A*B+beta*C.
A specifies a symmetric matrix. This VI multiplies the first K rows and K columns of the triangular component of A that you select for matrix A type by b. If you set side A to Left, K equals the number of rows in B. If you set side A to Right, K equals the number of columns in B. A must have at least K rows and K columns.
B specifies a matrix.
C specifies a matrix of dimensions greater than or equal to the dimensions of B. The default is a matrix of the same size as B with all elements equal to 0.
matrix A type specifies whether this VI uses the upper or lower triangular matrix component of A to calculate the product.

2Lower Triangular—Specifies that this VI uses the lower triangular matrix component of A.
3Upper Triangular (default)—Specifies that this VI uses the upper triangular matrix component of A.
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*A or A*B. The default is 1.
beta specifies a scalar that scales C. The default is 1.
zsymm returns a matrix of the same size as C. For elements of the first K rows and K columns, this VI returns the result of alpha*B*A + beta*C or alpha*A*B + beta*C. For any remaining elements, this VI returns the value of the element in C with the same index.
error out contains error information. This output provides standard error out functionality.

csymm - Symmetric Matrix-Matrix Product (CSG)

side A specifies the position of A in the calculation.

0Right—Specifies that this VI calculates the result of alpha*B*A + beta*C.
1Left (default)—Specifies that this VI calculates the result of alpha*A*B+beta*C.
A specifies a symmetric matrix. This VI multiplies the first K rows and K columns of the triangular component of A that you select for matrix A type by b. If you set side A to Left, K equals the number of rows in B. If you set side A to Right, K equals the number of columns in B. A must have at least K rows and K columns.
B specifies a matrix.
C specifies a matrix of dimensions greater than or equal to the dimensions of B. The default is a matrix of the same size as B with all elements equal to zero.
matrix A type specifies whether this VI uses the upper or lower triangular matrix component of A to calculate the product.

2Lower Triangular—Specifies that this VI uses the lower triangular matrix component of A.
3Upper Triangular (default)—Specifies that this VI uses the upper triangular matrix component of A.
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*A or A*B. The default is 1.
beta specifies a scalar that scales C. The default is 1.
csymm returns a matrix of the same size as C. For elements of the first K rows and K columns, this VI returns the result of alpha*B*A + beta*C or alpha*A*B + beta*C. For any remaining elements, this VI returns the value of the element in C with the same index.
error out contains error information. This output provides standard error out functionality.

symm - Symmetric 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
Was this information helpful?