Class

org.dianahep.histogrammar

Deviating

Related Doc: package histogrammar

Permalink

class Deviating[DATUM] extends Container[Deviating[DATUM]] with AggregationOnData with NumericalQuantity[DATUM]

Accumulating a weighted variance (and mean) of a given quantity.

Use the factory org.dianahep.histogrammar.Deviate to construct an instance.

Linear Supertypes
NumericalQuantity[DATUM], AnyQuantity[DATUM, Double], AggregationOnData, Aggregation, Container[Deviating[DATUM]], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Deviating
  2. NumericalQuantity
  3. AnyQuantity
  4. AggregationOnData
  5. Aggregation
  6. Container
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Datum = DATUM

    Permalink

    Type of data expected by fill.

    Type of data expected by fill.

    Definition Classes
    DeviatingAggregation
  2. type EdType = Deviated

    Permalink

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    DeviatingContainer
  3. type Type = Deviating[DATUM]

    Permalink

    Intended for the general user to copy a complex container's type into the as method of a container whose type is not known at compile-time.

    Intended for the general user to copy a complex container's type into the as method of a container whose type is not known at compile-time.

    Typical use: filledHistogram.as[initialHistogram.Type]

    Definition Classes
    DeviatingContainer

Value Members

  1. final def !=(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(that: Deviating[DATUM]): Deviating[DATUM]

    Permalink

    Add two containers of the same type.

    Add two containers of the same type.

    If these containers are mutable (with org.dianahep.histogrammar.Aggregation), the new one will be, too.

    The originals are unaffected.

    Definition Classes
    DeviatingContainer
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def as[OTHER <: Container[OTHER]]: OTHER

    Permalink

    Cast the container to a given type.

    Cast the container to a given type. Especially useful for containers reconstructed from JSON or stored in org.dianahep.histogrammar.UntypedLabeling/org.dianahep.histogrammar.UntypedLabeled.

    Definition Classes
    Container
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def checkForCrossReferences(memo: Set[Aggregation] = mutable.Set[Aggregation]()): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Aggregation
  8. var checkedForCrossReferences: Boolean

    Permalink

    List of sub-aggregators, to make it possible to walk the tree.

    List of sub-aggregators, to make it possible to walk the tree.

    Attributes
    protected
    Definition Classes
    Aggregation
  9. def children: Nil.type

    Permalink

    List of sub-aggregators, to make it possible to walk the tree.

    List of sub-aggregators, to make it possible to walk the tree.

    Definition Classes
    DeviatingContainer
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def copy: Deviating[DATUM]

    Permalink

    Copy this container, making a clone with no reference to the original.

    Copy this container, making a clone with no reference to the original.

    If these containers are mutable (with org.dianahep.histogrammar.Aggregation), the new one will be, too.

    Definition Classes
    Container
  12. var entries: Double

    Permalink

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

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

    Definition Classes
    DeviatingContainer
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(that: Any): Boolean

    Permalink
    Definition Classes
    Deviating → AnyRef → Any
  15. def factory: Deviate.type

    Permalink

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    DeviatingContainer
  16. def fill[SUB <: Datum](datum: SUB, weight: Double = 1.0): Unit

    Permalink

    Entry point for the general user to pass data into the container for aggregation.

    Entry point for the general user to pass data into the container for aggregation.

    Usually all containers in a collection of histograms take the same input data by passing it recursively through the tree. Quantities to plot are specified by the individual container's lambda functions.

    The container is changed in-place.

    Definition Classes
    DeviatingAggregation
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Permalink
    Definition Classes
    Deviating → AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. var mean: Double

    Permalink

    Weighted mean of the quantity.

  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. val quantity: UserFcn[DATUM, Double]

    Permalink

    Numerical function to track.

    Numerical function to track.

    Definition Classes
    DeviatingAnyQuantity
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. def toImmutable: EdType

    Permalink

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container
  28. def toJson: Json

    Permalink

    Convert this container to JSON (dropping its fill method, making it immutable).

    Convert this container to JSON (dropping its fill method, making it immutable).

    Note that the org.dianahep.histogrammar.json.Json object has a stringify method to serialize.

    Definition Classes
    Container
  29. def toJsonFile(fileName: String): Unit

    Permalink
    Definition Classes
    Container
  30. def toJsonFile(file: File): Unit

    Permalink
    Definition Classes
    Container
  31. def toJsonFragment(suppressName: Boolean): JsonObject

    Permalink

    Used internally to convert the container to JSON without its "type" header.

    Used internally to convert the container to JSON without its "type" header.

    Definition Classes
    DeviatingContainer
  32. def toJsonString: String

    Permalink
    Definition Classes
    Container
  33. def toString(): String

    Permalink
    Definition Classes
    Deviating → AnyRef → Any
  34. def variance: Double

    Permalink

    weighted variance of the quantity

  35. def variance_=(_variance: Double): Unit

    Permalink
  36. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. def zero: Deviating[DATUM]

    Permalink

    Create an empty container with the same parameters as this one.

    Create an empty container with the same parameters as this one.

    If this container is mutable (with org.dianahep.histogrammar.Aggregation), the new one will be, too.

    The original is unaffected.

    Definition Classes
    DeviatingContainer

Inherited from NumericalQuantity[DATUM]

Inherited from AnyQuantity[DATUM, Double]

Inherited from AggregationOnData

Inherited from Aggregation

Inherited from Container[Deviating[DATUM]]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped