ToIntegerPower and ToPower (Float functions): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 33: | Line 33: | ||
[[Category: Intrinsic methods]] | [[Category: Intrinsic methods]] | ||
[[Category:System methods]] | [[Category:System methods]] | ||
<!-- | |||
<section begin=dpl_desc /> | |||
Raise number to an integer power | |||
<section end=dpl_desc /> | |||
--> | |||
Revision as of 12:33, 22 December 2010
These intrinsic functions return a number that is the method object value raised to the power specified by the method argument. The argument value is initially rounded to the nearest integral value.
ToPower is a synonym for ToIntegerPower.
Available as of version 7.3 of the Sirius Mods, the ToIntegerPower and ToPower functions are object-oriented versions of the $RXPI function.
ToPower syntax
%value = number:toPower(exponent)
Syntax terms
- %value
- A numeric variable to contain the method result.
- number
- A Float value.
- exponent
- A Float value, which is rounded to the nearest integer.
Usage Notes
- If number is 0 and exponent is less than or equal to 0, the request is cancelled.
Examples
The following statement returns “3:toPower(5) = 243”.
printText {~} = {3:toPower(5)}
The following statement returns “-.1:toPower(2.8) is -0.001”.
printText {~} is {-.1:toPower(2.8)}
The following statement returns “2:toIntegerPower(-2.2) is 0.25”.
printText {~} is {2:toIntegerPower(-2.2)}
See also
List of Intrinsic Float Methods