Expression (MathParser.org-mXparser - Math Expressions Parser / Formula Evaluator library for JAVA Android C# .NET/MONO CLS compliant 4.4.2 API)

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

Author:

Mariusz Gromada
mariuszgromada.org@gmail.com
MathSpace.pl
MathParser.org - mXparser project page
mXparser on GitHub
mXparser on SourceForge
mXparser on Bitbucket
mXparser on CodePlex
Janet Sudoku - project web page
Janet Sudoku on GitHub
Janet Sudoku on CodePlex
Janet Sudoku on SourceForge
Janet Sudoku on BitBucket
Scalar Free
Scalar Pro
ScalarMath.org

See Also:

Argument, RecursiveArgument, Constant, Function

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`NO_SYNTAX_ERRORS` Status of the Expression syntax
`static boolean`	`SYNTAX_ERROR_OR_STATUS_UNKNOWN`
`static String`	`TYPE_DESC`
`static int`	`TYPE_ID` Expression type id

Constructor Summary

Constructors
Constructor and Description
`Expression(PrimitiveElement... elements)` Default constructor - empty expression
`Expression(String expressionString, PrimitiveElement... elements)` Constructor - creates new expression from expression string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addArguments(Argument... arguments)` Adds arguments (variadic) to the expression definition.
`void`	`addConstants(Constant... constants)` Adds constants (variadic parameters) to the expression definition.
`void`	`addConstants(List<Constant> constantsList)` Adds constants to the expression definition.
`void`	`addDefinitions(PrimitiveElement... elements)` Adds user defined elements (such as: Arguments, Constants, Functions) to the expressions.
`void`	`addFunctions(Function... functions)` Adds functions (variadic parameters) to the expression definition.
`double`	`calculate()` Calculates the expression value
`boolean`	`checkLexSyntax()` Checks syntax of the expression string.
`boolean`	`checkSyntax()` Checks syntax of the expression string.
`void`	`clearDescription()` Clears expression description
`void`	`clearExpressionString()` Clears expression string
`protected Expression`	`clone()` Expression cloning.
`void`	`defineArgument(String argumentName, double argumentValue)` Enables to define the argument (associated with the expression) based on the argument name and the argument value.
`void`	`defineArguments(String... argumentsNames)` Enables to define the arguments (associated with the expression) based on the given arguments names.
`void`	`defineConstant(String constantName, double constantValue)` Enables to define the constant (associated with the expression) based on the constant name and constant value.
`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).
`Argument`	`getArgument(int argumentIndex)` Gets argument from the expression.
`Argument`	`getArgument(String argumentName)` Gets argument from the expression.
`int`	`getArgumentIndex(String argumentName)` Gets argument index from the expression.
`int`	`getArgumentsNumber()` Gets number of arguments associated with the expression.
`double`	`getArgumentValue(String argumentName)` Gets argument vale.
`double`	`getComputingTime()` Gets computing time.
`Constant`	`getConstant(int constantIndex)` Gets constant associated with the expression.
`Constant`	`getConstant(String constantName)` Gets constant associated with the expression.
`int`	`getConstantIndex(String constantName)` Gets constant index associated with the expression.
`int`	`getConstantsNumber()` Gets number of constants associated with the expression.
`List<Token>`	`getCopyOfInitialTokens()` Tokenizes expression string and returns tokens list, including: string, type, level.
`String`	`getDescription()` Gets expression description.
`String`	`getErrorMessage()` Method return error message after calling checkSyntax() method or calculate().
`String`	`getExpressionString()` Returns expression string
`Function`	`getFunction(int functionIndex)` Gets function associated with the expression.
`Function`	`getFunction(String functionName)` Gets function associated with the expression.
`int`	`getFunctionIndex(String functionName)` Gets index of function associated with the expression.
`int`	`getFunctionsNumber()` Gets number of functions associated with the expression.
`String`	`getHelp()` Gets help content.
`String`	`getHelp(String word)` Searching help content.
`List<KeyWord>`	`getKeyWords()` Returns list of key words known to the parser
`List<KeyWord>`	`getKeyWords(String query)` Returns list of key words known to the parser
`String[]`	`getMissingUserDefinedArguments()` Returns missing user defined arguments names, i.e.
`String[]`	`getMissingUserDefinedFunctions()` Returns missing user defined functions names, i.e.
`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].
`boolean`	`getRecursiveMode()` Gets recursive mode status
`boolean`	`getSyntaxStatus()` Gets syntax status of the expression.
`boolean`	`getVerboseMode()` Returns verbose mode status.
`void`	`removeAllArguments()` Removes all arguments associated with the expression.
`void`	`removeAllConstants()` Removes all constants associated with the expression
`void`	`removeAllFunctions()` Removes all functions associated with the expression.
`void`	`removeArguments(Argument... arguments)` Removes first occurrences of the arguments associated with the expression.
`void`	`removeArguments(String... argumentsNames)` Removes first occurrences of the arguments associated with the expression.
`void`	`removeConstants(Constant... constants)` Removes first occurrences of the constants associated with the expression
`void`	`removeConstants(String... constantsNames)` Removes first occurrences of the constants associated with the expression.
`void`	`removeDefinitions(PrimitiveElement... elements)` Removes user defined elements (such as: Arguments, Constants, Functions) to the expressions.
`void`	`removeFunctions(Function... functions)` Removes first occurrences of the functions associated with the expression.
`void`	`removeFunctions(String... functionsNames)` Removes first occurrences of the functions associated with the expression.
`void`	`setArgumentValue(String argumentName, double argumentValue)` Sets argument value.
`void`	`setDescription(String description)` Sets expression description.
`void`	`setExpressionString(String expressionString)` Sets (modifies expression) expression string.
`void`	`setSilentMode()` Disables verbose mode (default silent mode).
`void`	`setVerboseMode()` Enables verbose mode.

Methods inherited from class org.mariuszgromada.math.mxparser.PrimitiveElement
getMyTypeId

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE_ID
```
public static final int TYPE_ID
```
    Expression type id
    
    See Also:
    
    Constant Field Values
  - TYPE_DESC
```
public static final String TYPE_DESC
```
    See Also:
    
    Constant Field Values
  - NO_SYNTAX_ERRORS
```
public static final boolean NO_SYNTAX_ERRORS
```
    Status of the Expression syntax
    
    See Also:
    
    Constant Field Values
  - SYNTAX_ERROR_OR_STATUS_UNKNOWN
```
public static final boolean SYNTAX_ERROR_OR_STATUS_UNKNOWN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Expression
```
public Expression(PrimitiveElement... elements)
```
    Default constructor - empty expression
    
    Parameters:
    
    elements - Optional elements list (variadic - comma separated) of types: Argument, Constant, Function
    
    See Also:
    
    PrimitiveElement
  - 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:
    
    PrimitiveElement
