sirius.kernel.health

Class Average

java.lang.Object

sirius.kernel.health.Average

public class Average
extends Object

Represents an average value over a given set of values.

Using the maxSamples can be used to implement something like a sliding avarage as the value is reset (computed) once the counter hits maxSamples.

Constructor Summary

Constructors

Constructor and Description
Average() Creates a new average which averages up to DEFAULT_MAX_SAMPLES and then computes the effective avarage and resets the counter to 1 using that value.
Average(long maxSamples) Creates a new average which averages up to maxSamples and then computes the effective avarage and resets the counter to 1 using that value.

Method Summary

Modifier and Type	Method and Description
void	addValue(double value) Adds the given value to the set of values on which the average is based.
void	addValue(long value) Adds the given value to the set of values on which the average is based.
void	addValues(long numberOfValues, double sumOfValue) Adds the given number of values to the counter and increments the sum by the given delta.
double	getAndClear() Returns the average just like getAvg() but then resets the internal buffers to zero.
double	getAvg() Returns the average of the added values.
long	getCount() Returns the number of total values inserted in the average.
long	getSampleCount() Returns the number of values used to compute the average.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Average

public Average()

Creates a new average which averages up to DEFAULT_MAX_SAMPLES and then computes the effective avarage and resets the counter to 1 using that value.

Average

public Average(long maxSamples)

Creates a new average which averages up to maxSamples and then computes the effective avarage and resets the counter to 1 using that value.

Method Detail

addValue

public void addValue(long value)

Adds the given value to the set of values on which the average is based.

If the sum of all values is greater as Double.MAX_VALUE / 2 or the count of all values is greater as Long.Max_VALUE / 2, the average is resetted.

Parameters:

value - to value to add to the average

addValue

public void addValue(double value)

Adds the given value to the set of values on which the average is based.

If the sum of all values is greater as Double.MAX_VALUE / 2 or the count of all values is greater as Long.Max_VALUE / 2, the average is resetted.

Parameters:

value - to value to add to the average

addValues

public void addValues(long numberOfValues,
                      double sumOfValue)

Adds the given number of values to the counter and increments the sum by the given delta.

Parameters:

numberOfValues - the number of values to add

sumOfValue - the total sum of the values to add

getAvg

public double getAvg()

Returns the average of the added values.

Returns the sliding average of the last 100 values

Returns:

the average of the added values

getAndClear

public double getAndClear()

Returns the average just like getAvg() but then resets the internal buffers to zero.

Returns:

the average of the last 100 values

getSampleCount

public long getSampleCount()

Returns the number of values used to compute the average.

Returns:

the number of value which will be considered when computing the average.

getCount

public long getCount()

Returns the number of total values inserted in the average.

Returns:

the number of total values inserted in the average

toString

public String toString()

Overrides:

toString in class Object