Package com.singularsys.jep.functions

Class Average

java.lang.Object
com.singularsys.jep.functions.PostfixMathCommand
com.singularsys.jep.functions.ArrayFunctionBase
com.singularsys.jep.functions.Average
All Implemented Interfaces:
PostfixMathCommandI, RealUnaryFunction, Serializable
public class Average extends ArrayFunctionBase implements RealUnaryFunction
Average function class, calculates the average of all its arguments.

Since Jep 3.4 this function will flatten its arguments so avg([1,[2,3]]) will be 2.

Since:
3.1.0
See Also:

  • Field Details

    • add

      protected Add add
      Function used to add pairs of elements

    • div

      protected Divide div
      Function used to divide sum of elements by the number of elements

  • Constructor Details

    • Average

      public Average(Add add, Divide div)

    • Average

      public Average()

  • Method Details

    • calc

      protected Object calc(List<Object> v) throws EvaluationException
      Called by the run method, default is to call average(List) but subclasses can override.
      Specified by:
      calc in class ArrayFunctionBase
      Parameters:
      v - a list of objects to calculate the average of.
      Returns:
      result of calculation
      Throws:
      EvaluationException - if the calculation cannot be performed
      Since:
      3.4.0

    • average

      public Object average(List<Object> vals) throws EvaluationException
      Returns the average of a set of values. Depends on the Add and Divide classes to perform the calculation.
      Parameters:
      vals - Values to be averaged
      Returns:
      the average of the values
      Throws:
      EvaluationException - if the calculation cannot be performed

    • evaluate

      public double evaluate(double val)
      Just returns its argument.
      Specified by:
      evaluate in interface RealUnaryFunction