$Log or $Log e: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 9: Line 9:
</p>
</p>


The <var>$Log</var> function returns the natural logarithm
The <var>$Log</var> function (or its alias, <var>$Log_e</var>) returns the natural logarithm
(the logarithm base ''[http://en.wikipedia.org/wiki/E_%28mathematical_constant%29 e]'') of the number ''x''.
(the logarithm base ''[http://en.wikipedia.org/wiki/E_%28mathematical_constant%29 e]'') of the number ''x''.


==Syntax==
==Syntax==
<p class="syntax"><span class="term">%num</span><span class="literal"> = $Log(</span><span class="term">x</span><span class="literal">)</span>  </p>
<p class="syntax"><span class="term">%num</span><span class="literal"> = $Log(</span><span class="term">x</span><span class="literal">)</span>  </p>
<p class="syntax"><span class="term">%num</span><span class="literal"> = $Log_e(</span><span class="term">x</span><span class="literal">)</span>  </p>


If ''x'' is not greater than 0, an error message is printed and a 0 is returned.
If ''x'' is not greater than 0, an error message is printed and a 0 is returned.


{{Template:Math $functions note}}
{{Template:Math $functions note}}

Revision as of 20:07, 10 January 2012

Log function

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Log function is the LogE function.

The $Log function (or its alias, $Log_e) returns the natural logarithm (the logarithm base e) of the number x.

Syntax

%num = $Log(x)

%num = $Log_e(x)

If x is not greater than 0, an error message is printed and a 0 is returned.

See the SIRFUNC EXEC parameter for an explanation of when this high-performance, high-precision version of the IBM mathematical function from the Sirius Mods is used, as opposed to the version of the $function in the Model 204 FUND or FUNDLE CSECT.