Analytics
Also available as:

​Distributional Statistics

Table 6.3. Distributional Statistics

FunctionDescriptionInputReturns
STATS_ADDAdds one or more input values to those that are used to calculate the summary statistics.
• stats - The Stellar statistics object. If null, then a new one is initialized.

• value+ - One or more numbers to add

A Stellar statistics object
STATS_BINComputes the bin that the value is in based on the statistical distribution.
• stats - The Stellar statistics object

• value - The value to bin

• bounds? - A list of percentile bin bounds (excluding min and max) or a string representing a known and common set of bins. For convenience, we have provided QUARTILE, QUINTILE, and DECILE which you can pass in as a string arg. If this argument is omitted, then we assume a Quartile bin split.

Which bin N the value falls in such that bound(N-1) < value <= bound(N). No min and max bounds are provided, so values smaller than the 0'th bound go in the 0'th bin, and values greater than the last bound go in the M'th bin.
STATS_COUNTCalculates the count of the values accumulated (or in the window if a window is used).
• stats - The Stellar statistics object

The count of the values in the window or NaN if the statistics object is null
STATS_GEOMETRIC_MEANCalculates the geometric mean of the accumulated values (or in the window if a window is used). See http://commons.apache.org/proper/commons-math/userguide/stat.html#a1.2_Descriptive_statistics
• stats - The Stellar statistics object

The geometric mean of the values in the window or NaN if the statistics object is null.
STATS_INITInitializes a statistics object
• window size - The number of input data values to maintain in a rolling window in memory. If window_size is equal to 0, then no rolling window is maintained. Using no rolling window is less memory intensive, but cannot calculate certain statistics like percentiles and kurtosis.

A Stellar statistics object
STATS_KURTOSISCalculates the kurtosis of the accumulated values (or in the window if a window is used). See http://commons.apache.org/proper/commons-math/userguide/stat.html#a1.2_Descriptive_statistics
• stats - The Stellar statistics object

The kurtosis of the values in the window or NaN if the statistics object is null
STATS_MAXCalculates the maximum of the accumulated values (or in the window if a window is used).
• stats - The Stellar statistics object

The maximum of the accumulated values in the window or NaN if the statistics object is null.
STATS_MEANCalculates the mean of the accumulated values (or in the window if a window is used).
• stats - The Stellar statistics object

The mean of the values in the window or NaN if the statistics object is null.
STATS_MERGEMerges statistics objects
• statistics -A list of statistics objects

A Stellar statistics object
STATS_MINCalculates the minimum of the accumulated values (or in the window if a window is used).
• stats - The Stellar statistics object

The minimum of the accumulated values in the window or NaN if the statistics object is null.
STATS_PERCENTILEComputes the p'th percentile of the accumulated values (or in the window if a window is used).
• stats - The Stellar statistics object

• p - A double where 0 <= p < 1 representing the percentile

The p'th percentile of the data or NaN if the statistics object is null
STATS_POPULATION_VARIANCECalculates the population variance of the accumulated values (or in the window if a window is used). See http://commons.apache.org/proper/commons-math/userguide/stat.html#a1.2_Descriptive_statistics
• stats - The Stellar statistics object

The population variance of the values in the window or NaN if the statistics object is null.
STATS_QUADRATIC_MEANCalculates the quadratic mean of the accumulated values (or in the window if a window is used). See http://commons.apache.org/proper/commons-math/userguide/stat.html#a1.2_Descriptive_statistics
• stats - The Stellar statistics object

The quadratic mean of the values in the window or NaN if the statistics object is null.
STATS_SDCalculates the standard deviation of the accumulated values (or in the window if a window is used). See http://commons.apache.org/proper/commons-math/userguide/stat.html#a1.2_Descriptive_statistics
• stats - The Stellar statistics object

The standard deviation of the values in the window or NaN if the statistics object is null.
STATS_SKEWNESSCalculates the skewness of the accumulated values (or in the window if a window is used). See http://commons.apache.org/proper/commons-math/userguide/stat.html#a1.2_Descriptive_statistics
• stats - The Stellar statistics object

The skewness of the values in the window or NaN if the statistics object is null.
STATS_SUMCalculates the sum of the accumulated values (or in the window if a window is used).
• stats - The Stellar statistics object

The sum of the values in the window or NaN if the statistics object is null.
STATS_SUM_LOGSCalculates the sum of the (natural) log of the accumulated values (or in the window if a window is used). See http://commons.apache.org/proper/commons-math/userguide/stat.html#a1.2_Descriptive_statistics
• stats - The Stellar statistics object

The sum of the (natural) log of the values in the window or NaN if the statistics object is null.
STATS_SUM_SQUARESCalculates the sum of the squares of the accumulated values (or in the window if a window is used).
• stats - The Stellar statistics object

The sum of the squares of the values in the window or NaN if the statistics object is null.
STATS_VARIANCECalculates the variance of the accumulated values (or in the window if a window is used). See http://commons.apache.org/proper/commons-math/userguide/stat.html#a1.2_Descriptive_statistics
• stats - The Stellar statistics object

The variance of the values in the window or NaN if the statistics object is null.