# Average

#### object Average extends Factory

Accumulate the weighted mean of a given quantity.

Uses the numerically stable weighted mean algorithm described in Tony Finch, "Incremental calculation of weighted mean and variance" Univeristy of Cambridge Computing Service, 2009.

Factory produces mutable org.dianahep.histogrammar.Averaging and immutable org.dianahep.histogrammar.Averaged objects.

Linear Supertypes
Factory, AnyRef, Any
Ordering
1. Alphabetic
2. By inheritance
Inherited
1. Average
2. Factory
3. AnyRef
4. Any
1. Hide All
2. Show all
Visibility
1. Public
2. All

### Value Members

1. #### final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
2. #### final def !=(arg0: Any): Boolean

Definition Classes
Any
3. #### final def ##(): Int

Definition Classes
AnyRef → Any
4. #### final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
5. #### final def ==(arg0: Any): Boolean

Definition Classes
Any
6. #### def apply[DATUM](quantity: UserFcn[DATUM, Double]): Averaging[DATUM]

Create an empty, mutable org.dianahep.histogrammar.Averaging.

Create an empty, mutable org.dianahep.histogrammar.Averaging.

quantity

Numerical function to track.

7. #### final def asInstanceOf[T0]: T0

Definition Classes
Any
8. #### def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
9. #### val detailedHelp: String

Help text that can be queried interactively: more detail than `help`.

Help text that can be queried interactively: more detail than `help`. (FIXME: currently only contains the `apply` signature.)

Definition Classes
AverageFactory
10. #### def ed(entries: Double, mean: Double): Averaged

Create an immutable org.dianahep.histogrammar.Averaged from arguments (instead of JSON).

Create an immutable org.dianahep.histogrammar.Averaged from arguments (instead of JSON).

entries

Weighted number of entries (sum of all observed weights).

mean

Weighted mean of the quantity.

11. #### final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
12. #### def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
13. #### def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
14. #### def fromJsonFragment(json: Json, nameFromParent: Option[String]): Container[_] with NoAggregation

Reconstructs a container of known type from JSON.

Reconstructs a container of known type from JSON. General users should call the `Factory` object's `fromJson`, which uses header data to identify the container type. (This is called by `fromJson`.)

Definition Classes
AverageFactory
15. #### final def getClass(): Class[_]

Definition Classes
AnyRef → Any
16. #### def hashCode(): Int

Definition Classes
AnyRef → Any
17. #### val help: String

Help text that can be queried interactively: a one-liner that can be included in a menu.

Help text that can be queried interactively: a one-liner that can be included in a menu.

Definition Classes
AverageFactory
18. #### def ing[DATUM](quantity: UserFcn[DATUM, Double]): Averaging[DATUM]

Synonym for `apply`.

19. #### final def isInstanceOf[T0]: Boolean

Definition Classes
Any
20. #### val name: String

Name of the concrete `Factory` as a string; used to label the container type in JSON.

Name of the concrete `Factory` as a string; used to label the container type in JSON.

Definition Classes
AverageFactory
21. #### final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
22. #### final def notify(): Unit

Definition Classes
AnyRef
23. #### final def notifyAll(): Unit

Definition Classes
AnyRef
24. #### final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
25. #### def toString(): String

Definition Classes
AnyRef → Any
26. #### def unapply[DATUM](x: Averaging[DATUM]): Some[Double]

Use org.dianahep.histogrammar.Averaging in Scala pattern-matching.

27. #### def unapply(x: Averaged): Some[Double]

Use org.dianahep.histogrammar.Averaged in Scala pattern-matching.

28. #### final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )