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.
- Alphabetic
- By Inheritance
- Average
- Factory
- 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[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.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- val detailedHelp: String
Help text that can be queried interactively: more detail than
help. - 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.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fromJsonFragment(json: Json, nameFromParent: Option[String]): Container[_] with NoAggregation
Reconstructs a container of known type from JSON.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val help: String
Help text that can be queried interactively: a one-liner that can be included in a menu.
- def ing[DATUM](quantity: UserFcn[DATUM, Double]): Averaging[DATUM]
Synonym for
apply. - final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val name: String
Name of the concrete
Factoryas a string; used to label the container type in JSON. - final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unapply[DATUM](x: Averaging[DATUM]): Some[Double]
Use org.dianahep.histogrammar.Averaging in Scala pattern-matching.
- def unapply(x: Averaged): Some[Double]
Use org.dianahep.histogrammar.Averaged in Scala pattern-matching.
- 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])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)