org.dianahep.histogrammar

CentrallyBinned

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
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type EdType = CentrallyBinned[V, N]

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    CentrallyBinned → Container

  2. type Type = CentrallyBinned[V, N]

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

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

  5. def +(that: CentrallyBinned[V, N]): CentrallyBinned[V, N]

    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
    CentrallyBinned → 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. val bins: Seq[(Double, V)]

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

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

    Definition Classes
    CentrallyBinned → Methods

  11. def center(x: Double): Double

    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

  12. def centers: Seq[Double]

    Iterable over the centers of each bin.

    Iterable over the centers of each bin.

    Definition Classes
    Methods

  13. def centersSet: Set[Double]

    Set of centers of each bin.

    Set of centers of each bin.

    Definition Classes
    Methods

  14. def children: List[Container[_ >: V with N <: Container[_ >: V with N <: Serializable with NoAggregation] with NoAggregation] with NoAggregation]

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

  15. def clone(): AnyRef

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

  16. def copy: CentrallyBinned[V, N]

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

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

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

    Definition Classes
    CentrallyBinned → Methods → Container

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

    Definition Classes
    AnyRef

  19. def equals(that: Any): Boolean

    Definition Classes
    CentrallyBinned → AnyRef → Any

  20. def factory: CentrallyBin.type

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    CentrallyBinned → Container

  21. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  23. def hashCode(): Int

    Definition Classes
    CentrallyBinned → AnyRef → Any

  24. def index(x: Double): Int

    Definition Classes
    Methods

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  26. def nan(x: Double): Boolean

    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

  27. val nanflow: N

    Container for data that resulted in NaN.

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

    Definition Classes
    AnyRef

  29. final def notify(): Unit

    Definition Classes
    AnyRef

  30. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  31. val quantityName: Option[String]

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

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

    Definition Classes
    CentrallyBinned → QuantityName

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

    Definition Classes
    AnyRef

  33. def toImmutable: EdType

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container

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

  35. def toJsonFile(fileName: String): Unit

    Definition Classes
    Container

  36. def toJsonFile(file: File): Unit

    Definition Classes
    Container

  37. 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
    CentrallyBinned → Container

  38. def toJsonString: String

    Definition Classes
    Container

  39. def toString(): String

    Definition Classes
    CentrallyBinned → AnyRef → Any

  40. def value(x: Double): V

    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

  41. def values: Seq[V]

    Iterable over the containers associated with each bin.

    Iterable over the containers associated with each bin.

    Definition Classes
    Methods

  42. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  45. def zero: CentrallyBinned[V, N]

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

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