ExponentialWeightedAverageStatistic

Kotlin |Java

@UnstableApi
public class ExponentialWeightedAverageStatistic implements BandwidthStatistic

A BandwidthStatistic that calculates estimates using an exponential weighted average.

Summary

Constants
`static final double`	`DEFAULT_SMOOTHING_FACTOR = 0.9999` The default smoothing factor.

Public constructors
`ExponentialWeightedAverageStatistic()` Creates an instance with `DEFAULT_SMOOTHING_FACTOR`.
`ExponentialWeightedAverageStatistic(double smoothingFactor)` Creates an instance.

Public methods
`void`	`addSample(long bytes, long durationUs)` Adds a transfer sample to the statistic.
`long`	`getBandwidthEstimate()` Returns the bandwidth estimate in bits per second, or `ESTIMATE_NOT_AVAILABLE` if there is no estimate available yet.
`void`	`reset()` Resets the statistic.

public static final double DEFAULT_SMOOTHING_FACTOR = 0.9999

The default smoothing factor.

public ExponentialWeightedAverageStatistic()

Creates an instance with DEFAULT_SMOOTHING_FACTOR.

public ExponentialWeightedAverageStatistic(double smoothingFactor)

Creates an instance.

Parameters
`double smoothingFactor`	The exponential smoothing factor.

public void addSample(long bytes, long durationUs)

Adds a transfer sample to the statistic.

Parameters
`long bytes`	The number of bytes transferred.
`long durationUs`	The duration of the transfer, in microseconds.

public long getBandwidthEstimate()

Returns the bandwidth estimate in bits per second, or ESTIMATE_NOT_AVAILABLE if there is no estimate available yet.

public void reset()

Resets the statistic. The statistic should drop all samples and reset to its initial state, similar to right after construction.