Computes the product of two complex numbers.

The High Throughput Complex Multiply function multiplies two complex numbers x = xr + jxi and y = yr + jyi, to produce a product p, as shown in the equation below.

p = x*y = pr + jpi

where pr = xryr – xiyi and pi = xryi + xiyr

This function supports only scalar values of the fixed-point data type.


icon

Dialog Box Options

Option Description
Fixed-Point Configuration

Specifies the encodings, word lengths, and integer word lengths of the input and output terminals of this function. The configurations you specify determine the value range of the terminals.

  • xr/xi Type—

    Specifies the fixed-point configuration of the xr and xi input terminals.

    If you wire a fixed-point data type to these terminals, LabVIEW dims this section and uses information from the wire.

    • Signed—Specifies that this terminal is signed.
    • Unsigned—Specifies that this terminal is unsigned.
    • Word length—Specifies the word length of this terminal.
    • Integer word length—Specifies the integer word length of this terminal.
  • yr/yi Type—

    Specifies the fixed-point configuration of the yr and yi input terminals

    If you wire a fixed-point data type to these terminals, LabVIEW dims this section and uses information from the wire.

    • Signed—Specifies that this terminal is signed.
    • Unsigned—Specifies that this terminal is unsigned.
    • Word length—Specifies the word length of this terminal.
    • Integer word length—Specifies the integer word length of this terminal.
  • pr/pi Type—

    Specifies the fixed-point configuration of the pr and pi output terminals

    • Adapt to source—Specifies whether LabVIEW automatically adjusts the fixed-point configuration of the output data type to avoid overflow and rounding errors. By default, this checkbox contains a checkmark and LabVIEW dims the following options.
      Note LabVIEW supports a maximum word length of 64 bits and a maximum integer word length of 2047 bits. If you place a checkmark in this checkbox and the output data type requires a word length that exceeds these maximum values, overflow and/or rounding errors might occur.
    • Signed—Specifies that this terminal is signed.
    • Unsigned—Specifies that this terminal is unsigned.
    • Word length—Specifies the word length of this terminal.
    • Integer word length—Specifies the integer word length of this terminal.
    • Include overflow status—Specifies whether the output terminals include the overflow status. LabVIEW propagates this status to downstream nodes. Including this status requires additional FPGA resources. By default, this checkbox does not contain a checkmark.

      If you place a checkmark in this checkbox, the overflow status becomes TRUE in either of the following situations:

      • The overflow status of an input terminal is TRUE.
      • Overflow occurs during the operation of this function.
      Note If an overflow occurs internally during the operation of this function, LabVIEW sets the overflow bit in both pr and pi.

      If you place a checkmark in the Adapt to source checkbox, LabVIEW sets Include overflow status depending on whether an input terminal includes this status.

  • Overflow mode—

    Specifies how this function handles overflow. You can choose either Wrap (default) or Saturate.

    Note The Saturate option requires more FPGA resources and a longer combinatorial path than the Wrap option does. In this situation, choosing Saturate might decrease the maximum clock rate at which this function can compile.
  • Rounding mode—

    Specifies how this function rounds the output data if rounding is necessary. You can choose Truncate (default), Round Half-Up, or Round Half-Even. The option you choose might affect the amount of resources this function requires.
Execution Mode

Specifies how this function executes.

  • Outside single-cycle Timed Loop—

    Configures this Express VI to execute outside a single-cycle Timed Loop.

    If you select this option and place this Express VI inside a single-cycle Timed Loop, the Code Generation Errors window reports an error when you compile the FPGA VI.

  • Inside single-cycle Timed Loop—

    Configures this Express VI to execute inside a single-cycle Timed Loop.

    If you select this option and place this Express VI outside a single-cycle Timed Loop, the Code Generation Errors window reports an error when you compile the FPGA VI.
Pipelining Options

Specifies options for pipelining this function internally. These options affect the maximum clock rate at which this function can compile. Refer to the Improving Function Performance by Pipelining section of this topic for information about this relationship.

  • Number of pipelining stages—Specifies the number of pipelining stages this function uses internally. Increasing the number of stages increases the clock rate at which this function can compile but also increases the amount of FPGA resources this function requires. The default is 0 stages, which specifies no pipelining. The maximum is 11 stages
  • Implementation resource—Specifies how to implement the multiplier.

    You can choose from the following options:

    • Auto(default)—Specifies that the compiler decides whether to use embedded block multipliers or look-up tables (LUTs) to implement the multiplier.
    • Look-Up Table—Specifies that this function uses LUTs to implement the multiplier. Selecting this option might increase the clock rate at which this function can compile.
