java.lang.Object

studio.magemonkey.codex.util.eval.javaluator.AbstractEvaluator<Double>

studio.magemonkey.codex.util.eval.javaluator.DoubleEvaluator

All Implemented Interfaces:: EvaluationContext

public class DoubleEvaluator extends AbstractEvaluator<Double>

An evaluator that is able to evaluate arithmetic expressions on real numbers.
Built-in operators:

+: Addition
-: Subtraction
-: Unary minus
*: Multiplication
/: Division
^: Exponentiation.
Warning: Exponentiation is implemented using java.lang.Math.pow which has some limitations (please read oracle documentation about this method to known details).
For example (-1)^(1/3) returns NaN.
%: Modulo

Built-in functions:

abs: absolute value
acos: arc cosine
asin: arc sine
atan: arc tangent
average: average of arguments
ceil: nearest upper integer
cos: cosine
cosh: hyperbolic cosine
floor: nearest lower integer
ln: natural logarithm (base e)
log: base 10 logarithm
max: maximum of arguments
min: minimum of arguments
round: nearest integer
sin: sine
sinh: hyperbolic sine
sum: sum of arguments
tan: tangent
tanh: hyperbolic tangent
random: pseudo-random number (between 0 and 1)

Built-in constants:

e: Base of natural algorithms
pi: Ratio of the circumference of a circle to its diameter

Author:

Jean-Marc Astesana

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

DoubleEvaluator.Style

