freenet.support.math

Class BootstrappingDecayingRunningAverage

java.lang.Object

freenet.support.math.BootstrappingDecayingRunningAverage

All Implemented Interfaces:

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

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

Exponential decay "running average".

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BootstrappingDecayingRunningAverage(double defaultValue, double min, double max, int maxReports, SimpleFieldSet fs) Constructor

Method Summary

Modifier and Type	Method and Description
void	changeMaxReports(int maxReports) Change maxReports.
BootstrappingDecayingRunningAverage	clone() Copy the RunningAverage (create a snapshot).
long	countReports()
double	currentValue()
SimpleFieldSet	exportFieldSet(boolean shortLived) Export this object as SimpleFieldSet.
void	report(double d)
void	report(long d)
protected double	setCurrentValue(double d) Not a public method. Changes the internally stored currentValue and return the old one.
double	valueIfReported(double d) Get what currentValue() would be if we reported some given value

Methods inherited from class java.lang.Object

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

Constructor Detail

BootstrappingDecayingRunningAverage

public BootstrappingDecayingRunningAverage(double defaultValue,
                                           double min,
                                           double max,
                                           int maxReports,
                                           SimpleFieldSet fs)

Constructor

Parameters:

defaultValue - default value

min - minimum value of input data

max - maxumum value of input data

maxReports - number of reports before bootstrapping period ends and decay begins

fs - SimpleFieldSet parameter for this object. Will override other parameters.

Method Detail

clone

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

currentValue

public double currentValue()

Specified by:

currentValue in interface RunningAverage

Returns:

setCurrentValue

protected double setCurrentValue(double d)

Not a public method. Changes the internally stored currentValue and return the old one. Used by DecayingKeyspaceAverage to normalize the stored averages. Calling this function may (purposefully) destroy the utility of the average being kept.

Parameters:

d -

Returns:

See Also:

DecayingKeyspaceAverage

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 d)

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

Specified by:

valueIfReported in interface RunningAverage

Parameters:

d -

Returns:

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

changeMaxReports

public void changeMaxReports(int maxReports)

Change maxReports.

Parameters:

maxReports -

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.

exportFieldSet

public SimpleFieldSet exportFieldSet(boolean shortLived)

Export this object as SimpleFieldSet.

Parameters:

shortLived - See SimpleFieldSet.SimpleFieldSet(boolean).

Returns: