Class

org.dianahep.histogrammar

CentrallyBinned

Related Doc: package histogrammar

Permalink

class CentrallyBinned[V <: Container[V] with NoAggregation, N <: Container[N] with NoAggregation] extends Container[CentrallyBinned[V, N]] with NoAggregation with QuantityName with Methods[V]

An accumulated quantity that was split into bins defined by bin centers, filling only one datum per bin with no overflows or underflows.

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

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

Type Members

  1. type EdType = CentrallyBinned[V, N]

    Permalink

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    CentrallyBinnedContainer
  2. type Type = CentrallyBinned[V, N]

    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
    CentrallyBinnedContainer

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): CentrallyBinned[V, N]

    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
    CentrallyBinnedContainer
  4. def +(that: CentrallyBinned[V, N]): CentrallyBinned[V, N]

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

    Permalink
    Definition Classes
    AnyRef → Any
  6. 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
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. val bins: Seq[(Double, V)]

    Permalink

    Metric, sorted map of centers and values for each bin.

    Metric, sorted map of centers and values for each bin.

    Definition Classes
    CentrallyBinnedMethods
  9. def center(x: Double): Double

    Permalink

    Return the exact center of the bin that x belongs to.

    Return the exact center of the bin that x belongs to.

    Definition Classes
    Methods
  10. def centers: Seq[Double]

    Permalink

    Iterable over the centers of each bin.

    Iterable over the centers of each bin.

    Definition Classes
    Methods
  11. def centersSet: Set[Double]

    Permalink

    Set of centers of each bin.

    Set of centers of each bin.

    Definition Classes
    Methods
  12. def children: List[Container[_ >: V with N <: Container[_ >: V with N <: Serializable with NoAggregation] with NoAggregation] with NoAggregation]

    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
    CentrallyBinnedContainer
  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def copy: CentrallyBinned[V, N]

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

    Permalink

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

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

    Definition Classes
    CentrallyBinnedMethodsContainer
  16. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    CentrallyBinned → AnyRef → Any
  18. def factory: CentrallyBin.type

    Permalink

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    CentrallyBinnedContainer
  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Permalink
    Definition Classes
    CentrallyBinned → AnyRef → Any
  22. def index(x: Double): Int

    Permalink
    Definition Classes
    Methods
  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. def nan(x: Double): Boolean

    Permalink

    Return true iff x is in the nanflow region (equal to NaN).

    Return true iff x is in the nanflow region (equal to NaN).

    Definition Classes
    Methods
  25. val nanflow: N

    Permalink

    Container for data that resulted in NaN.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  29. 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
    CentrallyBinnedQuantityName
  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
    CentrallyBinnedContainer
  36. def toJsonString: String

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

    Permalink
    Definition Classes
    CentrallyBinned → AnyRef → Any
  38. def value(x: Double): V

    Permalink

    Return the aggregator at the center of the bin that x belongs to.

    Return the aggregator at the center of the bin that x belongs to.

    Definition Classes
    Methods
  39. def values: Seq[V]

    Permalink

    Iterable over the containers associated with each bin.

    Iterable over the containers associated with each bin.

    Definition Classes
    Methods
  40. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. def zero: CentrallyBinned[V, N]

    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
    CentrallyBinnedContainer

Inherited from Methods[V]

Inherited from QuantityName

Inherited from NoAggregation

Inherited from Container[CentrallyBinned[V, N]]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped