SlidingVector

This data type provides the storage and access of a sliding time window of statistics, used to maintain aggregate program failures as well as observed inbound program request and processing rates.

window: - the SampleWindow for a SlidingVector indicates the time period (the scala.concurrent.duration.FiniteDuration) for which this collection should maintain statistics. For instance, a sample window of "five minutes" would indicate that the entries Vector contains items with a time stamp no more than five minutes in the past.
fullWindowCollected: - a flag indicating whether or not at least one full pass equal to the time period has been collected in the underlying vector (used to determine whether there is enough data to derive statistics from it).
entries: - the scala.collection.immutable.Vector of SlidingVector.TimeStamped[A] items (the TimeStamped data type associates a java.time.Instant with a simple statistic item A, such as Boolean or Long, for example).

Source: SlidingVector.scala

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Type Hierarchy

Instance Constructors

new SlidingVector(window: SampleWindow, fullWindowCollected: Boolean = false, entries: Vector[TimeStamped[A]] = Vector.empty)

window
- the SampleWindow for a SlidingVector indicates the time period (the scala.concurrent.duration.FiniteDuration) for which this collection should maintain statistics. For instance, a sample window of "five minutes" would indicate that the entries Vector contains items with a time stamp no more than five minutes in the past.
fullWindowCollected
- a flag indicating whether or not at least one full pass equal to the time period has been collected in the underlying vector (used to determine whether there is enough data to derive statistics from it).
entries
- the scala.collection.immutable.Vector of SlidingVector.TimeStamped[A] items (the TimeStamped data type associates a java.time.Instant with a simple statistic item A, such as Boolean or Long, for example).

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from SlidingVector[A] to any2stringadd[SlidingVector[A]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (SlidingVector[A], B)

Implicit information
This member is added by an implicit conversion from SlidingVector[A] to ArrowAssoc[SlidingVector[A]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def add(timestamp: Instant, value: A): SlidingVector[A]

Adds a value to the vector with an associated timestamp.
Adds a value to the vector with an associated timestamp. The sliding window of the vector is re-evaluated to remove oldest items no longer in the time window.
timestamp
- the java.time.Instant timestamp associated with the value.
value
- the unconstrained value A to be associated with the timestamp.
returns
newSlidingVector - a new copy of the sliding vector.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (SlidingVector[A]) ⇒ Boolean, msg: ⇒ Any): SlidingVector[A]

Implicit information
This member is added by an implicit conversion from SlidingVector[A] to Ensuring[SlidingVector[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (SlidingVector[A]) ⇒ Boolean): SlidingVector[A]

Implicit information
This member is added by an implicit conversion from SlidingVector[A] to Ensuring[SlidingVector[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): SlidingVector[A]

Implicit information
This member is added by an implicit conversion from SlidingVector[A] to Ensuring[SlidingVector[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): SlidingVector[A]

Implicit information
This member is added by an implicit conversion from SlidingVector[A] to Ensuring[SlidingVector[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
val entries: Vector[TimeStamped[A]]

- the scala.collection.immutable.Vector of SlidingVector.TimeStamped[A] items (the TimeStamped data type associates a java.time.Instant with a simple statistic item A, such as Boolean or Long, for example).
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from SlidingVector[A] to StringFormat[SlidingVector[A]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
val fullWindowCollected: Boolean

- a flag indicating whether or not at least one full pass equal to the time period has been collected in the underlying vector (used to determine whether there is enough data to derive statistics from it).
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def protect(cb: CircuitBreaker[SlidingVector]): SlidingVector[A]

Alternate manner in which to protect the effectful program F[A].
Alternate manner in which to protect the effectful program F[A]. See CircuitBreaker#protect for details.
cb
- the CircuitBreaker instance which will protect this F[A].
returns
enhancedProgram - the protected effectful program.

Implicit information
This member is added by an implicit conversion from SlidingVector[A] to CircuitBreakerOps[SlidingVector, A] performed by method CircuitBreakerOps in com.ccadllc.cedi.circuitbreaker.
Definition Classes
CircuitBreakerOps
def reset: SlidingVector[A]

Resets the vector of items to zero, returning a new copy.
Resets the vector of items to zero, returning a new copy.
returns
newSlidingVector - a new copy of the vector.
val self: SlidingVector[A]

Implicit information
This member is added by an implicit conversion from SlidingVector[A] to CircuitBreakerOps[SlidingVector, A] performed by method CircuitBreakerOps in com.ccadllc.cedi.circuitbreaker.
Definition Classes
CircuitBreakerOps
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val window: SampleWindow

- the SampleWindow for a SlidingVector indicates the time period (the scala.concurrent.duration.FiniteDuration) for which this collection should maintain statistics.
- the SampleWindow for a SlidingVector indicates the time period (the scala.concurrent.duration.FiniteDuration) for which this collection should maintain statistics. For instance, a sample window of "five minutes" would indicate that the entries Vector contains items with a time stamp no more than five minutes in the past.
def →[B](y: B): (SlidingVector[A], B)

Implicit information
This member is added by an implicit conversion from SlidingVector[A] to ArrowAssoc[SlidingVector[A]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Docs: object SlidingVector | package statistics

case class SlidingVector[A](window: SampleWindow, fullWindowCollected: Boolean = false, entries: Vector[TimeStamped[A]] = Vector.empty) extends Product with Serializable

Instance Constructors

new SlidingVector(window: SampleWindow, fullWindowCollected: Boolean = false, entries: Vector[TimeStamped[A]] = Vector.empty)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (SlidingVector[A], B)

final def ==(arg0: Any): Boolean

def add(timestamp: Instant, value: A): SlidingVector[A]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (SlidingVector[A]) ⇒ Boolean, msg: ⇒ Any): SlidingVector[A]

def ensuring(cond: (SlidingVector[A]) ⇒ Boolean): SlidingVector[A]

def ensuring(cond: Boolean, msg: ⇒ Any): SlidingVector[A]

def ensuring(cond: Boolean): SlidingVector[A]

val entries: Vector[TimeStamped[A]]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

val fullWindowCollected: Boolean

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def protect(cb: CircuitBreaker[SlidingVector]): SlidingVector[A]

def reset: SlidingVector[A]

val self: SlidingVector[A]

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val window: SampleWindow

def →[B](y: B): (SlidingVector[A], B)

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion CircuitBreakerOps from SlidingVector[A] to CircuitBreakerOps[SlidingVector, A]

Inherited by implicit conversion any2stringadd from SlidingVector[A] to any2stringadd[SlidingVector[A]]

Inherited by implicit conversion StringFormat from SlidingVector[A] to StringFormat[SlidingVector[A]]

Inherited by implicit conversion Ensuring from SlidingVector[A] to Ensuring[SlidingVector[A]]

Inherited by implicit conversion ArrowAssoc from SlidingVector[A] to ArrowAssoc[SlidingVector[A]]

Ungrouped