com.comphenix.protocol.timing

Class StatisticsStream

java.lang.Object

com.comphenix.protocol.timing.OnlineComputation

com.comphenix.protocol.timing.StatisticsStream

public class StatisticsStream
extends OnlineComputation

Represents an online algortihm for computing the mean and standard deviation without storing every value.

Author:

Kristian

Constructor Summary

Constructors

Constructor and Description
StatisticsStream() Construct a new stream with no observations.
StatisticsStream(StatisticsStream other) Construct a copy of the given stream.

Method Summary

Methods

Modifier and Type	Method and Description
StatisticsStream	add(StatisticsStream other) Combine the two statistics.
StatisticsStream	copy() Construct a copy of the current online computation.
int	getCount() Retrieve the number of observations.
double	getMaximum() Retrieve the maximum observation yet observed.
double	getMean() Retrieve the average of all the observations.
double	getMinimum() Retrieve the minimum observation yet observed.
double	getStandardDeviation() Retrieve the standard deviation of all the observations.
double	getVariance() Retrieve the variance of all the observations.
void	observe(double value) Observe a value.
java.lang.String	toString()

Methods inherited from class com.comphenix.protocol.timing.OnlineComputation

synchronizedComputation

Methods inherited from class java.lang.Object

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

Constructor Detail

StatisticsStream

public StatisticsStream()

Construct a new stream with no observations.

StatisticsStream

public StatisticsStream(StatisticsStream other)

Construct a copy of the given stream.

Parameters:

other - - copy of the stream.

Method Detail

copy

public StatisticsStream copy()

Description copied from class: OnlineComputation

Construct a copy of the current online computation.

Specified by:

copy in class OnlineComputation

Returns:

The new copy.

observe

public void observe(double value)

Observe a value.

Specified by:

observe in class OnlineComputation

Parameters:

value - - the observed value.

getMean

public double getMean()

Retrieve the average of all the observations.

Returns:

The average.

getVariance

public double getVariance()

Retrieve the variance of all the observations.

Returns:

The variance.

getStandardDeviation

public double getStandardDeviation()

Retrieve the standard deviation of all the observations.

Returns:

The STDV.

getMinimum

public double getMinimum()

Retrieve the minimum observation yet observed.

Returns:

The minimum observation.

getMaximum

public double getMaximum()

Retrieve the maximum observation yet observed.

Returns:

The maximum observation.

add

public StatisticsStream add(StatisticsStream other)

Combine the two statistics.

Parameters:

other - - the other statistics.

getCount

public int getCount()

Retrieve the number of observations.

Specified by:

getCount in class OnlineComputation

Returns:

Number of observations.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object