ToFloatPower (Float function)
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.