Log and LogE (Float functions): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Float:Log and LogE subtitle}} | {{Template:Float:Log and LogE subtitle}} | ||
The <var>Log</var> and <var>LogE</ | 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 ℯ]) of the method object value. | ||
<var>LogE</var> is a synonym for <var>Log</var>. | <var>LogE</var> is a synonym for <var>Log</var>. | ||
| Line 8: | Line 8: | ||
{{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>%number </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>float</th> | <tr><th>float</th> | ||
<td>A <var>Float</var> value.</td></tr> | <td>A <var>Float</var> value.</td></tr> | ||
| Line 19: | Line 21: | ||
<ul> | <ul> | ||
<li>If <var class="term">float</var> is less than or equal to zero, then the request is cancelled. | <li>If <var class="term">float</var> is less than or equal to zero, then the request is cancelled. | ||
<li><var>Log</var> | |||
<li><var>Log</var> | <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> | </ul> | ||
==Examples== | ==Examples== | ||
The following statement returns <code>3.14159:log = 1.14472904118518</code>. | |||
<p class="code">[[PrintText statement|printText]] {~} = {3.14159:log}</p> | <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}} | ||
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}