Log2 (Float function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Float:Log2 subtitle}} | |||
This [[Intrinsic classes|intrinsic]] function returns a number that is the [http://en.wikipedia.org/wiki/Logarithm logarithm] base-2 | This [[Intrinsic classes|intrinsic]] function returns a number that is the [http://en.wikipedia.org/wiki/Logarithm logarithm] base-2 | ||
of the method object value. | of the method object value. | ||
| Line 4: | Line 6: | ||
Available as of version 7.3 of the [[Sirius Mods]], the Log2 function is | Available as of version 7.3 of the [[Sirius Mods]], the Log2 function is | ||
an object-oriented version of the $Log2 function. | an object-oriented version of the $Log2 function. | ||
== | ==Syntax== | ||
{{Template:Float:Log2 syntax}} | |||
===Syntax terms=== | |||
<dl> | <dl> | ||
<dt>%value | <dt>%value | ||
| Line 13: | Line 15: | ||
<dd>A Float value. | <dd>A Float value. | ||
</dl> | </dl> | ||
==Usage notes== | |||
*If ''number'' is not greater than zero, the request is cancelled. | *If ''number'' is not greater than zero, the request is cancelled. | ||
==Examples== | |||
The following statement returns | The following statement returns "''3.14159:log2 = 1.65149491087943''". | ||
[[Intrinsic classes#printtext|PrintText]] {~} = {3.14159:log2} | [[Intrinsic classes#printtext|PrintText]] {~} = {3.14159:log2} | ||
Revision as of 13:42, 19 January 2011
Log base 2 of a number (Float class)
This intrinsic function returns a number that is the logarithm base-2
of the method object value.
Available as of version 7.3 of the Sirius Mods, the Log2 function is an object-oriented version of the $Log2 function.
Syntax
%number = float:Log2
Syntax terms
- %value
- A numeric variable to receive the base-2 log of the method object.
- number
- A Float value.
Usage notes
- If number is not greater than zero, the request is cancelled.
Examples
The following statement returns "3.14159:log2 = 1.65149491087943".
PrintText {~} = {3.14159:log2}
See also
List of intrinsic Float methods