Package com.aquima.interactions.expressions.functions.number

Class Logarithm

java.lang.Object
com.aquima.interactions.expressions.functions.number.Logarithm
All Implemented Interfaces:
IFunction, Serializable
public class Logarithm extends Object implements IFunction
This function calculates the log of a number for a specific base
Since:
12.8
Author:
v.bingley
See Also:

  • Constructor Details

    • Logarithm

      public Logarithm()

  • Method Details

    • evaluate

      public IValue evaluate(IArgumentList arguments)
      Description copied from interface: IFunction
      This method should execute the function using the supplied arguments.
      Specified by:
      evaluate in interface IFunction
      Parameters:
      arguments - The arguments for the function.
      Returns:
      The result of the function.

    • getName

      public String getName()
      Description copied from interface: IFunction
      This method returns the name of the function.
      Specified by:
      getName in interface IFunction
      Returns:
      the name of the function.

    • getArguments

      public IArgumentType[] getArguments()
      Description copied from interface: IFunction
      This method returns an array containing the definitions of the arguments the function expects. When the function does not accept any arguments at all, an empty array should be returned.
      Specified by:
      getArguments in interface IFunction
      Returns:
      Array containing the definitions of the parameters.

    • determineResultType

      public Type determineResultType(ISemanticNode... arguments)
      Description copied from interface: IFunction
      This method is used to determine the result type of the function using the type information of the parameters that will be passed to the function.
      Specified by:
      determineResultType in interface IFunction
      Parameters:
      arguments - The type information of the parameters.
      Returns:
      The result type of the function.

    • isDeprecated

      public boolean isDeprecated()
      Description copied from interface: IFunction
      This method returns a boolean indicating that the function is deprecated and should no longer be used. Functions that are not deprecated should return the value false.
      Specified by:
      isDeprecated in interface IFunction
      Returns:
      A message indicating that the function is deprecated.