io.praesid.livestats

Class DecayConfig

java.lang.Object

io.praesid.livestats.DecayConfig

All Implemented Interfaces:

Serializable

public final class DecayConfig
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
double	multiplier
static DecayConfig	NEVER
long	period

Constructor Summary

Constructors

Constructor and Description
DecayConfig(double multiplier) DecayConfig constructor with no period.
DecayConfig(double multiplier, java.time.Duration period) DecayConfig constructor with a period.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

NEVER

public static final DecayConfig NEVER

multiplier

public final double multiplier

period

public final long period

Constructor Detail

DecayConfig

public DecayConfig(double multiplier)

DecayConfig constructor with no period. This is best used when you want to decay values exponentially over time and the values will never be "invalid". A typical value for "multiplier" is 0.95.

Parameters:

multiplier - The exponential moving average coefficient

DecayConfig

public DecayConfig(double multiplier,
                   java.time.Duration period)

DecayConfig constructor with a period. This is best used when the data has a strict time bound, where it would not make sense to keep values around forever. A typical value for "multiplier" is 0.95 and the period depends on how long the data is valid.

Parameters:

multiplier - The exponential moving average coefficient

period - The time period where the data is valid