Class

org.dianahep.histogrammar

Categorized

Related Doc: package histogrammar

Permalink

class Categorized[V <: Container[V] with NoAggregation] extends Container[Categorized[V]] with NoAggregation with QuantityName

An accumulated quantity that was split by its categorical (string-based) values, filling only one category per datum.

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

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

Type Members

  1. type EdType = Categorized[V]

    Permalink

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    CategorizedContainer
  2. type Type = Categorized[V]

    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
    CategorizedContainer

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def *(factor: Double): Categorized[V]

    Permalink

    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
    CategorizedContainer
  4. def +(that: Categorized[V]): Categorized[V]

    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
    CategorizedContainer
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def apply(x: String): V

    Permalink

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

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

    Permalink
    Definition Classes
    Any
  9. val bins: Map[String, V]

    Permalink

    String category and the associated container of values associated with it.

  10. def children: List[Container[V]]

    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
    CategorizedContainer
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def copy: Categorized[V]

    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
  13. val entries: Double

    Permalink

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

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

    Definition Classes
    CategorizedContainer
  14. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    Categorized → AnyRef → Any
  16. def factory: Categorize.type

    Permalink

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    CategorizedContainer
  17. def finalize(): Unit

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

    Permalink

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

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

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

    Permalink

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

  21. def hashCode(): Int

    Permalink
    Definition Classes
    Categorized → AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def keySet: Set[String]

    Permalink

    Set of keys among the bins.

  24. def keys: Iterable[String]

    Permalink

    Iterable over the keys of the bins.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  28. val quantityName: Option[String]

    Permalink

    Optional name given to the quantity function, passed for bookkeeping.

    Optional name given to the quantity function, passed for bookkeeping.

    Definition Classes
    CategorizedQuantityName
  29. def size: Int

    Permalink

    Number of bins.

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

    Permalink
    Definition Classes
    AnyRef
  31. def toImmutable: EdType

    Permalink

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

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

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

    Permalink
    Definition Classes
    Container
  35. 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
    CategorizedContainer
  36. def toJsonString: String

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

    Permalink
    Definition Classes
    Categorized → AnyRef → Any
  38. def values: Iterable[Container[V]]

    Permalink

    Iterable over the values of the bins.

  39. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. def zero: Categorized[V]

    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
    CategorizedContainer

Inherited from QuantityName

Inherited from NoAggregation

Inherited from Container[Categorized[V]]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped