es.uam.eps.ir.ranksys.core.util

Class Stats

java.lang.Object

es.uam.eps.ir.ranksys.core.util.Stats

public class Stats
extends Object

Calculate common statistics for samples of doubles

Author:

Saúl Vargas (saul.vargas@uam.es)

Constructor Summary

Constructors

Constructor and Description
Stats() Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(double x) Adds a value and updates the statistics.
void	combine(Stats o) Combines the statistics for another sample into this.
double	getMax() Returns the greatest value of the sample.
double	getMean() Returns the mean of the sample.
double	getMin() Returns the smallest value of the sample.
long	getN() Returns the size of the sample.
double	getStandardDeviation() Returns the standard deviation of the sample.
double	getVariance() Returns the variance of the sample.
void	reset() Resets the Stats object (as it had just been created).

Methods inherited from class java.lang.Object

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

Constructor Detail

Stats

public Stats()

Constructor.

Method Detail

accept

public void accept(double x)

Adds a value and updates the statistics. If the input value is a NaN, it is ignored.

Parameters:

x - value to be added

combine

public void combine(Stats o)

Combines the statistics for another sample into this. This is useful for performing mutable reductions (Stream.collect). Unfortunately, the current implementation cannot combine the variances of the samples.

Parameters:

o - statistics of other sample

getN

public long getN()

Returns the size of the sample.

Returns:

size of the sample

getMean

public double getMean()

Returns the mean of the sample.

Returns:

mean

getVariance

public double getVariance()

Returns the variance of the sample.

Returns:

variance

getStandardDeviation

public double getStandardDeviation()

Returns the standard deviation of the sample.

Returns:

standard deviation

getMax

public double getMax()

Returns the greatest value of the sample.

Returns:

maximum value

getMin

public double getMin()

Returns the smallest value of the sample.

Returns:

minimum value

reset

public void reset()

Resets the Stats object (as it had just been created).