Table Of Contents

Matrix Update (General » Rank-1) (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Calculates the rank-1 update of a general matrix.

    connector_pane_image
    datatype_icon

    x

    M-element vector.

    This input accepts the following data types:

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

    y

    N-element vector.

    This input accepts the following data types:

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

    A

    General matrix.

    A must have dimensions greater than or equal to M × N. If A is an empty matrix, this node initializes A to be an M x 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

    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 x * y T, where yT represents y 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 a double-precision, floating-point number. The default value is 1+0i if alpha is a complex double-precision, floating-point number.

    datatype_icon

    dger

    Matrix of the same dimensions as A.

    For elements in the first M rows and N columns, dger returns the results of alpha * x * yT + A, where yT represents y transposed. For any remaining elements, dger returns the value of the element in A with the same index.

    This output is available when you wire a 1D array of double-precision, floating-point numbers to x or y, or a 2D array of double-precision, floating-point numbers to A.

    datatype_icon

    zgeru

    Matrix of the same dimensions as A.

    For elements in the first M rows and N columns, zgeru returns the results of alpha * x * yT + A, where yT represents y transposed. For any remaining elements, zgeru returns the value of the element in A with the same index.

    This output is available when you wire a 1D array of complex double-precision, floating-point numbers to x or y, or a 2D array of complex double-precision, floating-point numbers to A.

    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