$Sqrt: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (minor formatting) |
||
| Line 1: | Line 1: | ||
<span class="pageSubtitle">Square root</span> | <span class="pageSubtitle">Square root</span> | ||
<p class="warn"><b>Note: </b> | <p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. | ||
methods. | The OO equivalent for the <var>$Sqrt</var> function is the <var>[[SquareRoot (Float function)|SquareRoot]]</var> function.</p> | ||
The OO equivalent for the | |||
<var>$Sqrt</var> | |||
function is the <var>[[SquareRoot (Float function)|SquareRoot]]</var> function. | |||
</p> | |||
The <var>$Sqrt</var> function returns | The <var>$Sqrt</var> function returns the value of the square root of the given argument. | ||
the value of the square root of the given argument. | If the argument is negative, an error message is printed and the request is cancelled. | ||
If the argument is negative, an error message is | |||
printed and the request is cancelled. | |||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%num</span><span class="literal"> = $Sqrt(</span><span class="term">x</span><span class="literal">)</span> </p> | <p class="syntax"><span class="term">%num</span><span class="literal"> = $Sqrt(</span><span class="term">x</span><span class="literal">)</span> </p> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>If ''x'' exceeds 7.237 x 10<sup>75</sup>, an arithmetic overflow occurs, and the value 0 is returned.</li> | <li>If ''x'' exceeds 7.237 x 10<sup>75</sup>, an arithmetic overflow occurs, and the value 0 is returned. </li> | ||
</ul> | </ul> | ||
[[Category: Mathematical $functions]] | |||
Latest revision as of 17:10, 2 January 2018
Square root
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sqrt function is the SquareRoot function.
The $Sqrt function returns the value of the square root of the given argument. If the argument is negative, an error message is printed and the request is cancelled.
Syntax
%num = $Sqrt(x)
Usage notes
- If x exceeds 7.237 x 1075, an arithmetic overflow occurs, and the value 0 is returned.