High Throughput Square Root
- Updated2023-02-17
- 4 minute(s) read
High Throughput Square Root
Computes the square root of a specified value (x).
Inputs/Outputs

x
An input to this operation. x must be unsigned.

input valid
Boolean value that specifies whether the next data point is valid and can be processed.
Wire output valid 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. |

ready for output
Boolean value that specifies whether downstream nodes are ready for this node to return a new value.
Use Feedback Node to wire this input to the ready for input input of a downstream node. If this input is False during a given cycle, output valid returns False during that cycle.
| True | The downstream node is ready for the next data element. |
| False | The downstream node is not ready for the next data element. |
Default value: False

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. |

sqrt(x)
Square root of x.

output valid
Boolean value that indicates whether this node computes 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 | Downstream nodes can use the result this node computes. |
| False | This node returns an undefined value that downstream nodes cannot use.
Note This node may return different undefined values when executed in simulation mode versus when executed on hardware.
|

ready for input
Boolean value that indicates whether this node is ready to accept new input data.
Use Feedback Node to wire this output to the ready for output output 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. |
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: 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:
- Select this node on the diagram.
- Disable Auto Adapt for the Precision option on the Item tab.
- 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.