$RxpI: Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
No edit summary |
||
| Line 2: | Line 2: | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented | ||
methods. There is currently no direct OO equivalent for the $RxpI function.</p> | methods. There is currently no direct OO equivalent for the $RxpI function.</p> | ||
The <var>$RxpI</var> function returns the value of its first | The <var>$RxpI</var> function returns the value of its first | ||
| Line 12: | Line 9: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%num</span><span class="literal"> = $RxpI(</span><span class="term">x</span><span class="literal">)</span> </p> | <p class="syntax"><span class="term">%num</span><span class="literal"> = $RxpI(</span><span class="term">x</span>, <span class="term">y</span><span class="literal">)</span> </p> | ||
Omitted arguments are set to 0. | ==Usage notes== | ||
If | <ul> | ||
<li>Omitted arguments are set to 0. | |||
<li>If <var class="term">x</var> equals 0, and |<var class="term">y</var>| is less | |||
than or equal to 0, an error message is printed and a 0 is returned. | than or equal to 0, an error message is printed and a 0 is returned. | ||
<li>{{Template:Math $functions note}} | |||
< | </ul> | ||
==Examples== | |||
<p class="code">$rxpi(2, 3) = 2<sup>3</sup> = 8 | |||
$rxpi(.5, 1.4) = $rxpi(.5, 1) = .5 | |||
</p> | </p> | ||
[[Category: Mathematical $functions]] | |||
Revision as of 20:35, 10 April 2013
Real base raised to integer exponent
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direct OO equivalent for the $RxpI function.
The $RxpI function returns the value of its first argument raised to the power of its second argument. The second argument is initially rounded to the nearest integral value.
Syntax
%num = $RxpI(x, y)
Usage notes
- Omitted arguments are set to 0.
- If x equals 0, and |y| is less than or equal to 0, an error message is printed and a 0 is returned.
- See the SIRFUNC EXEC parameter for an explanation of when this high-performance, high-precision version of the IBM mathematical function from the Sirius Mods is used, as opposed to the version of the $function in the Model 204 FUND or FUNDLE CSECT.
Examples
$rxpi(2, 3) = 23 = 8 $rxpi(.5, 1.4) = $rxpi(.5, 1) = .5