Log and LogE (Float functions): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:Float:Log and LogE subtitle}}
{{Template:Float:Log and LogE subtitle}}


These [[Intrinsic classes|intrinsic]] functions return a number that is the natural [http://en.wikipedia.org/wiki/Logarithm logarithm]
The <var>Log</var> and <var>LogE</var> [[Intrinsic classes|intrinsic]] functions return a number that is the natural [http://en.wikipedia.org/wiki/Logarithm logarithm] (the logarithm base [http://en.wikipedia.org/wiki/E_%28mathematical_constant%29 &#x212f;]) of the method object value.
(the logarithm base-''[http://en.wikipedia.org/wiki/E_%28mathematical_constant%29 e]]'') of the method object value.


''LogE'' is a synonym for ''Log''.
<var>LogE</var> is a synonym for <var>Log</var>.


Available as of version 7.3 of the <var class=product>Sirius Mods</var>, the Log and LogE functions are
object-oriented versions of the $Log function.
==Syntax==
==Syntax==
{{Template:Float:Log syntax}}
{{Template:Float:Log syntax}}
{{Template:Float:LogE syntax}}
{{Template:Float:LogE syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%value </th>
<tr><th>%number </th>
<td>A numeric variable to receive the log of the method object. </td></tr>
<td>A numeric variable to receive the log of the method object. </td></tr>
<tr><th>number </th>
 
<td>A Float value.</td></tr>
<tr><th>float</th>
<td>A <var>Float</var> value.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
*If ''number'' is not greater than zero, the request is cancelled.
<ul>
<li>If <var class="term">float</var> is less than or equal to zero, then the request is cancelled.
 
<li><var>Log</var> or <var>LogE</var> is an object-oriented version of the <var>[[$Log]]</var> function.
 
<li><var>Log</var> and <var>LogE</var> are available as of <var class="product">Sirius Mods</var> Version 7.3.
</ul>
 
==Examples==
==Examples==
The following statement returns "''3.14159:log = 1.14472904118518''".
The following statement returns <code>3.14159:log = 1.14472904118518</code>.
    [[Intrinsic classes#printtext|printText]] {~} = {3.14159:log}
<p class="code">[[PrintText statement|printText]] {~} = {3.14159:log}</p>


==See also==
==See also==
{{Template:Float:Log and LogE footer}}
{{Template:Float:Log and LogE footer}}
[[List of intrinsic Float methods]]
<!--
<section begin=dpl_desc />
Natural log (log base e) of number
<section end=dpl_desc />
-->

Latest revision as of 17:55, 2 November 2012

Natural log (base e) of a number (Float class)


The Log and LogE intrinsic functions return a number that is the natural logarithm (the logarithm base ) of the method object value.

LogE is a synonym for Log.

Syntax

%number = float:Log

%number = float:LogE

Syntax terms

%number A numeric variable to receive the log of the method object.
float A Float value.

Usage notes

  • If float is less than or equal to zero, then the request is cancelled.
  • Log or LogE is an object-oriented version of the $Log function.
  • Log and LogE are available as of Sirius Mods Version 7.3.

Examples

The following statement returns 3.14159:log = 1.14472904118518.

printText {~} = {3.14159:log}

See also