The order or operations (operator precedence) is not clearly defined, especially between the unary minus operator and exponentiation operator (see http://en.wikipedia.org/wiki/Order_of_operations).
Field Summary

Fields

Modifier and Type

Field

Description

static final Function

ABS

Returns the absolute value of a number

static final Function

ACOSINE

Returns the trigonometric arc-cosine of an angle.

static final Function

ASINE

Returns the trigonometric arc-sine of an angle.

static final Function

ATAN

Returns the trigonometric arc-tangent of an angle.

static final Function

AVERAGE

Returns the average of n numbers (n>=1)

static final Function

CEIL

Returns the smallest integer >= argument

static final Function

COSINE

Returns the trigonometric cosine of an angle.

static final Function

COSINEH

Returns the hyperbolic cosine of a number.

static final Operator

DIVIDE

The division operator.

static final Constant

E

A constant that represents e (2.718281...)

static final Operator

EXPONENT

The exponentiation operator.

static final Function

FLOOR

Returns the largest integer <= argument

static final Function

LN

Returns the natural logarithm of a number

static final Function

LOG

Returns the decimal logarithm of a number

static final Function

MAX

Returns the maximum of n numbers (n>=1)

static final Function

MIN

Returns the minimum of n numbers (n>=1)

static final Operator

MINUS

The substraction operator.

static final Operator

MODULO

The modulo operator.

static final Operator

MULTIPLY

The multiplication operator.

static final Operator

NEGATE

The negate unary operator in the standard operator precedence.

static final Operator

NEGATE_HIGH

The negate unary operator in the Excel like operator precedence.

static final Constant

PI

A constant that represents pi (3.14159...)

static final Operator

PLUS

The addition operator.

static final Function

RANDOM

Returns a pseudo random number

static final Function

ROUND

Returns the closest integer of a number

static final Function

SINE

Returns the trigonometric sine of an angle.

static final Function

SINEH

Returns the hyperbolic sine of a number.

static final Function

SQRT

Returns the square root of a number

static final Function

SUM

Returns the sum of n numbers (n>=1)

static final Function

TANGENT

Returns the trigonometric tangent of an angle.

static final Function

TANGENTH

Returns the hyperbolic tangent of a number.

Fields inherited from class studio.magemonkey.codex.util.eval.javaluator.AbstractEvaluator
constants, expressionBrackets, functionArgumentSeparator, functionBrackets, functions, operators, tokenizer
Constructor Summary

Constructors

Constructor

Description

DoubleEvaluator()

Constructor.

DoubleEvaluator(Parameters parameters)

Constructor.
Method Summary

Modifier and Type

Method

Description

protected Double

evaluate(Constant constant, EvaluationContext evaluationContext)

Evaluates a constant.

protected Double

evaluate(Function function, Iterator<Double> arguments, EvaluationContext evaluationContext)

Evaluates a function.

protected Double

evaluate(Operator operator, Iterator<Double> operands, EvaluationContext evaluationContext)

Evaluates an operation.

static Parameters

getDefaultParameters()

Gets a copy of DoubleEvaluator standard default parameters.

static Parameters

getDefaultParameters(DoubleEvaluator.Style style)

Gets a copy of DoubleEvaluator default parameters.

protected Double

toValue(Token literalTok, EvaluationContext evaluationContext)

Evaluates a literal (Converts it to a value).

Methods inherited from class studio.magemonkey.codex.util.eval.javaluator.AbstractEvaluator
doFunction, evaluate, evaluate, getArguments, getBracketPair, getConstants, getFunctions, getOperators, output, tokenize

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

Methods inherited from interface studio.magemonkey.codex.util.eval.javaluator.EvaluationContext
getError, getError

Field Details
- PI
  
  public static final Constant PI
  
  A constant that represents pi (3.14159...)
- E
  
  public static final Constant E
  
  A constant that represents e (2.718281...)
- CEIL
  
  public static final Function CEIL
  
  Returns the smallest integer >= argument
- FLOOR
  
  public static final Function FLOOR
  
  Returns the largest integer <= argument
- ROUND
  
  public static final Function ROUND
  
  Returns the closest integer of a number
- ABS
  
  public static final Function ABS
  
  Returns the absolute value of a number
- SINE
  
  public static final Function SINE
  
  Returns the trigonometric sine of an angle. The angle is expressed in radian.
- COSINE
  
  public static final Function COSINE
  
  Returns the trigonometric cosine of an angle. The angle is expressed in radian.
- TANGENT
  
  public static final Function TANGENT
  
  Returns the trigonometric tangent of an angle. The angle is expressed in radian.
- ACOSINE
  
  public static final Function ACOSINE
  
  Returns the trigonometric arc-cosine of an angle. The angle is expressed in radian.
- ASINE
  
  public static final Function ASINE
  
  Returns the trigonometric arc-sine of an angle. The angle is expressed in radian.
- ATAN
  
  public static final Function ATAN
  
  Returns the trigonometric arc-tangent of an angle. The angle is expressed in radian.
- SINEH
  
  public static final Function SINEH
  
  Returns the hyperbolic sine of a number.
- COSINEH
  
  public static final Function COSINEH
  
  Returns the hyperbolic cosine of a number.
- TANGENTH
  
  public static final Function TANGENTH
  
  Returns the hyperbolic tangent of a number.
- MIN
  
  public static final Function MIN
  
  Returns the minimum of n numbers (n>=1)
- MAX
  
  public static final Function MAX
  
  Returns the maximum of n numbers (n>=1)
- SUM
  
  public static final Function SUM
  
  Returns the sum of n numbers (n>=1)
- AVERAGE
  
  public static final Function AVERAGE
  
  Returns the average of n numbers (n>=1)
- LN
  
  public static final Function LN
  
  Returns the natural logarithm of a number
- LOG
  
  public static final Function LOG
  
  Returns the decimal logarithm of a number
- SQRT
  
  public static final Function SQRT
  
  Returns the square root of a number
- RANDOM
  
  public static final Function RANDOM
  
  Returns a pseudo random number
- NEGATE
  
  public static final Operator NEGATE
  
  The negate unary operator in the standard operator precedence.
- NEGATE_HIGH
  
  public static final Operator NEGATE_HIGH
  
  The negate unary operator in the Excel like operator precedence.
- MINUS
  
  public static final Operator MINUS
  
  The substraction operator.
- PLUS
  
  public static final Operator PLUS
  
  The addition operator.
- MULTIPLY
  
  public static final Operator MULTIPLY
  
  The multiplication operator.
- DIVIDE
  
  public static final Operator DIVIDE
  
  The division operator.
- EXPONENT
  
  public static final Operator EXPONENT
  
  The exponentiation operator.
- MODULO
  
  public static final Operator MODULO
  
  The modulo operator.
Constructor Details
- DoubleEvaluator
  
  public DoubleEvaluator()
  
  Constructor.
  This default constructor builds an instance with all predefined operators, functions and constants.
- DoubleEvaluator
  
  public DoubleEvaluator(Parameters parameters)
  
  Constructor.
  This constructor can be used to reduce the set of supported operators, functions or constants, or to localize some function or constant's names.
  
  Parameters:
  
  parameters - The parameters of the evaluator.
Method Details
- getDefaultParameters
  
  public static Parameters getDefaultParameters()
  
  Gets a copy of DoubleEvaluator standard default parameters.
  The returned parameters contains all the predefined operators, functions and constants.
  Each call to this method create a new instance of Parameters.
  Returns:
  
  a Paramaters instance
  
  See Also:
  
  DoubleEvaluator.Style
- getDefaultParameters
  
  public static Parameters getDefaultParameters(DoubleEvaluator.Style style)
  
  Gets a copy of DoubleEvaluator default parameters.
  The returned parameters contains all the predefined operators, functions and constants.
  Each call to this method create a new instance of Parameters.
  
  Returns:
  
  a Paramaters instance
- toValue
  
  protected Double toValue(Token literalTok, EvaluationContext evaluationContext)
  
  Description copied from class: AbstractEvaluator
  
  Evaluates a literal (Converts it to a value).
  
  Specified by:
  
  toValue in class AbstractEvaluator<Double>
  
  Parameters:
  
  literalTok - The literal to evaluate.
  
  evaluationContext - The context of the evaluation
  
  Returns:
  
  an instance of T.
- evaluate
  
  protected Double evaluate(Constant constant, EvaluationContext evaluationContext)
  
  Description copied from class: AbstractEvaluator
  
  Evaluates a constant.
  Subclasses that support constants must override this method. The default implementation throws a RuntimeException meaning that implementor forget to implement this method while creating a subclass that accepts constants.
  
  Overrides:
  
  evaluate in class AbstractEvaluator<Double>
  
  Parameters:
  
  constant - The constant
  
  evaluationContext - The context of the evaluation
  
  Returns:
  
  The constant's value
- evaluate
  
  protected Double evaluate(Operator operator, Iterator<Double> operands, EvaluationContext evaluationContext)
  
  Description copied from class: AbstractEvaluator
  
  Evaluates an operation.
  Subclasses that support operators must override this method. The default implementation throws a RuntimeException meaning that implementor forget to implement this method while creating a subclass that accepts operators.
  
  Overrides:
  
  evaluate in class AbstractEvaluator<Double>
  
  Parameters:
  
  operator - The operator
  
  operands - The operands
  
  evaluationContext - The context of the evaluation
  
  Returns:
  
  The result of the operation
- evaluate
  
  protected Double evaluate(Function function, Iterator<Double> arguments, EvaluationContext evaluationContext)
  
  Description copied from class: AbstractEvaluator
  
  Evaluates a function.
  Subclasses that support functions must override this method. The default implementation throws a RuntimeException meaning that implementor forget to implement this method while creating a subclass that accepts functions.
  
  Overrides:
  
  evaluate in class AbstractEvaluator<Double>
  
  Parameters:
  
  function - The function
  
  arguments - The function's arguments
  
  evaluationContext - The context of the evaluation
  
  Returns:
  
  The result of the function

Class DoubleEvaluator

Nested Class Summary

Field Summary

Fields inherited from class studio.magemonkey.codex.util.eval.javaluator.AbstractEvaluator

Constructor Summary

Method Summary

Methods inherited from class studio.magemonkey.codex.util.eval.javaluator.AbstractEvaluator

Methods inherited from class java.lang.Object

Methods inherited from interface studio.magemonkey.codex.util.eval.javaluator.EvaluationContext

Field Details

PI

E

CEIL

FLOOR

ROUND

ABS

SINE

COSINE

TANGENT

ACOSINE

ASINE

ATAN

SINEH

COSINEH

TANGENTH

MIN

MAX

SUM

AVERAGE

LN

LOG

SQRT

RANDOM

NEGATE

NEGATE_HIGH

MINUS

PLUS

MULTIPLY

DIVIDE

EXPONENT

MODULO

Constructor Details

DoubleEvaluator

DoubleEvaluator

Method Details

getDefaultParameters

getDefaultParameters

toValue

evaluate

evaluate

evaluate