Difference between revisions of "Extensions.Math.Log"

From emotive
Jump to navigation Jump to search
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:'''Log '''}}[[Category:Math]]
 
{{DISPLAYTITLE:'''Log '''}}[[Category:Math]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | Log | Calculates the logarithm of a given number to a given base| [[Term]] | [[Extensions.Math|OTX Math Extension]] | - | - | - | Yes}}
+
{{ClassificationActivity | Log | Calculates the logarithm of a given number to a given base| [[Term]] | [[Extensions.Math|OTX Math Extension]] | [[Extensions.Math#Actions|Math related Actions]] | - | - | Yes}}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
FloatTerm = Math.Log(NumericTerm, NumericTerm);
+
FloatTerm Math.Log(NumericTerm numeral, NumericTerm base);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 16: Line 16:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Numeral | [[Numeric]] | [[Term]] | - | [1] | Represents the numeric value on which the logarithm shall be calculated. If the value is [[Core.DataTypes.SimpleDataType.Integer|'''Integer''']], it shall be automatically promoted to [[Core.DataTypes.SimpleDataType.Float|'''Float''']].}}
+
{{TableRowPropertie1| Numeral | [[Numeric]] | [[Term]] | - | [1] | Represents the numeric value on which the logarithm will be calculated. If the value is [[Core.DataTypes.SimpleDataType.Integer|'''Integer''']], it will be automatically promoted to [[Core.DataTypes.SimpleDataType.Float|'''Float''']].}}
{{TableRowPropertie2| Base | [[Numeric]] | [[Term]] | - | [1] | The numerical value (of type Integer or Float), which will serve as the logarithmic basis of the calculation. If the value is [[Core.DataTypes.SimpleDataType.Integer|'''Integer''']], it shall be automatically promoted to [[Core.DataTypes.SimpleDataType.Float|'''Float''']].}}
+
{{TableRowPropertie2| Base | [[Numeric]] | [[Term]] | - | [1] | The numerical value (of type Integer or Float), which will serve as the logarithmic basis of the calculation. If the value is [[Core.DataTypes.SimpleDataType.Integer|'''Integer''']], it will be automatically promoted to [[Core.DataTypes.SimpleDataType.Float|'''Float''']].}}
 
|}
 
|}
  
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
/// Local Declarations
 +
 
Float Float1;
 
Float Float1;
  

Latest revision as of 02:46, 13 September 2019

Classification

Name Log
Short Description Calculates the logarithm of a given number to a given base
Class Term
Extension OTX Math Extension
Group Math related Actions
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

FloatTerm Math.Log(NumericTerm numeral, NumericTerm base);

Description

The Log term is used for calculating the logarithm of a given number to a given base.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Float Result of the calculation of the logarithm of a number.

Properties

Name Data Type Class Default Cardinality Description
Numeral Numeric Term - [1] Represents the numeric value on which the logarithm will be calculated. If the value is Integer, it will be automatically promoted to Float.
Base Numeric Term - [1] The numerical value (of type Integer or Float), which will serve as the logarithmic basis of the calculation. If the value is Integer, it will be automatically promoted to Float.

OTL Examples

/// Local Declarations

Float Float1;

/// Flow

Float1 = Math.Log(4, 2);

See also

Power
Ln
Sin
Cos
Tan