Table Of Contents

Matrix Update (Symmetric » Rank-k) (G Dataflow)

Last Modified: January 12, 2018

Calculates the rank-k update of the upper or lower triangular component of a symmetric matrix.

connector_pane_image
datatype_icon

operation A

Operation this node performs on A.

Name Value Description
Direct 0 op(A) = A
Conjugated and Transposed 1 op(A) = conjugate transpose of A
Transposed 2 op(A) = transpose of A

Default: Direct

datatype_icon

A

Matrix such that op(A) has dimensions N × K.

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

Symmetric matrix.

C must have dimensions greater than or equal to N × N, where N is the number of rows in op(A). If C is an empty matrix, this node initializes C to be an N × N matrix 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 C type

Triangular component of C this node uses for the calculation.

Name Value Description
Lower Triangular 2 This node uses the lower triangular component of C for the calculation.
Upper Triangular 3 This node uses the upper triangular component of C 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 op(A) * op(A) T , where op(A)T represents op(A) transposed.

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 double-precision, floating-point numbers. The default value is 1+0i if alpha is complex double-precision, floating-point numbers.

datatype_icon

beta

Scalar that scales C.

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 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

dsyrk

Matrix of the same dimensions as C.

For elements in the first N rows and N columns of the triangular component you select in matrix C type, dsyrk returns the results of alpha * op(A) * op(A)T + beta * C. For any other elements, dsyrk 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 or C.

datatype_icon

zsyrk

Matrix of the same dimensions as C.

For elements in the first N rows and N columns of the triangular component you select in matrix C type, zsyrk returns the results of alpha * op(A) * op(A)T + beta * C. For any other elements, zsyrk 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 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: Not supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics