freenet.support.math

Class SimpleRunningAverage

java.lang.Object

freenet.support.math.SimpleRunningAverage

All Implemented Interfaces:

RunningAverage, java.io.Serializable, java.lang.Cloneable

public final class SimpleRunningAverage
extends java.lang.Object
implements RunningAverage, java.lang.Cloneable

Simple running average: linear mean of the last N reports.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleRunningAverage(int length, double initValue)
SimpleRunningAverage(SimpleRunningAverage a)

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the SRA
SimpleRunningAverage	clone() Copy the RunningAverage (create a snapshot).
long	countReports()
double	currentValue()
double	minReportForValue(double targetValue)
protected double	popValue()
protected void	pushValue(double value)
void	report(double d)
void	report(long d)
java.lang.String	toString()
double	valueIfReported(double r) Get what currentValue() would be if we reported some given value
void	writeDataTo(java.io.DataOutputStream out)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleRunningAverage

public SimpleRunningAverage(int length,
                            double initValue)

Parameters:

length -

initValue -

SimpleRunningAverage

public SimpleRunningAverage(SimpleRunningAverage a)

Parameters:

a -

Method Detail

clone

public final SimpleRunningAverage clone()

Description copied from interface: RunningAverage

Copy the RunningAverage (create a snapshot). Deep copy, the new RA won't change when the first one does. Will synchronize on the original during the copy process.

Specified by:

clone in interface RunningAverage

Overrides:

clone in class java.lang.Object

clear

public void clear()

Clear the SRA

currentValue

public double currentValue()

Specified by:

currentValue in interface RunningAverage

Returns:

valueIfReported

public double valueIfReported(double r)

Description copied from interface: RunningAverage

Get what currentValue() would be if we reported some given value

Specified by:

valueIfReported in interface RunningAverage

Parameters:

r - the value to mimic reporting

Returns:

the output of currentValue() if we were to report r

report

public void report(double d)

Specified by:

report in interface RunningAverage

Parameters:

d -

pushValue

protected void pushValue(double value)

Parameters:

value -

popValue

protected double popValue()

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

report

public void report(long d)

Specified by:

report in interface RunningAverage

Parameters:

d -

writeDataTo

public void writeDataTo(java.io.DataOutputStream out)

Parameters:

out -

countReports

public long countReports()

Specified by:

countReports in interface RunningAverage

Returns:

the total number of reports on this RunningAverage so far. Used for weighted averages, confidence/newbieness estimation etc.

minReportForValue

public double minReportForValue(double targetValue)

Parameters:

targetValue -

Returns: