Table Of Contents

Matrix Rank (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Computes the rank of a matrix.

    connector_pane_image
    datatype_icon

    matrix

    A 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

    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

    tolerance

    A level such that the number of singular values greater than this level is the rank of the input matrix.

    If this input is negative, this node uses the following equation to determine the actual tolerance:

    tolerance = max( m , n ) * A * ε

    where

    • A represents the input matrix
    • m represents the number of rows in A
    • n represents the number of columns in A
    • A is the 2-norm of A
    • ε is the smallest floating point number that can be represented by type double

    Default: -1

    datatype_icon

    rank

    Number of singular values in the input matrix that are larger than the tolerance. This output is the maximum number of independent rows or columns in 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