hirondelle.formula.function.builtin
Class ArithmeticMean

Object
  hirondelle.formula.function.builtin.ArithmeticMean

All Implemented Interfaces:

Function

public final class ArithmeticMean
extends Object
implements Function

avg(x1,x2,x3,...): the arithmetic mean of a set of numbers.

Constructor Summary

ArithmeticMean()

Method Summary

Decimal

calculate(Decimal... aArgs) Returns the average (arithmetic mean) of the given parameters.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArithmeticMean

public ArithmeticMean()

Method Detail

calculate

public Decimal calculate(Decimal... aArgs)

Returns the average (arithmetic mean) of the given parameters.

The number of parameters in this case (0..N) is not fixed. If no parameters are passed, then zero is returned. The parameters can be passed in any order.

Specified by:

calculate in interface Function

Parameters:

aArgs - 0 or more arguments to the function.