Antilog2 (Float function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax diagram to revised template; fix tags and some links; still some incomplete / unfound links)
mNo edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:Float:Antilog2 subtitle}}
{{Template:Float:Antilog2 subtitle}}


The <var>antilog2</var> <var>[[Intrinsic classes|intrinsic]]</var> function returns a number that is the base-2 [http://en.wikipedia.org/wiki/Antilog#Antilogarithms anti-logarithm] (or 2's exponent)
The <var>antilog2</var> [[Intrinsic classes|intrinsic]] function returns a number that is the base-2 [http://en.wikipedia.org/wiki/Antilog#Antilogarithms anti-logarithm] (or 2's exponent)
of the method object value.  The result is '<code>2</code>', the base-2 logarithmic base, raised to the power of the method object value.
of the method object value.  The result is '<code>2</code>', the base-2 logarithmic base, raised to the power of the method object value.


==Syntax==
==Syntax==
{{Template:Float:Antilog2 syntax}}
{{Template:Float:Antilog2 syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%number</th>
<tr><th>%number</th>
<td>A numeric variable to receive the base-2 antilog of the method object. </td></tr>
<td>A numeric variable to receive the base-2 antilog of the method object. </td></tr>
<tr><th>float</th>
<tr><th>float</th>
<td>A <var>Float</var> value.</td></tr>
<td>A <var>Float</var> value.</td></tr>
Line 15: Line 17:


==Usage notes==
==Usage notes==
<ul><li>Available as of <var class="product">[[Sirius Mods]]</var> Version 7.3.
<ul>
<li><var>antilog2</var> is an object-oriented version of the <var>[[$Exp2|$Exp2]]</var> function.
<li><var>antilog2</var> is available as of <var class="product">Sirius Mods|Sirius Mods</var> Version 7.3.
</ul>
</ul>


==Examples==
==Examples==
<ol><li>The following statement returns '<code>-3:antilog2 = 0.125</code>'.
The following statement returns '<code>-3:antilog2 = 0.125</code>'.
<p class="code">printText {~} = {'-3':antiLog2}
<p class="code">[[PrintText statement|printText]] {~} = {'-3':antiLog2}
</p></ol>
</p>


==See also==
==See also==
<ul><li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext|printText]]</var>.
<li><var>antilog2</var> is an object-oriented version of the [[$Exp2|$Exp2 function]].
</ul>
{{Template:Float:Antilog2 footer}}
{{Template:Float:Antilog2 footer}}

Latest revision as of 17:14, 2 November 2012

Antilog base 2 of a number (Float class)


The antilog2 intrinsic function returns a number that is the base-2 anti-logarithm (or 2's exponent) of the method object value. The result is '2', the base-2 logarithmic base, raised to the power of the method object value.

Syntax

%number = float:Antilog2

Syntax terms

%number A numeric variable to receive the base-2 antilog of the method object.
float A Float value.

Usage notes

  • antilog2 is an object-oriented version of the $Exp2 function.
  • antilog2 is available as of Sirius Mods|Sirius Mods Version 7.3.

Examples

The following statement returns '-3:antilog2 = 0.125'.

printText {~} = {'-3':antiLog2}

See also