org.dianahep.histogrammar

Categorizing

class Categorizing[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }] extends Container[Categorizing[DATUM, V]] with AggregationOnData with CategoricalQuantity[DATUM]

Accumulating a quantity by splitting it by its categorical (string-based) value and filling only one category per datum.

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

Linear Supertypes
CategoricalQuantity[DATUM], AnyQuantity[DATUM, String], AggregationOnData, Aggregation, Container[Categorizing[DATUM, V]], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Categorizing
  2. CategoricalQuantity
  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
    CategorizingAggregation
  2. type EdType = Categorized[V.EdType]

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    CategorizingContainer
  3. type Type = Categorizing[DATUM, 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
    CategorizingContainer

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): Categorizing[DATUM, 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
    CategorizingContainer
  5. def +(that: Categorizing[DATUM, V]): Categorizing[DATUM, 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
    CategorizingContainer
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. def apply(x: String): V

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

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

    Definition Classes
    Any
  11. val bins: HashMap[String, V]

    Map of string category and the associated container of values associated with it.

  12. def checkForCrossReferences(memo: Set[Aggregation] = mutable.Set[Aggregation]()): Unit

    Attributes
    protected
    Definition Classes
    Aggregation
  13. 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
  14. 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
    CategorizingContainer
  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def copy: Categorizing[DATUM, 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
  17. var entries: Double

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

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

    Definition Classes
    CategorizingContainer
  18. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    Categorizing → AnyRef → Any
  20. def factory: Categorize.type

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    CategorizingContainer
  21. 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
    CategorizingAggregation
  22. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def get(x: String): Option[V]

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

  24. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  25. def getOrElse(x: String, default: ⇒ V): V

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

  26. def hashCode(): Int

    Definition Classes
    Categorizing → AnyRef → Any
  27. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  28. def keySet: Set[String]

    Set of keys among the bins.

  29. def keys: Iterable[String]

    Iterable over the keys of the bins.

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

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

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

    Definition Classes
    AnyRef
  33. val quantity: UserFcn[DATUM, String]

    Numerical function to track.

    Numerical function to track.

    Definition Classes
    CategorizingAnyQuantity
  34. def size: Int

    Number of bins.

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

    Definition Classes
    AnyRef
  36. def toImmutable: EdType

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container
  37. 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
  38. def toJsonFile(fileName: String): Unit

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

    Definition Classes
    Container
  40. 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
    CategorizingContainer
  41. def toJsonString: String

    Definition Classes
    Container
  42. def toString(): String

    Definition Classes
    Categorizing → AnyRef → Any
  43. val v: V

    Attributes
    protected
  44. def values: Iterable[V]

    Iterable over the values of the bins.

  45. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. def zero: Categorizing[DATUM, 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
    CategorizingContainer

Inherited from CategoricalQuantity[DATUM]

Inherited from AnyQuantity[DATUM, String]

Inherited from AggregationOnData

Inherited from Aggregation

Inherited from Container[Categorizing[DATUM, V]]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped