org.dianahep.histogrammar

Counting

class Counting extends Container[Counting] with Aggregation

Accumulating a count (sum of weights) of data, ignoring its content.

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

This is the only container with org.dianahep.histogrammar.Aggregation that doesn't have a configurable data type: its Datum is Any. It is primarily for the sake of this container that Aggregation is contravariant.

Linear Supertypes
Aggregation, Container[Counting], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Counting
  2. Aggregation
  3. Container
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Datum = Any

    Type of data expected by fill.

    Type of data expected by fill.

    Definition Classes
    Counting → Aggregation

  2. type EdType = Counted

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    Counting → Container

  3. type Type = Counting

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

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): Counting

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

  5. def +(that: Counting): Counting

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

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

  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  14. def copy: Counting

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

  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  17. def equals(that: Any): Boolean

    Definition Classes
    Counting → AnyRef → Any

  18. def factory: Count.type

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    Counting → Container

  19. def fill[SUB](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
    Counting → Aggregation

  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
    Counting → 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. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  28. def toImmutable: EdType

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container

  29. 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

  30. def toJsonFile(fileName: String): Unit

    Definition Classes
    Container

  31. def toJsonFile(file: File): Unit

    Definition Classes
    Container

  32. def toJsonFragment(suppressName: Boolean): JsonFloat

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

  33. def toJsonString: String

    Definition Classes
    Container

  34. def toString(): String

    Definition Classes
    Counting → AnyRef → Any

  35. val transform: UserFcn[Double, Double]

  36. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  38. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  39. def zero: Counting

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

Inherited from Aggregation

Inherited from Container[Counting]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped