Expression (common 2.5 API)

java.lang.Object
- com.elikill58.negativity.api.maths.Expression

```
public class Expression
extends Object
```
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.

Constructor Summary

Constructors
Constructor and Description

Expression(String expressionString)
Constructor - creates new expression from expression string.

Constructors
Constructor and Description
`Expression(String expressionString)` Constructor - creates new expression from expression string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`calculate()` Calculates the expression value
`boolean`	`checkSyntax()` Checks syntax of the expression string.
`protected Expression`	`clone()` Expression cloning.
`double`	`getComputingTime()` Gets computing time.
`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
`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. sin(x) + cos(y) where x and y are not defined function will return x and y.
`String[]`	`getMissingUserDefinedFunctions()` Returns missing user defined functions names, i.e. sin(x) + fun(x,y) where fun is not defined function will return fun.
`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`	`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 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Expression
```
public Expression(String expressionString)
```
    Constructor - creates new expression from expression string.
    
    Parameters:
    
    expressionString - definition of the expression
- 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.
  - setDescription
```
public void setDescription(String description)
```
    Sets expression description.
    
    Parameters:
    
    description - the description string
  - getDescription
```
public String getDescription()
```
    Gets expression description.
    
    Returns:
    
    String 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.
  - 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
  - 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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Expression

Method Detail

getErrorMessage

getSyntaxStatus

setExpressionString

getExpressionString

setDescription

getDescription

setVerboseMode

setSilentMode

getVerboseMode

getRecursiveMode

getComputingTime

checkSyntax

calculate

getCopyOfInitialTokens

getMissingUserDefinedArguments

getMissingUserDefinedUnits

getMissingUserDefinedFunctions

getHelp

getHelp

getKeyWords

getKeyWords

clone