Table Of Contents

Matrix-Matrix Product (Symmetric) (G Dataflow)

Last Modified: March 15, 2017

Calculates the product of a symmetric matrix and another matrix.

connector_pane_image
datatype_icon

side

Position of A in the product calculation.

Name Value Description
Left 1 Calculates the result of alpha * A * B + beta * C.
Right 0 Calculates the result of alpha * B * A + beta * C.

Default: Left

datatype_icon

A

Symmetric matrix whose dimensions are greater than or equal to K × K.

This node multiplies the first K rows and K columns of the upper or lower triangular component of A by B, depending on the value of matrix A type.

This input accepts the following data types:

  • 2D array of double-precision, floating-point numbers
  • 2D array of complex double-precision, floating-point numbers
datatype_icon

B

K × N matrix, if you set side to Left, or N × K matrix, if you set side to Right.

This input accepts the following data types:

  • 2D array of double-precision, floating-point numbers
  • 2D array of complex double-precision, floating-point numbers
datatype_icon

C

Matrix whose dimensions are greater than or equal to B. If C is an empty matrix, this node initializes C to be a matrix of the same size as B, with all elements set to 0.

This input accepts the following data types:

  • 2D array of double-precision, floating-point numbers
  • 2D array of complex double-precision, floating-point numbers
datatype_icon

matrix A type

Triangular component of A that this node uses for the calculation.

Name Value Description
Lower Triangular 2 Uses the lower triangular component of A for the calculation.
Upper Triangular 3 Uses the upper triangular component of A for the calculation.

Default: Upper Triangular

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

alpha

Scalar that scales A * B or B * A, depending on the value you wire to side.

This input accepts the following data types:

  • Double-precision, floating-point numbers
  • Complex double-precision, floating-point numbers

Default: The default value is 1 if alpha is a double-precision, floating-point number. The default value is 1+0i if alpha is a complex double-precision, floating-point number.

datatype_icon

beta

Scalar that scales C.

This input accepts the following data types:

  • Double-precision, floating-point number
  • Complex double-precision, floating-point numbers

Default: The default value is 1 if beta is a double-precision, floating-point number. The default value is 1+0i if beta is a complex double-precision, floating-point number.

datatype_icon

dsymm

Matrix of the same size as C.

When side is Left, dsymm returns the result of alpha * A * B + beta * C for elements of the first K rows and N columns. When side is Right, dsymm returns the result of alpha * B * A + beta * C for elements of the first N rows and K columns. For any remaining elements, dsymm returns the value of the element in C with the same index.

This output is available only if you wire a 2D array of double-precision, floating-point numbers to A, B, or C.

datatype_icon

zsymm

Matrix of the same size as C.

When side is Left, zsymm returns the result of alpha * A * B + beta * C for elements of the first K rows and N columns. When side is Right, zsymm returns the result of alpha * B * A + beta * C for elements of the first N rows and K columns. For any remaining elements, zsymm returns the value of the element in C with the same index.

This output is available only if you wire a 2D array of complex double-precision, floating-point numbers to A, B, or C.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Where This Node Can Run:

Desktop OS: Windows

FPGA: This product does not support FPGA devices


Recently Viewed Topics