Package org.mariuszgromada.math.mxparser

Class Expression

java.lang.Object
org.mariuszgromada.math.mxparser.PrimitiveElement
org.mariuszgromada.math.mxparser.Expression
public class Expression extends PrimitiveElement
Expression - base class for real expressions definition. Examples:
  • '1+2'
  • 'sin(x)+1'
  • 'asin(3*x)^10-log(4,8)'
  • in general 'f(x1,x2,...,xn)' where x1,...,xn are real arguments

Class provides easy way to define multivariate arithmetic expression.

Version:
4.4.0
See Also:

  • Field Details

  • Constructor Details

    • Expression

      public Expression(PrimitiveElement... elements)
      Default constructor - empty expression
      Parameters:
      elements - Optional elements list (variadic - comma separated) of types: Argument, Constant, Function
      See Also:

    • Expression

      public Expression(String expressionString, PrimitiveElement... elements)
      Constructor - creates new expression from expression string.
      Parameters:
      expressionString - definition of the expression
      elements - Optional elements list (variadic - comma separated) of types: Argument, Constant, Function
      See Also:

  • Method Details

    • getErrorMessage

      public String getErrorMessage()
      Method return error message after calling checkSyntax() method or calculate().
      Returns:
      Error message as string.

    • getSyntaxStatus

      public boolean getSyntaxStatus()
      Gets syntax status of the expression.
      Returns:
      true if there are no syntax errors, false when syntax error was found or syntax status is unknown

    • setExpressionString

      public void setExpressionString(String expressionString)
      Sets (modifies expression) expression string.
      Parameters:
      expressionString - the expression string

    • getExpressionString

      public String getExpressionString()
      Returns expression string
      Returns:
      Expression string definition.

    • clearExpressionString

      public void clearExpressionString()
      Clears expression string

    • setDescription

      public void setDescription(String description)
      Sets expression description.
      Parameters:
      description - the description string

    • getDescription

      public String getDescription()
      Gets expression description.
      Returns:
      String description.

    • clearDescription

      public void clearDescription()
      Clears expression description

    • setVerboseMode

      public void setVerboseMode()
      Enables verbose mode.

    • setSilentMode

      public void setSilentMode()
      Disables verbose mode (default silent mode).

    • getVerboseMode

      public boolean getVerboseMode()
      Returns verbose mode status.
      Returns:
      true if verbose mode is on, otherwise returns false.

    • getRecursiveMode

      public boolean getRecursiveMode()
      Gets recursive mode status
      Returns:
      true if recursive mode is enabled, otherwise returns false.

    • getComputingTime

      public double getComputingTime()
      Gets computing time.
      Returns:
      computing time in seconds.

    • addDefinitions

      public void addDefinitions(PrimitiveElement... elements)
      Adds user defined elements (such as: Arguments, Constants, Functions) to the expressions.
      Parameters:
      elements - Elements list (variadic), where Argument, Constant, Function extend the same class PrimitiveElement
      See Also:

    • removeDefinitions

      public void removeDefinitions(PrimitiveElement... elements)
      Removes user defined elements (such as: Arguments, Constants, Functions) to the expressions.
      Parameters:
      elements - Elements list (variadic), where Argument, Constant, Function extend the same class PrimitiveElement
      See Also:

    • addArguments

      public void addArguments(Argument... arguments)
      Adds arguments (variadic) to the expression definition.
      Parameters:
      arguments - the arguments list (comma separated list)
      See Also:

    • defineArguments

      public void defineArguments(String... argumentsNames)
      Enables to define the arguments (associated with the expression) based on the given arguments names.
      Parameters:
      argumentsNames - the arguments names (variadic) comma separated list
      See Also:

    • defineArgument

      public void defineArgument(String argumentName, double argumentValue)
      Enables to define the argument (associated with the expression) based on the argument name and the argument value.
      Parameters:
      argumentName - the argument name
      argumentValue - the the argument value
      See Also:

    • getArgumentIndex

      public int getArgumentIndex(String argumentName)
      Gets argument index from the expression.
      Parameters:
      argumentName - the argument name
      Returns:
      The argument index if the argument name was found, otherwise returns Argument.NOT_FOUND
      See Also:

    • getArgument

      public Argument getArgument(String argumentName)
      Gets argument from the expression.
      Parameters:
      argumentName - the argument name
      Returns:
      The argument if the argument name was found, otherwise returns null.
      See Also:

    • getArgument

      public Argument getArgument(int argumentIndex)
      Gets argument from the expression.
      Parameters:
      argumentIndex - the argument index
      Returns:
      Argument if the argument index is between 0 and the last available argument index (getArgumentsNumber()-1), otherwise returns null.
      See Also:

    • getArgumentsNumber

      public int getArgumentsNumber()
      Gets number of arguments associated with the expression.
      Returns:
      The number of arguments (int >= 0)
      See Also:

    • setArgumentValue

      public void setArgumentValue(String argumentName, double argumentValue)
      Sets argument value.
      Parameters:
      argumentName - the argument name
      argumentValue - the argument value

    • getArgumentValue

      public double getArgumentValue(String argumentName)
      Gets argument vale.
      Parameters:
      argumentName - the argument name
      Returns:
      Argument value if argument name was found, otherwise return Double.NaN.

    • removeArguments

      public void removeArguments(String... argumentsNames)
      Removes first occurrences of the arguments associated with the expression.
      Parameters:
      argumentsNames - the arguments names (variadic parameters) comma separated list
      See Also:

    • removeArguments

      public void removeArguments(Argument... arguments)
      Removes first occurrences of the arguments associated with the expression.
      Parameters:
      arguments - the arguments (variadic parameters) comma separated list
      See Also:

    • removeAllArguments

      public void removeAllArguments()
      Removes all arguments associated with the expression.
      See Also:

    • addConstants

      public void addConstants(Constant... constants)
      Adds constants (variadic parameters) to the expression definition.
      Parameters:
      constants - the constants (comma separated list)
      See Also:

    • addConstants

      public void addConstants(List<Constant> constantsList)
      Adds constants to the expression definition.
      Parameters:
      constantsList - the list of constants
      See Also:

    • defineConstant

      public void defineConstant(String constantName, double constantValue)
      Enables to define the constant (associated with the expression) based on the constant name and constant value.
      Parameters:
      constantName - the constant name
      constantValue - the constant value
      See Also:

    • getConstantIndex

      public int getConstantIndex(String constantName)
      Gets constant index associated with the expression.
      Parameters:
      constantName - the constant name
      Returns:
      Constant index if constant name was found, otherwise return Constant.NOT_FOUND.
      See Also:

    • getConstant

      public Constant getConstant(String constantName)
      Gets constant associated with the expression.
      Parameters:
      constantName - the constant name
      Returns:
      Constant if constant name was found, otherwise return null.
      See Also:

    • getConstant

      public Constant getConstant(int constantIndex)
      Gets constant associated with the expression.
      Parameters:
      constantIndex - the constant index
      Returns:
      Constant if the constantIndex is between 0 and the last available constant index (getConstantsNumber() - 1), otherwise it returns null.
      See Also:

    • getConstantsNumber

      public int getConstantsNumber()
      Gets number of constants associated with the expression.
      Returns:
      number of constants (int >= 0)
      See Also:

    • removeConstants

      public void removeConstants(String... constantsNames)
      Removes first occurrences of the constants associated with the expression.
      Parameters:
      constantsNames - the constants names (variadic parameters) comma separated list
      See Also:

    • removeConstants

      public void removeConstants(Constant... constants)
      Removes first occurrences of the constants associated with the expression
      Parameters:
      constants - the constants (variadic parameters) comma separated list
      See Also:

    • removeAllConstants

      public void removeAllConstants()
      Removes all constants associated with the expression
      See Also:

    • addFunctions

      public void addFunctions(Function... functions)
      Adds functions (variadic parameters) to the expression definition.
      Parameters:
      functions - the functions (variadic parameters) comma separated list
      See Also:

    • defineFunction

      public void defineFunction(String functionName, String functionExpressionString, String... argumentsNames)
      Enables to define the function (associated with the expression) based on the function name, function expression string and arguments names (variadic parameters).
      Parameters:
      functionName - the function name
      functionExpressionString - the expression string
      argumentsNames - the function arguments names (variadic parameters) comma separated list
      See Also:

    • getFunctionIndex

      public int getFunctionIndex(String functionName)
      Gets index of function associated with the expression.
      Parameters:
      functionName - the function name
      Returns:
      Function index if function name was found, otherwise returns Function.NOT_FOUND
      See Also:

    • getFunction

      public Function getFunction(String functionName)
      Gets function associated with the expression.
      Parameters:
      functionName - the function name
      Returns:
      Function if function name was found, otherwise returns null.
      See Also:

    • getFunction

      public Function getFunction(int functionIndex)
      Gets function associated with the expression.
      Parameters:
      functionIndex - the function index
      Returns:
      Function if function index is between 0 and the last available function index (getFunctionsNumber()-1), otherwise returns null.
      See Also:

    • getFunctionsNumber

      public int getFunctionsNumber()
      Gets number of functions associated with the expression.
      Returns:
      number of functions (int >= 0)
      See Also:

    • removeFunctions

      public void removeFunctions(String... functionsNames)
      Removes first occurrences of the functions associated with the expression.
      Parameters:
      functionsNames - the functions names (variadic parameters) comma separated list
      See Also:

    • removeFunctions

      public void removeFunctions(Function... functions)
      Removes first occurrences of the functions associated with the expression.
      Parameters:
      functions - the functions (variadic parameters) comma separated list.
      See Also:

    • removeAllFunctions

      public void removeAllFunctions()
      Removes all functions associated with the expression.
      See Also:

    • checkLexSyntax

      public boolean checkLexSyntax()
      Checks syntax of the expression string.
      Returns:
      true if syntax is ok

    • checkSyntax

      public boolean checkSyntax()
      Checks syntax of the expression string.
      Returns:
      true if syntax is ok

    • calculate

      public double calculate()
      Calculates the expression value
      Returns:
      The expression value if syntax was ok, otherwise returns Double.NaN.

    • getCopyOfInitialTokens

      public List<Token> getCopyOfInitialTokens()
      Tokenizes expression string and returns tokens list, including: string, type, level.
      Returns:
      Copy of initial tokens.
      See Also:

    • getMissingUserDefinedArguments

      public String[] getMissingUserDefinedArguments()
      Returns missing user defined arguments names, i.e. sin(x) + cos(y) where x and y are not defined function will return x and y.
      Returns:
      Array of missing user defined arguments names - distinct strings.

    • getMissingUserDefinedUnits

      public String[] getMissingUserDefinedUnits()
      Returns missing user defined units names, i.e. 2*[w] + [q] where [w] and [q] are not defined function will return [w] and [q].
      Returns:
      Array of missing user defined units names - distinct strings.

    • getMissingUserDefinedFunctions

      public String[] getMissingUserDefinedFunctions()
      Returns missing user defined functions names, i.e. sin(x) + fun(x,y) where fun is not defined function will return fun.
      Returns:
      Array of missing user defined functions names - distinct strings.

    • getHelp

      public String getHelp()
      Gets help content.
      Returns:
      The help content.

    • getHelp

      public String getHelp(String word)
      Searching help content.
      Parameters:
      word - searching key word
      Returns:
      The help content.

    • getKeyWords

      public List<KeyWord> getKeyWords()
      Returns list of key words known to the parser
      Returns:
      List of keywords known to the parser.
      See Also:

    • getKeyWords

      public List<KeyWord> getKeyWords(String query)
      Returns list of key words known to the parser
      Parameters:
      query - Give any string to filter list of key words against this string. User more precise syntax: str=tokenString, desc=tokenDescription, syn=TokenSyntax, sin=tokenSince, wid=wordId, tid=wordTypeId to narrow the result.
      Returns:
      List of keywords known to the parser filter against query string.
      See Also:

    • clone

      protected Expression clone()
      Expression cloning.
      Overrides:
      clone in class Object