org.mitre.poorMan.javaTiming

Class Statistic

java.lang.Object

org.mitre.poorMan.javaTiming.Statistic

Direct Known Subclasses:

MemoryWatch, StopWatch

public class Statistic
extends java.lang.Object

Implements the math for computing average, standard deviation, and coefficient of variation. Not thread-safe. It is expected that only one thread is manipulating a statistic.

Version:

1.2

Author:

Nazario Irizarry

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.atomic.AtomicInteger	count
protected boolean	enableMinMax
protected boolean	enableStdDev

Constructor Summary

Constructors

Constructor and Description
Statistic()

Method Summary

Methods

Modifier and Type	Method and Description
void	addCount(int c) Add to the accumulated count.
void	addDelta(double delta) Add to the cumulative and increments the count.
void	addDelta(double delta, int n) Add to the cumulative and increments the count.
void	addDelta(long delta) Add to the cumulative and increments the count.
void	addDelta(long delta, int n) Add to the cumulative and increments the count.
protected Statistic	enableMinMax() Enable tracking of min and max.
protected Statistic	enableStdDev() Enable computation of standard deviation.
double	getAvg()
double	getCoefOfVariation() Compute the coefficient of variation.
int	getCount()
double	getCumulative() Get the accumulated value.
double	getMax()
double	getMin()
double	getStdDev()
void	reset() Resets numbers.

Methods inherited from class java.lang.Object

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

Field Detail

count

protected final java.util.concurrent.atomic.AtomicInteger count

enableStdDev

protected boolean enableStdDev

enableMinMax

protected boolean enableMinMax

Constructor Detail

Statistic

public Statistic()

Method Detail

addCount

public final void addCount(int c)

Add to the accumulated count. This method is thread-safe.

Parameters:

c -

addDelta

public final void addDelta(long delta)

Add to the cumulative and increments the count. Optionally add to higher order statistics.

addDelta

public final void addDelta(double delta)

Add to the cumulative and increments the count. Optionally add to higher order statistics.

addDelta

public final void addDelta(long delta,
            int n)

Add to the cumulative and increments the count. Optionally add to higher order statistics.

Parameters:

delta - to add to the statistic

n - amount to add to the count

addDelta

public final void addDelta(double delta,
            int n)

Add to the cumulative and increments the count. Optionally add to higher order statistics.

Parameters:

delta - to add

n - amount to add to the count

getAvg

public final double getAvg()

Returns:

Return the average. If the count is zero then 0 is returned.

getCoefOfVariation

public final double getCoefOfVariation()

Compute the coefficient of variation.

See Also:

Coefficient of variation

getCount

public final int getCount()

getCumulative

public final double getCumulative()

Get the accumulated value.

getStdDev

public final double getStdDev()

Returns:

The standard deviation. If the count is <= 1 then Double.Nan is returned.

getMin

public final double getMin()

getMax

public final double getMax()

reset

public final void reset()

Resets numbers. Does not reset enableStandardDeviationComputation or enableMinMax.

enableStdDev

protected Statistic enableStdDev()

Enable computation of standard deviation.

Returns:

instance of this

enableMinMax

protected Statistic enableMinMax()

Enable tracking of min and max.

Returns:

instance of this