AveragedValue

Tracks the count and mean value of Doubles in a data stream.

Adding two instances of AveragedValue with + is equivalent to taking an average of the two streams, with each stream weighted by its count.

The mean calculation uses a numerically stable online algorithm suitable for large numbers of records, similar to Chan et. al.'s parallel variance algorithm on Wikipedia. As long as your count doesn't overflow a Long, the mean calculation won't overflow.

count: the number of aggregated items
value: the average value of all aggregated items

Source: AveragedValue.scala
See also: MomentsGroup.getCombinedMean for implementation of +

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Type Hierarchy

Instance Constructors

new AveragedValue(count: Long, value: Double)

count
the number of aggregated items
value
the average value of all aggregated items

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def +[N](that: N)(implicit num: Numeric[N]): AveragedValue

Returns a new instance that averages that into this instance.
Returns a new instance that averages that into this instance.
that
value to average into this instance
returns
an instance representing the mean of this instance and that.
def +(that: Double): AveragedValue

Returns a new instance that averages that into this instance.
Returns a new instance that averages that into this instance.
that
value to average into this instance
returns
an instance representing the mean of this instance and that.
def +(r: AveragedValue): AveragedValue

Averages this instance with another AveragedValue instance.
Averages this instance with another AveragedValue instance.
r
the other instance
returns
an instance representing the mean of this instance and r.
def -(r: AveragedValue): AveragedValue

Averages this instance with the *opposite* of the supplied AveragedValue instance, effectively subtracting out that instance's contribution to the mean.
Averages this instance with the *opposite* of the supplied AveragedValue instance, effectively subtracting out that instance's contribution to the mean.
r
the instance to subtract
returns
an instance with r's stream subtracted out
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val count: Long

the number of aggregated items
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] )
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def unary_-: AveragedValue

Returns a copy of this instance with a negative value.
Returns a copy of this instance with a negative value. Note that
```
a + -b == a - b
```
val value: Double

the average value of all aggregated items
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( ... )

Related Docs: object AveragedValue | package algebird

case class AveragedValue(count: Long, value: Double) extends Product with Serializable

Instance Constructors

new AveragedValue(count: Long, value: Double)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +[N](that: N)(implicit num: Numeric[N]): AveragedValue

def +(that: Double): AveragedValue

def +(r: AveragedValue): AveragedValue

def -(r: AveragedValue): AveragedValue

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val count: Long

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def unary_-: AveragedValue

val value: Double

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped