org.threadly.util

Class StatisticsUtils

java.lang.Object

org.threadly.util.StatisticsUtils

public class StatisticsUtils
extends java.lang.Object

Utilities for getting some basic statistics out of numerical data collections.

Since:

4.5.0

Constructor Summary

Constructors

Constructor and Description
StatisticsUtils()

Method Summary

Modifier and Type	Method and Description
static double	getAverage(java.util.Collection<? extends java.lang.Number> list) Calculates the average from a collection of numeric values.
static <T extends java.lang.Number> java.util.Map<java.lang.Double,T>	getPercentiles(java.util.Collection<? extends T> values, double... percentiles) Gets percentile values from a collection of numeric values.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatisticsUtils

public StatisticsUtils()

Method Detail

getAverage

public static double getAverage(java.util.Collection<? extends java.lang.Number> list)

Calculates the average from a collection of numeric values.

Parameters:

list - List of numbers to average against

Returns:

Zero if the list is empty, otherwise the average of the values inside the list

getPercentiles

public static <T extends java.lang.Number> java.util.Map<java.lang.Double,T> getPercentiles(java.util.Collection<? extends T> values,
                                                                                            double... percentiles)

Gets percentile values from a collection of numeric values. This function is NOT dependent on the collection already being sorted. This function accepts any decimal percentile between zero and one hundred, but requests for 99.9 and 99.99 may return the same result if the sample set is not large or varied enough. There is no attempt to extrapolate trends, thus only real samples are returned.

The returned map's keys correspond exactly to the percentiles provided. Iterating over the returned map will iterate in order of the requested percentiles as well.

Type Parameters:

T - Specific number type contained in the collection

Parameters:

values - A non-empty collection of numbers to examine for percentiles

percentiles - Percentiles requested, any decimal values between 0 and 100 (inclusive)

Returns:

Map with keys being the percentiles requested in the second argument