org.jgroups.util

Class Average

java.lang.Object

org.jgroups.util.Average

All Implemented Interfaces:

Streamable

Direct Known Subclasses:

AverageMinMax

public class Average
extends Object
implements Streamable

Maintains an approximation of an average of values. Done by keeping track of the number of samples, and computing the new average as (count*avg + new-sample) / ++count. We reset the count if count*avg would lead to an overflow.

Since:

3.4

Author:

Bela Ban

Field Summary

Fields

Modifier and Type	Field and Description
protected double	avg
protected long	count

Constructor Summary

Constructors

Constructor and Description
Average()

Method Summary

Modifier and Type	Method and Description
<T extends Average> T	add(long num)
double	average()
void	clear()
long	count()
double	getAverage()
long	getCount()
<T extends Average> T	merge(T other) Merges this average with another one
void	readFrom(DataInput in) Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
String	toString()
void	writeTo(DataOutput out) Write the entire state of the current object (including superclasses) to outstream.

Methods inherited from class java.lang.Object

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

Field Detail

avg

protected double avg

count

protected long count

Constructor Detail

Average

public Average()

Method Detail

add

public <T extends Average> T add(long num)

merge

public <T extends Average> T merge(T other)

Merges this average with another one

getAverage

public double getAverage()

average

public double average()

getCount

public long getCount()

count

public long count()

clear

public void clear()

toString

public String toString()

Overrides:

toString in class Object

writeTo

public void writeTo(DataOutput out)
             throws Exception

Description copied from interface: Streamable

Write the entire state of the current object (including superclasses) to outstream. Note that the output stream must not be closed

Specified by:

writeTo in interface Streamable

Throws:

Exception

readFrom

public void readFrom(DataInput in)
              throws Exception

Description copied from interface: Streamable

Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed

Specified by:

readFrom in interface Streamable

Throws:

Exception