- Method Detail
  - 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:
    
    PrimitiveElement
  - 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:
    
    PrimitiveElement
  - addArguments
```
public void addArguments(Argument... arguments)
```
    Adds arguments (variadic) to the expression definition.
    
    Parameters:
    
    arguments - the arguments list (comma separated list)
    
    See Also:
    
    Argument, RecursiveArgument
  - 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:
    
    Argument, RecursiveArgument
  - 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:
    
    Argument, RecursiveArgument
  - 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:
    
    Argument, RecursiveArgument
  - 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:
    
    Argument, RecursiveArgument
  - 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:
    
    Argument, RecursiveArgument
  - getArgumentsNumber
```
public int getArgumentsNumber()
```
    Gets number of arguments associated with the expression.
    
    Returns:
    
    The number of arguments (int >= 0)
    
    See Also:
    
    Argument, RecursiveArgument
  - 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:
    
    Argument, RecursiveArgument
  - 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:
    
    Argument, RecursiveArgument
  - removeAllArguments
```
public void removeAllArguments()
```
    Removes all arguments associated with the expression.
    
    See Also:
    
    Argument, RecursiveArgument
  - addConstants
```
public void addConstants(Constant... constants)
```
    Adds constants (variadic parameters) to the expression definition.
    
    Parameters:
    
    constants - the constants (comma separated list)
    
    See Also:
    
    Constant
  - addConstants
```
public void addConstants(List<Constant> constantsList)
```
    Adds constants to the expression definition.
    
    Parameters:
    
    constantsList - the list of constants
    
    See Also:
    
    Constant
  - 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:
    
    Constant
  - 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:
    
    Constant
  - 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:
    
    Constant
  - 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:
    
    Constant
  - getConstantsNumber
```
public int getConstantsNumber()
```
    Gets number of constants associated with the expression.
    
    Returns:
    
    number of constants (int >= 0)
    
    See Also:
    
    Constant
  - 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:
    
    Constant
  - 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:
    
    Constant
  - removeAllConstants
```
public void removeAllConstants()
```
    Removes all constants associated with the expression
    
    See Also:
    
    Constant
  - 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:
    
    Function
  - 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:
    
    Function
  - 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:
    
    Function
  - 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:
    
    Function
  - 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:
    
    Function
  - getFunctionsNumber
```
public int getFunctionsNumber()
```
    Gets number of functions associated with the expression.
    
    Returns:
    
    number of functions (int >= 0)
    
    See Also:
    
    Function
  - 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:
    
    Function
  - 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:
    
    Function
  - removeAllFunctions
```
public void removeAllFunctions()
```
    Removes all functions associated with the expression.
    
    See Also:
    
    Function
  - 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:
    
    Token, mXparser.consolePrintTokens(List)
  - 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:
    
    KeyWord, KeyWord.wordTypeId, getHelp()
  - 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:
    
    KeyWord, KeyWord.wordTypeId, getHelp(String)
  - clone
```
protected Expression clone()
```
    Expression cloning.
    
    Overrides:
    
    clone in class Object

Class Expression

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.mariuszgromada.math.mxparser.PrimitiveElement

Methods inherited from class java.lang.Object

Field Detail

TYPE_ID

TYPE_DESC

NO_SYNTAX_ERRORS

SYNTAX_ERROR_OR_STATUS_UNKNOWN

Constructor Detail

Expression

Expression

Method Detail

getErrorMessage

getSyntaxStatus

setExpressionString

getExpressionString

clearExpressionString

setDescription

getDescription

clearDescription

setVerboseMode

setSilentMode

getVerboseMode

getRecursiveMode

getComputingTime

addDefinitions

removeDefinitions

addArguments

defineArguments

defineArgument

getArgumentIndex

getArgument

getArgument

getArgumentsNumber

setArgumentValue

getArgumentValue

removeArguments

removeArguments

removeAllArguments

addConstants

addConstants

defineConstant

getConstantIndex

getConstant

getConstant

getConstantsNumber

removeConstants

removeConstants

removeAllConstants

addFunctions

defineFunction

getFunctionIndex

getFunction

getFunction

getFunctionsNumber

removeFunctions

removeFunctions

removeAllFunctions

checkLexSyntax

checkSyntax

calculate

getCopyOfInitialTokens

getMissingUserDefinedArguments

getMissingUserDefinedUnits

getMissingUserDefinedFunctions

getHelp

getHelp

getKeyWords

getKeyWords

clone