Table Of Contents

Matrix-Matrix Product (Triangle) (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Calculates the product of a triangular matrix and another matrix.

    connector_pane_image
    datatype_icon

    side

    Position of op(A) in the calculation.

    Name Value Description
    Left 1 Calculates the result of alpha * op(A) * B.
    Right 0 Calculates the result of alpha * B * op(A).

    Default: Left

    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

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

    This node multiplies the first K rows and the first K columns of op(A) by B.

    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

    matrix A type

    Triangular matrix type of A.

    Name Value Description
    Lower Triangular 2 A is a lower triangular matrix.
    Upper Triangular 3 A is an upper triangular matrix.

    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) * B or B * op(A), depending on the value of 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

    diagonal

    Value that determines how to use the diagonal elements of A.

    Name Value Description
    Non-unit 0 Uses the original diagonal elements of A.
    Unit 1 Uses 1 as the value for all diagonal elements of A.

    Default: Non-unit

    datatype_icon

    dtrmm

    Matrix of the same dimensions as B.

    If side is Left, this output returns the result of alpha * op(A) * B. If side is Right, this output returns the result of alpha * B * op(A).

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

    datatype_icon

    ztrmm

    Matrix of the same dimensions as B.

    If side is Left, this output returns the result of alpha * op(A) * B. If side is Right, this output returns the result of alpha * B * op(A).

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

    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