Table Of Contents

Matrix Norm (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Computes the norm of a matrix.

    connector_pane_image
    datatype_icon

    matrix

    A square or rectangular matrix.

    This input accepts a 2D array of double-precision, floating point numbers or 2D array of complex double-precision, floating point numbers.

    datatype_icon

    norm type

    Type of norm that this node uses for the computation.

    Name Value Description
    2-norm 0 A 2 is the largest singular value of the input matrix.
    1-norm 1 A 1 is the largest absolute column sum of the input matrix.
    F-norm 2 A f is equal to Σ diag ( A T A ) where diag ( A T A ) means the diagonal elements of matrix ( A T A ) and A T is the transpose of A .
    Inf-norm 3 A is the largest absolute row sum of the input matrix.

    Default: 2-norm

    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

    norm

    The norm of the input matrix.

    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