$Log2 or $Log 2: Difference between revisions
Jump to navigation
Jump to search
(Created page with " <span class="pageSubtitle">Log base 2 function</span> <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for t...") |
m (minor formatting) |
||
| (9 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Log2 or $Log_2}} | |||
<span class="pageSubtitle">Log base 2 function</span> | <span class="pageSubtitle">Log base 2 function</span> | ||
<p class=" | <p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. | ||
methods. | The OO equivalent for the <var>$Log2</var> function is the <var>[[Log2 (Float function)|Log2]]</var> function. | ||
The OO equivalent for the | |||
<var>$Log2</var> | |||
function is the <var>[[Log2 (Float function)|Log2]]</var> function. | |||
</p> | </p> | ||
The <var>$Log2</var> function (or its alias, <var>$Log_2</var>) returns the base-2 logarithm of the number ''x''. | |||
The <var>$Log2</var> function returns the base-2 logarithm | |||
of the number ''x''. | |||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%num</span><span class="literal"> = $Log2(</span><span class="term">x</span><span class="literal">)</span> </p> | <p class="syntax"><span class="term">%num</span><span class="literal"> = $Log2(</span><span class="term">x</span><span class="literal">)</span> </p> | ||
<p class="syntax"><span class="term">%num</span><span class="literal"> = $Log_2(</span><span class="term">x</span><span class="literal">)</span> </p> | |||
If ''x'' is not greater than 0, | ==Usage notes== | ||
an error message is printed and | <ul> | ||
<li>If ''x'' is not greater than 0, | |||
an error message is printed and the request is cancelled.</li> | |||
</ul> | |||
[[Category: Mathematical $functions]] | |||
Latest revision as of 17:01, 2 January 2018
Log base 2 function
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Log2 function is the Log2 function.
The $Log2 function (or its alias, $Log_2) returns the base-2 logarithm of the number x.
Syntax
%num = $Log2(x)
%num = $Log_2(x)
Usage notes
- If x is not greater than 0, an error message is printed and the request is cancelled.