ToFloatPower (Float function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
(30 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{Template:Float:ToFloatPower subtitle}} | {{Template:Float:ToFloatPower subtitle}} | ||
The <var>ToFloatPower</var> [[Intrinsic classes|intrinsic]] function returns a number that is the method object value [http://en.wikipedia.org/wiki/Raised_to_the_power "raised to the float power"] specified by the method argument. | |||
[http://en.wikipedia.org/wiki/Raised_to_the_power raised to the float power] specified by the method argument. | |||
==Syntax== | ==Syntax== | ||
{{Template:Float:ToFloatPower syntax}} | {{Template:Float:ToFloatPower syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th>%number</th> | ||
< | <td>A numeric variable to contain the method result. </td></tr> | ||
< | |||
< | <tr><th>float</th> | ||
< | <td>A <var>Float</var> value. </td></tr> | ||
< | |||
</ | <tr><th>exponent</th> | ||
<td>A <var>Float</var> value.</td></tr> | |||
</table> | |||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li>If <var class="term">float</var> is equal to 0, and <var class="term">exponent</var> is less than or equal to 0, the request is cancelled. | |||
<li>If <var class="term">float</var> is less than 0, and <var class="term">exponent</var> is not 0, the request is cancelled. This is so because, unlike <var>[[ToIntegerPower_(Float_function)|ToIntegerPower]]</var>, the computation algorithm involves the log of <var class="term">float</var>. | |||
<li><var>ToFloatPower</var> uses good-fit techniques that sometimes produce slightly different results from <var>ToIntegerPower</var> with the same inputs. | |||
<li><var>ToFloatPower</var> is an object-oriented version of the <var>$RXPR</var> function. | |||
<li><var>ToFloatPower</var> is available as of <var class="product">Sirius Mods</var> Version 7.3. | |||
</ul> | |||
==Examples== | ==Examples== | ||
For example: | For example: | ||
<p class="code">begin | |||
[[PrintText statement|printText]] {~} = {3:toFloatPower(6)} | [[PrintText statement|printText]] {~} = {3:toFloatPower(6)} | ||
printText {~} = {3:toIntegerPower(6)} | printText {~} = {3:toIntegerPower(6)} | ||
printText {~} = {10:toFloatPower(7)} | printText {~} = {10:toFloatPower(7)} | ||
printText {~} = {10:toIntegerPower(7)} | printText {~} = {10:toIntegerPower(7)} | ||
end | |||
</p> | |||
displays | displays | ||
<p class="output">3:toFloatPower(6) = 728.999999999999 | |||
3:toIntegerPower(6) = 729 | |||
10:toFloatPower(7) = 9999999.99999997 | |||
10:toIntegerPower(7) = 10000000 | |||
Consequently, you should generally use ToIntegerPower unless you really are working with non-integer powers. | </p> | ||
Consequently, you should generally use <var>ToIntegerPower</var> unless you really are working with non-integer powers. | |||
==See also== | |||
{{Template:Float:ToFloatPower footer}} | |||
Latest revision as of 18:15, 2 November 2012
Raise number to a floating point power (Float class)
The ToFloatPower intrinsic function returns a number that is the method object value "raised to the float power" specified by the method argument.
Syntax
%number = float:ToFloatPower( exponent)
Syntax terms
%number | A numeric variable to contain the method result. |
---|---|
float | A Float value. |
exponent | A Float value. |
Usage notes
- If float is equal to 0, and exponent is less than or equal to 0, the request is cancelled.
- If float is less than 0, and exponent is not 0, the request is cancelled. This is so because, unlike ToIntegerPower, the computation algorithm involves the log of float.
- ToFloatPower uses good-fit techniques that sometimes produce slightly different results from ToIntegerPower with the same inputs.
- ToFloatPower is an object-oriented version of the $RXPR function.
- ToFloatPower is available as of Sirius Mods Version 7.3.
Examples
For example:
begin printText {~} = {3:toFloatPower(6)} printText {~} = {3:toIntegerPower(6)} printText {~} = {10:toFloatPower(7)} printText {~} = {10:toIntegerPower(7)} end
displays
3:toFloatPower(6) = 728.999999999999 3:toIntegerPower(6) = 729 10:toFloatPower(7) = 9999999.99999997 10:toIntegerPower(7) = 10000000
Consequently, you should generally use ToIntegerPower unless you really are working with non-integer powers.