Packages

class Labeled[V <: Container[V] with NoAggregation] extends Container[Labeled[V]] with NoAggregation with Collection

An accumulated collection of containers of the SAME type, labeled by strings.

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

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

Type Members

  1. type EdType = Labeled[V]

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    Labeled → Container
  2. type Type = Labeled[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
    Labeled → 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): Labeled[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
    Labeled → Container
  4. def +(that: Labeled[V]): Labeled[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
    Labeled → Container
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def apply(indexes: CollectionIndex*): Container[_]

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

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

    Definition Classes
    Labeled → 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 children: List[Container[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
    Labeled → Container
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  12. def copy: Labeled[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
  13. val 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
    Labeled → Container
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(that: Any): Boolean
    Definition Classes
    Labeled → AnyRef → Any
  16. def factory: Label

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    Labeled → Container
  17. def get(x: String): Option[V]

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

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

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

  20. def hashCode(): Int
    Definition Classes
    Labeled → AnyRef → Any
  21. def indexes: Seq[Seq[CollectionIndex]]
    Definition Classes
    Collection
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def keySet: Set[String]

    Set of keys among the pairs.

  24. def keys: Iterable[String]

    Iterable over the keys of the pairs.

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

    Input pairs as a key-value map.

  30. def size: Int

    Number of pairs.

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

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container
  33. 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
  34. def toJsonFile(fileName: String): Unit
    Definition Classes
    Container
  35. def toJsonFile(file: File): Unit
    Definition Classes
    Container
  36. 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
    Labeled → Container
  37. def toJsonString: String
    Definition Classes
    Container
  38. def toString(): String
    Definition Classes
    Labeled → AnyRef → Any
  39. def values: Iterable[Container[V]]

    Iterable over the values of the pairs.

  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. def walk[X](op: (Seq[CollectionIndex]) => X): Seq[X]
    Definition Classes
    Collection
  44. def zero: Labeled[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
    Labeled → 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 NoAggregation

Inherited from Container[Labeled[V]]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped