Class RollingWindowAverage

java.lang.Object
org.carrot2.util.RollingWindowAverage

public class RollingWindowAverage extends Object
Calculates an average of values showing up in a given time window. To keep processing efficient, bucketing is performed.

This class is not thread-safe.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    Helpful constant for one millisecond.
    static final int
    Helpful constant for one minute.
    static final int
    Helpful constant for one second.
  • Constructor Summary

    Constructors
    Constructor
    Description
    RollingWindowAverage(long windowSizeMillis, long bucketSizeMillis)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    add(long timestamp, long value)
    Adds a new entry.
    final double
     
    final long
    Returns the number of updates kept in the rolling window's scope.
    final long
    Returns the size of the rolling window.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • MILLIS

      public static final int MILLIS
      Helpful constant for one millisecond.
      See Also:
    • SECOND

      public static final int SECOND
      Helpful constant for one second.
      See Also:
    • MINUTE

      public static final int MINUTE
      Helpful constant for one minute.
      See Also:
  • Constructor Details

    • RollingWindowAverage

      public RollingWindowAverage(long windowSizeMillis, long bucketSizeMillis)
  • Method Details

    • add

      public final void add(long timestamp, long value)
      Adds a new entry.
    • getCurrentAverage

      public final double getCurrentAverage()
    • getUpdatesInWindow

      public final long getUpdatesInWindow()
      Returns the number of updates kept in the rolling window's scope.
    • getWindowSizeMillis

      public final long getWindowSizeMillis()
      Returns the size of the rolling window.