Trait

org.dianahep.histogrammar

Container

Related Doc: package histogrammar

Permalink

trait Container[CONTAINER <: Container[CONTAINER]] extends Serializable

Interface for classes that contain aggregated data, such as "Counted" or "Binned" (immutable) or "Counting" or "Binning" (mutable).

There are two "tenses" of containers: present tense ("Counting", "Binning", etc.) that additionally mix-in org.dianahep.histogrammar.Aggregation and have a fill method for accumulating data, and past tense ("Counted", "Binned", etc.) that can only be merged with the + operator.

Containers are monoids: they have a neutral element (zero) and an associative operator (+). Thus, partial sums aggregated in parallel can be combined arbitrarily.

The Container is parameterized by itself (an example of the curiously recurring template pattern) to pass type information at compile-time.

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
Averaged, Averaging, Bagged, Bagging, Binned, Binning, Branched, Branching, Categorized, Categorizing, CentrallyBinned, CentrallyBinning, Counted, Counting, Deviated, Deviating, Fractioned, Fractioning, Indexed, Indexing, IrregularlyBinned, IrregularlyBinning, Labeled, Labeling, Maximized, Maximizing, Minimized, Minimizing, Selected, Selecting, SparselyBinned, SparselyBinning, Stacked, Stacking, Summed, Summing, UntypedLabeled, UntypedLabeling
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Container
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type EdType <: Container[EdType] with NoAggregation

    Permalink

    The type of the immutable version of this container.

  2. abstract type Type

    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]

Abstract Value Members

  1. abstract def *(factor: Double): CONTAINER

    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.

  2. abstract def +(that: CONTAINER): CONTAINER

    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.

  3. abstract def children: Seq[Container[_]]

    Permalink

    List of sub-aggregators, to make it possible to walk the tree.

  4. abstract def entries: Double

    Permalink

    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.

  5. abstract def factory: Factory

    Permalink

    Reference to the container's factory for runtime reflection.

  6. abstract def toJsonFragment(suppressName: Boolean): Json

    Permalink

    Used internally to convert the container to JSON without its "type" header.

  7. abstract def zero: CONTAINER

    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.

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

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

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

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

  7. def copy: CONTAINER

    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.

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

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  18. def toImmutable: EdType

    Permalink

    Convert any Container into a NoAggregation Container.

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

  20. def toJsonFile(fileName: String): Unit

    Permalink

  21. def toJsonFile(file: File): Unit

    Permalink

  22. def toJsonString: String

    Permalink

  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped