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 None
s. 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
- Alphabetic
- By Inheritance
- TimeSeries
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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., ifsource
uses monotonic time thenmonotonic
must be set to true. - 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. - final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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 aScan[RS, TimeStamped[Option[R]], O]
in to aScan[(LS, RS), TimeSeriesVlaue[Either[L, R], O]]
. - def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def drainLeft[F[_], L, R]: (Stream[F, TimeStamped[Option[Either[L, R]]]]) => Stream[F, TimeStamped[Option[R]]]
Time series pipe which discards left values.
- def drainRight[F[_], L, R]: (Stream[F, TimeStamped[Option[Either[L, R]]]]) => Stream[F, TimeStamped[Option[L]]]
Time series pipe which discards right values.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- 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. - final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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. - final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- 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 aScan[S, TimeStamped[Option[I]], TimeStamped[Option[O]]]
such that timestamps are preserved on elements that flow through the stream. - 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 aScan[S, TimeStamped[Option[I]], TimeStamped[Option[O]]]
such that timestamps are preserved on elements that flow through the stream. - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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. - 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. - def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])