org.dianahep.histogrammar

Summing

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

Accumulating a weighted sum of a given quantity.

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

Linear Supertypes
NumericalQuantity[DATUM], AnyQuantity[DATUM, Double], AggregationOnData, Aggregation, Container[Summing[DATUM]], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Summing
  2. NumericalQuantity
  3. AnyQuantity
  4. AggregationOnData
  5. Aggregation
  6. Container
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Datum = DATUM

    Type of data expected by fill.

    Type of data expected by fill.

    Definition Classes
    SummingAggregation
  2. type EdType = Summed

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    SummingContainer
  3. type Type = Summing[DATUM]

    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
    SummingContainer

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. def *(factor: Double): Summing[DATUM]

    Reweight the contents in all nested aggregators by a scalar factor, as though they had been filled with a different weight.

    Reweight the contents in all nested aggregators by a scalar factor, as though they had been filled with a different weight.

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

    The original is unaffected.

    Definition Classes
    SummingContainer
  5. def +(that: Summing[DATUM]): Summing[DATUM]

    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
    SummingContainer
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. def as[OTHER <: Container[OTHER]]: OTHER

    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
  9. final def asInstanceOf[T0]: T0

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

    Attributes
    protected
    Definition Classes
    Aggregation
  11. var checkedForCrossReferences: Boolean

    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
  12. def children: Nil.type

    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
    SummingContainer
  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def copy: Summing[DATUM]

    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
  15. var entries: Double

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

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

    Definition Classes
    SummingContainer
  16. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    Summing → AnyRef → Any
  18. def factory: Sum.type

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

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

    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
    SummingAggregation
  20. def finalize(): Unit

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

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

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

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

    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

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

    Numerical function to track.

    Numerical function to track.

    Definition Classes
    SummingAnyQuantity
  28. var sum: Double

    The sum of weight times quantity over all entries.

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

    Definition Classes
    AnyRef
  30. def toImmutable: EdType

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container
  31. def toJson: Json

    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
  32. def toJsonFile(fileName: String): Unit

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

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

    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
    SummingContainer
  35. def toJsonString: String

    Definition Classes
    Container
  36. def toString(): String

    Definition Classes
    Summing → AnyRef → Any
  37. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def zero: Summing[DATUM]

    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
    SummingContainer

Inherited from NumericalQuantity[DATUM]

Inherited from AnyQuantity[DATUM, Double]

Inherited from AggregationOnData

Inherited from Aggregation

Inherited from Container[Summing[DATUM]]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped