freenet.support.math

Class TimeDecayingRunningAverage

java.lang.Object

freenet.support.math.TimeDecayingRunningAverage

All Implemented Interfaces:

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

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

Time decaying running average. Decay factor = 0.5 ^ (interval / halflife). So if the interval is exactly the half-life then reporting 0 will halve the value. Note that the older version has a half life on the influence of any given report without taking into account the fact that reports persist and accumulate. :)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TimeDecayingRunningAverage(double defaultValue, double halfLife, double min, double max, java.io.DataInputStream dis, TimeSkewDetectorCallback callback)
TimeDecayingRunningAverage(double defaultValue, long halfLife, double min, double max, SimpleFieldSet fs, TimeSkewDetectorCallback callback)
TimeDecayingRunningAverage(double defaultValue, long halfLife, double min, double max, TimeSkewDetectorCallback callback)
TimeDecayingRunningAverage(TimeDecayingRunningAverage a)

Method Summary

Modifier and Type	Method and Description
TimeDecayingRunningAverage	clone() Copy the RunningAverage (create a snapshot).
long	countReports()
double	currentValue()
SimpleFieldSet	exportFieldSet(boolean shortLived)
int	getDataLength()
long	lastReportTime()
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

TimeDecayingRunningAverage

public TimeDecayingRunningAverage(double defaultValue,
                                  long halfLife,
                                  double min,
                                  double max,
                                  TimeSkewDetectorCallback callback)

Parameters:

defaultValue -

halfLife -

min -

max -

callback -

TimeDecayingRunningAverage

public TimeDecayingRunningAverage(double defaultValue,
                                  long halfLife,
                                  double min,
                                  double max,
                                  SimpleFieldSet fs,
                                  TimeSkewDetectorCallback callback)

Parameters:

defaultValue -

halfLife -

min -

max -

fs -

callback -

TimeDecayingRunningAverage

public TimeDecayingRunningAverage(double defaultValue,
                                  double halfLife,
                                  double min,
                                  double max,
                                  java.io.DataInputStream dis,
                                  TimeSkewDetectorCallback callback)
                           throws java.io.IOException

Parameters:

defaultValue -

halfLife -

min -

max -

dis -

callback -

Throws:

java.io.IOException

TimeDecayingRunningAverage

public TimeDecayingRunningAverage(TimeDecayingRunningAverage a)

Parameters:

a -

Method Detail

clone

public final TimeDecayingRunningAverage 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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

currentValue

public double currentValue()

Specified by:

currentValue in interface RunningAverage

Returns:

report

public void report(double d)

Specified by:

report in interface RunningAverage

Parameters:

d -

report

public void report(long d)

Specified by:

report in interface RunningAverage

Parameters:

d -

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

writeDataTo

public void writeDataTo(java.io.DataOutputStream out)
                 throws java.io.IOException

Parameters:

out -

Throws:

java.io.IOException

getDataLength

public int getDataLength()

Returns:

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.

lastReportTime

public long lastReportTime()

Returns:

exportFieldSet

public SimpleFieldSet exportFieldSet(boolean shortLived)

Parameters:

shortLived -

Returns: