Packages

class Binned[V <: Container[V] with NoAggregation, U <: Container[U] with NoAggregation, O <: Container[O] with NoAggregation, N <: Container[N] with NoAggregation] extends Container[Binned[V, U, O, N]] with NoAggregation with QuantityName with Methods

An accumulated quantity that was split into equally spaced bins between specified limits and filling only one bin per datum.

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

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

Type Members

  1. type EdType = Binned[V, U, O, N]

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    Binned → Container
  2. type Type = Binned[V, U, O, 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
    Binned → Container

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def *(factor: Double): Binned[V, U, O, 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
    Binned → Container
  4. def +(that: Binned[V, U, O, N]): Binned[V, U, O, 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
    Binned → Container
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. 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
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def at(index: Int): V

    Extract the container at a given index.

  9. def bin(x: Double): Int

    Find the bin index associated with numerical value x.

    Find the bin index associated with numerical value x.

    returns

    -1 if x is out of range; the bin index otherwise.

    Definition Classes
    Methods
  10. def children: List[Container[_ >: V with N with O with U <: Container[_ >: V with N with O with U <: NoAggregation with Serializable] 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
    Binned → Container
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  12. def copy: Binned[V, U, O, 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
  13. val entries: Double

    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.

    Definition Classes
    Binned → Container
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(that: Any): Boolean
    Definition Classes
    Binned → AnyRef → Any
  16. def factory: Bin

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    Binned → Container
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. def hashCode(): Int
    Definition Classes
    Binned → AnyRef → Any
  19. val high: Double
    Definition Classes
    Binned → Methods
  20. def indexes: Seq[Int]

    Get a sequence of valid indexes.

    Get a sequence of valid indexes.

    Definition Classes
    Methods
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val low: Double
    Definition Classes
    Binned → Methods
  23. 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
  24. val nanflow: N
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  28. def num: Int

    Number of bins.

    Number of bins.

    Definition Classes
    Binned → Methods
  29. def over(x: Double): Boolean

    Return true iff x is in the overflow region (greater than high).

    Return true iff x is in the overflow region (greater than high).

    Definition Classes
    Methods
  30. val overflow: O
  31. val quantityName: Option[String]
    Definition Classes
    Binned → QuantityName
  32. def range(index: Int): (Double, Double)

    Get the low and high edge of a bin (given by index number).

    Get the low and high edge of a bin (given by index number).

    Definition Classes
    Methods
  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. def toImmutable: EdType

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container
  35. 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
  36. def toJsonFile(fileName: String): Unit
    Definition Classes
    Container
  37. def toJsonFile(file: File): Unit
    Definition Classes
    Container
  38. 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
    Binned → Container
  39. def toJsonString: String
    Definition Classes
    Container
  40. def toString(): String
    Definition Classes
    Binned → AnyRef → Any
  41. def under(x: Double): Boolean

    Return true iff x is in the underflow region (less than low).

    Return true iff x is in the underflow region (less than low).

    Definition Classes
    Methods
  42. val underflow: U
  43. val values: Seq[V]
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. def zero: Binned[V, U, O, 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
    Binned → Container

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Methods

Inherited from QuantityName

Inherited from NoAggregation

Inherited from Container[Binned[V, U, O, N]]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped