Table Of Contents

High Throughput Square Root (Clock-Driven Logic)

Last Modified: September 10, 2016

Computes the square root of a specified value (x).

connector_pane_image
datatype_icon

x

An input to this operation. x must be unsigned. This input supports only scalar values of the fixed-point data type.

datatype_icon

input valid

A Boolean that 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.

TRUE The data point is valid and can be processed.
FALSE The data point is not valid.
datatype_icon

ready for output

A Boolean that specifies whether downstream nodes are ready for this node to return a new value. Use a Feedback Node to wire the ready for input output of a downstream node to this input of the current node.

True The downstream node is ready for the next data point.
False The downstream node is not ready for the next data point.
spd-note-note
Note  

If this input is False during a given cycle, output valid returns False during that cycle.

Default: TRUE

datatype_icon

operation overflow

A Boolean that indicates whether the theoretical computed value exceeds the valid range of the output data type.

TRUE The theoretical computed value exceeds the valid range of the output data type.
FALSE The theoretical computed value does not exceed the valid range of the output data type.
datatype_icon

sqrt(x)

Square root of x.

datatype_icon

output valid

A Boolean that indicates whether 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.

True The node has computed a result that downstream nodes can use.
False This node has not computed a result that downstream nodes can use. Any data output returns an undefined value. The undefined value returned by a data output may differ between simulation and hardware.
datatype_icon

ready for input

A Boolean that indicates whether 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.

True The node is ready to accept new input data.
False The node is not ready to accept new input data.
spd-note-note
Note  

If this output returns False during a given cycle, this node discards any data that other nodes send to this node during the following cycle. This node discards the data even if input valid is True during the following cycle.

Avoiding Overflow in sqrt(x)

If you leave Auto Adapt enabled for this node, overflow still can occur in the sqrt(x) output if all of the following conditions are true:

  • The Rounding pull-down menu in the Item tab specifies Round Half Up or Round Half to Even.
  • The integer word length of x is an even number.
  • The following relationship is true:
    fwl sqrt < log 2 ( 2 iwl x 2 2 iwl x 2 f w l x )
    where fwl refers to the fractional word length of an input and iwl refers to the integer word length of an input.

Complete the following steps to avoid overflow:

  1. Select this node on the diagram.
  2. Disable Auto Adapt for the Precision option on the Item tab.
  3. Configure the Precision, Overflow, and Rounding for the node.

After you complete these steps, High Throughput Square Root no longer adjusts the fixed-point configuration of sqrt(x) automatically. If you change the fixed-point configuration of the x input and still want to avoid overflow, re-enable Auto Adapt. Then, complete the same steps to specify an exact integer word length and ensure that no overflow occurs.

Where This Node Can Run:

Desktop OS: none

FPGA: All devices


Recently Viewed Topics