Packages

o

fs2.timeseries

TimeSeries

object TimeSeries

A time series is a stream of timestamped values or clock ticks.

Values are represented as Some values in a TimeStamped[Option[A]], whereas clock ticks are represented as Nones. This encoding allows for an indication of time passage with no observed values.

Generally, time series appear in increasing order, and many combinators that work with time series will rely on that. For streams that are globally ordered, but not locally ordered, i.e., near adjacent values might be out of order but values at great distance from each other are ordered, consider using TimeStamped.reorderLocally to adjust.

Source
TimeSeries.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TimeSeries
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 apply[F[_], A](source: Stream[F, TimeStamped[A]], tickPeriod: FiniteDuration, reorderOver: FiniteDuration, monotonic: Boolean)(implicit arg0: Temporal[F]): Stream[F, TimeStamped[Option[A]]]

    Stream of either time ticks (spaced by tickPeriod) or values from the source stream.

    Stream of either time ticks (spaced by tickPeriod) or values from the source stream.

    The monotonic parameter specifies whether time ticks should use a monotonic increasing counter (e.g. System.nanoTime) or the current system time. This must match the time source of the source stream -- e.g., if source uses monotonic time then monotonic must be set to true.

  5. def apply[F[_], A](source: Stream[F, TimeStamped[A]], tickPeriod: FiniteDuration, reorderOver: FiniteDuration)(implicit arg0: Temporal[F]): Stream[F, TimeStamped[Option[A]]]

    Stream of either time ticks (spaced by tickPeriod) or values from the source stream.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def choice[LS, L, RS, R, O](l: Scan[LS, TimeStamped[Option[L]], O], r: Scan[RS, TimeStamped[Option[R]], O]): Scan[(LS, RS), TimeStamped[Option[Either[L, R]]], O]

    Combinator that combines a Scan[LS, TimeStamped[Option[L]], O] and a Scan[RS, TimeStamped[Option[R]], O] in to a Scan[(LS, RS), TimeSeriesVlaue[Either[L, R], O]].

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def drainLeft[F[_], L, R]: (Stream[F, TimeStamped[Option[Either[L, R]]]]) => Stream[F, TimeStamped[Option[R]]]

    Time series pipe which discards left values.

  10. def drainRight[F[_], L, R]: (Stream[F, TimeStamped[Option[Either[L, R]]]]) => Stream[F, TimeStamped[Option[L]]]

    Time series pipe which discards right values.

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def interpolateTicks[F[_], A](tickPeriod: FiniteDuration): (Stream[F, TimeStamped[A]]) => Stream[F, TimeStamped[Option[A]]]

    Pipe that converts a stream of timestamped values with monotonically increasing timestamps in to a stream of timestamped ticks or values, where a tick is emitted every tickPeriod.

    Pipe that converts a stream of timestamped values with monotonically increasing timestamps in to a stream of timestamped ticks or values, where a tick is emitted every tickPeriod. Ticks are emitted between values from the source stream.

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def lift[F[_], A, B](f: (A) => B): (Stream[F, TimeStamped[Option[A]]]) => Stream[F, TimeStamped[Option[B]]]

    Lifts a function from A => B to a time series pipe.

  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. def preserve[S, I, O](t: Scan[S, I, O]): Scan[S, TimeStamped[Option[I]], TimeStamped[Option[O]]]

    Combinator that converts a Scan[S, I, O] in to a Scan[S, TimeStamped[Option[I]], TimeStamped[Option[O]]] such that timestamps are preserved on elements that flow through the stream.

  23. def preserveTicks[S, I, O](t: Scan[S, TimeStamped[I], TimeStamped[O]]): Scan[S, TimeStamped[Option[I]], TimeStamped[Option[O]]]

    Combinator that converts a Scan[S, TimeStamped[I], TimeStamped[O]] in to a Scan[S, TimeStamped[Option[I]], TimeStamped[Option[O]]] such that timestamps are preserved on elements that flow through the stream.

  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def timePulled[F[_], A](source: Stream[F, A], tickPeriod: FiniteDuration, reorderOver: FiniteDuration, monotonic: Boolean)(implicit arg0: Temporal[F]): Stream[F, TimeStamped[Option[A]]]

    Stream of either time ticks (spaced by tickPeriod) or values from the source stream.

    Stream of either time ticks (spaced by tickPeriod) or values from the source stream.

    The monotonic parameter specifies whether time stamps should use a monotonic increasing counter (e.g. System.nanoTime) or the current system time.

  26. def timePulled[F[_], A](source: Stream[F, A], tickPeriod: FiniteDuration, reorderOver: FiniteDuration)(implicit arg0: Temporal[F]): Stream[F, TimeStamped[Option[A]]]

    Stream of either time ticks (spaced by tickPeriod) or values from the source stream.

    Stream of either time ticks (spaced by tickPeriod) or values from the source stream.

    Packets are time stamped with the system time. If downstream processing requires monotonically increasaing time stamps, consider using the overload which takes the monotonic parameter.

  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped