Packages

class Labeling[V <: Container[V] with Aggregation] extends Container[Labeling[V]] with AggregationOnData with Collection

Accumulating a collection of containers of the SAME type, labeled by strings.

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

Linear Supertypes
Collection, AggregationOnData, Aggregation, Container[Labeling[V]], Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Labeling
  2. Collection
  3. AggregationOnData
  4. Aggregation
  5. Container
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type Datum = V.Datum

    Type of data expected by fill.

    Type of data expected by fill.

    Definition Classes
    Labeling → Aggregation
  2. type EdType = Labeled[V.EdType]

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    Labeling → Container
  3. type Type = Labeling[V]

    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
    Labeling → Container

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def *(factor: Double): Labeling[V]

    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
    Labeling → Container
  4. def +(that: Labeling[V]): Labeling[V]

    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
    Labeling → Container
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def apply(indexes: CollectionIndex*): Container[_]

    Attempt to get key indexes, throwing an exception if it does not exist.

    Attempt to get key indexes, throwing an exception if it does not exist.

    Definition Classes
    Labeling → Collection
  7. def apply(index: CollectionIndex): V

    Attempt to get key index, throwing an exception if it does not exist.

  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. val 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: List[V]

    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
    Labeling → Container
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  14. def copy: Labeling[V]

    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

    Every Container accumulates a sum of weights of observed data.

    Every Container accumulates a sum of weights of observed data.

    The org.dianahep.histogrammar.Counting/org.dianahep.histogrammar.Counted container only accumulates a sum of weights.

    Its data type is Double because in principal, it can be any non-negative real number.

    Definition Classes
    Labeling → Container
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(that: Any): Boolean
    Definition Classes
    Labeling → AnyRef → Any
  18. def factory: Label

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    Labeling → Container
  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
    Labeling → Aggregation
  20. def get(x: String): Option[V]

    Attempt to get key x, returning None if it does not exist.

  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. def getOrElse(x: String, default: => V): V

    Attempt to get key x, returning an alternative if it does not exist.

  23. def hashCode(): Int
    Definition Classes
    Labeling → AnyRef → Any
  24. def indexes: Seq[Seq[CollectionIndex]]
    Definition Classes
    Collection
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def keySet: Set[String]

    Set of keys among the pairs.

  27. def keys: Iterable[String]

    Iterable over the keys of the pairs.

  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  31. val pairs: (String, V)*
  32. val pairsMap: Map[String, V]

    Input pairs as a key-value map.

  33. def size: Int

    Number of pairs.

  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def toImmutable: EdType

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container
  36. 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
  37. def toJsonFile(fileName: String): Unit
    Definition Classes
    Container
  38. def toJsonFile(file: File): Unit
    Definition Classes
    Container
  39. 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
    Labeling → Container
  40. def toJsonString: String
    Definition Classes
    Container
  41. def toString(): String
    Definition Classes
    Labeling → AnyRef → Any
  42. val v: V
    Attributes
    protected
  43. def values: Iterable[V]

    Iterable over the values of the pairs.

  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. def walk[X](op: (Seq[CollectionIndex]) => X): Seq[X]
    Definition Classes
    Collection
  48. def zero: Labeling[V]

    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
    Labeling → Container

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Collection

Inherited from AggregationOnData

Inherited from Aggregation

Inherited from Container[Labeling[V]]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped