c

io.sqooba.oss.timeseries.window

IntegralAggregator

class IntegralAggregator[T] extends TimeAwareReversibleAggregator[T, Double]

An aggregator that relies on the passed entries' integral function.

Very similar to the SummingAggregator, but takes the validity of each entry into account. It is therefore time-aware and needs entries to be contained in the window.

Linear Supertypes
TimeAwareReversibleAggregator[T, Double], ReversibleAggregator[T, Double], Aggregator[T, Double], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IntegralAggregator
  2. TimeAwareReversibleAggregator
  3. ReversibleAggregator
  4. Aggregator
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IntegralAggregator(timeunit: TimeUnit, initialValue: Double = .0)(implicit n: Numeric[T])

    timeunit

    that will be passe to the entries' integral function

    initialValue

    to initialise the aggregator with.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAndDrop(add: TSEntry[T], remove: TSEntry[T]): Unit

    Combine the addition and the removal of entries from the aggregated value.

    Combine the addition and the removal of entries from the aggregated value.

    add

    the entry that will be added at the tail

    remove

    the entry that will be removed at the head

    Definition Classes
    ReversibleAggregator
  5. def addAndDrop(add: TSEntry[T], currentWindow: Queue[TSEntry[T]]): Unit

    Combine the addition and the removal of entries from the aggregated value.

    Combine the addition and the removal of entries from the aggregated value.

    add

    the value that will be added

    currentWindow

    the current window, from which we will drop the first entry. Note that it does not yet contain 'add'

    Definition Classes
    ReversibleAggregator
  6. def addEntry(entry: TSEntry[T]): Unit

    Update the internal aggregated value according to the entry that is about to be added to the window.

    Update the internal aggregated value according to the entry that is about to be added to the window.

    Definition Classes
    IntegralAggregatorAggregator
  7. def addEntry(e: TSEntry[T], currentWindow: Queue[TSEntry[T]]): Unit

    Update the internal aggregated value according to the entry that is about to be added to the window.

    Update the internal aggregated value according to the entry that is about to be added to the window.

    e

    the entry that is about to enter the window

    currentWindow

    the current content of the window: it does not include 'e' at this point.

    Definition Classes
    Aggregator
    Note

    By default this ignores the currentWindow and passes the entry to the function that only takes the entry. If you want to use the entire window in the aggregaton you can override this method.

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def currentValue: Option[Double]

    returns

    the current aggregated value or None

    Definition Classes
    IntegralAggregatorAggregator
  11. def dropEntry(entry: TSEntry[T]): Unit

    Updates the aggregated value according to the fact that this entry is being removed.

    Updates the aggregated value according to the fact that this entry is being removed.

    entry

    to remove from the head of the window

    Definition Classes
    IntegralAggregatorReversibleAggregator
  12. def dropHead(currentWindow: Queue[TSEntry[T]]): Unit

    Updates the aggregated value according to the fact that the head of the currentWindow is being removed.

    Updates the aggregated value according to the fact that the head of the currentWindow is being removed.

    currentWindow

    the current content of the window. It still contains the entry that has to be removed

    Definition Classes
    ReversibleAggregator
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from TimeAwareReversibleAggregator[T, Double]

Inherited from ReversibleAggregator[T, Double]

Inherited from Aggregator[T, Double]

Inherited from AnyRef

Inherited from Any

Ungrouped