Registers

Specifies whether to add internal registers for function inputs and/or outputs. These registers will be placed outside of any embedded resources, such as block multipliers or DSP48E slices. This section is available only if you select Inside single-cycle Timed Loop.

Note Adding registers can reduce the length of the combinatorial path, which can prevent compilation errors that result from a long combinatorial path. However, adding registers also increases the latency of this function, which means this function takes additional clock cycles to return a valid result.
  • Register inputs—Adds internal registers after the inputs to this function. Selecting this option increases the latency of the function by one cycle.
  • Register outputs—Adds internal registers before the outputs of this function. Selecting this option increases the latency of the function by one cycle.
Optional Terminal

Specifies a setting for displaying an optional block diagram terminal.

  • Operation overflow—Specifies that this function displays the operation overflow output terminal on the block diagram. This terminal indicates whether overflow occurred during the operation of this function.
Configuration Feedback

Displays information about how this function executes. This information is based on the configuration options you specify.

Inputs/Outputs

  • cunkn.png xr —

    Specifies the real part of the x multiplicand.

  • cunkn.png xi —

    Specifies the imaginary part of the x multiplicand.

  • cunkn.png yr —

    Specifies the real part of the y multiplicand.

  • cunkn.png yi —

    Specifies the imaginary part of the y multiplicand.

  • input valid —

    Specifies whether the next data point has arrived for processing. Wire the output valid output of an upstream node to this input to transfer data from the upstream node to this node.

    To display this handshaking terminal, select Inside single-cycle Timed Loop option and perform either of the following actions:

    • Place a checkmark in either the Register inputs or Register outputs checkbox.
    • Set the Number of pipelining stages to at least 1.

    These options are located in the configuration dialog box.

  • ready for output —

    Specifies whether downstream nodes are ready for this node to return a new value. The default is TRUE. Use a Feedback Node to wire ready for input output of a downstream node to this input of the current node.

    Note If this terminal is FALSE during a given cycle, the output valid terminal returns FALSE during that cycle.

    To display this terminal, select the Inside single-cycle Timed Loop option and perform either of the following actions:

    • Place a checkmark in either the Register inputs or Register outputs checkbox.
    • Set the Number of pipelining stages to at least 1.

    These options are located in the configuration dialog box.

  • iunkn.png pr —

    Returns the real part of the product.

  • iunkn.png pi —

    Returns the imaginary part of the product.

  • operation overflow —

    Returns TRUE if the theoretical computed value exceeds the valid range of the output data type. If operation overflow returns TRUE, the Overflow mode option determines the value this function returns.

    LabVIEW displays the operation overflow terminal only if you place a checkmark in the Operation overflow checkbox. This checkbox is located in the Optional Terminal section of the configuration dialog box.

  • output valid —

    Returns TRUE if this node has computed a result that downstream nodes can use. Wire this output to the input valid input of a downstream node to transfer data from the node to the downstream node.

    To display this terminal, select the Inside single-cycle Timed Loop option and perform either of the following actions:

    • Place a checkmark in either the Register inputs or Register outputs checkbox.
    • Set the Number of pipelining stages to at least 1.

    These options are located in the configuration dialog box.

  • ready for input —

    Returns TRUE if this node is ready to accept new input data. Use a Feedback Node to wire this output to the ready for output input of an upstream node.

    Note If this terminal returns FALSE during a given cycle, LabVIEW discards any data that other nodes send to this node during the following cycle. LabVIEW discards this data even if the input valid terminal is TRUE during the following cycle.

    To display this terminal, select the Inside single-cycle Timed Loop option and perform either of the following actions:

    • Place a checkmark in either the Register inputs or Register outputs checkbox.
    • Set the Number of pipelining stages to at least 1.

    These options are located in the configuration dialog box.

    • During the cycles before output valid returns TRUE for the first time, this function might return different results on an FPGA target than on a host computer. The results become identical after the first time output valid returns TRUE.

    Improving Function Performance by Pipelining

    You can improve the timing performance of this function on an FPGA target by adjusting the Number of pipelining stages. The functionality of a pipelined multiplier is equivalent to a non-pipelined multiplier cascaded by a certain number of registers. The number of registers is equal to the number of pipelining stages.

    In general, increasing the Number of pipelining stages also increases the maximum clock rate at which this function can compile. However, the actual clock rate depends on many factors, including the following:

    • The FPGA target you use
    • The size of the multiplier
    • The rounding and overflow modes you select
    • The Implementation resource you select
    • Other FPGA logic besides the multiplier