org.dianahep.histogrammar

SparselyBinning

class SparselyBinning[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }, N <: Container[N] with Aggregation { type Datum >: DATUM }] extends Container[SparselyBinning[DATUM, V, N]] with AggregationOnData with NumericalQuantity[DATUM] with Methods

Accumulating a quantity by splitting it into equally spaced bins, filling only one bin per datum and creating new bins as necessary.

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

Linear Supertypes
Methods, NumericalQuantity[DATUM], AnyQuantity[DATUM, Double], AggregationOnData, Aggregation, Container[SparselyBinning[DATUM, V, N]], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SparselyBinning
  2. Methods
  3. NumericalQuantity
  4. AnyQuantity
  5. AggregationOnData
  6. Aggregation
  7. Container
  8. Serializable
  9. Serializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Datum = DATUM

    Type of data expected by fill.

    Type of data expected by fill.

    Definition Classes
    SparselyBinningAggregation
  2. type EdType = SparselyBinned[V.EdType, N.EdType]

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    SparselyBinningContainer
  3. type Type = SparselyBinning[DATUM, 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
    SparselyBinningContainer

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): SparselyBinning[DATUM, 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
    SparselyBinningContainer
  5. def +(that: SparselyBinning[DATUM, V, N]): SparselyBinning[DATUM, 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
    SparselyBinningContainer
  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 at(index: Long): Option[V]

    Extract the container at a given index, if it exists.

  11. def bin(x: Double): Long

    Find the bin index associated with numerical value x.

    Find the bin index associated with numerical value x.

    returns

    Long.MIN_VALUE if x is NaN, the bin index if it is between Long.MIN_VALUE + 1 and Long.MAX_VALUE, otherwise saturate at the endpoints.

    Definition Classes
    Methods
  12. val binWidth: Double

    Width of the equally sized bins.

    Width of the equally sized bins.

    Definition Classes
    SparselyBinningMethods
  13. val bins: Map[Long, V]

    Centers and values of each bin.

  14. def checkForCrossReferences(memo: Set[Aggregation] = mutable.Set[Aggregation]()): Unit

    Attributes
    protected
    Definition Classes
    Aggregation
  15. 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
  16. def children: List[Container[_ >: V with N <: Container[_ >: V with N <: Serializable with Aggregation] with Aggregation { type Datum >: DATUM }] with Aggregation { type Datum >: DATUM }]

    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
    SparselyBinningContainer
  17. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. def copy: SparselyBinning[DATUM, 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
  19. var entries: Double

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

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

    Definition Classes
    SparselyBinningContainer
  20. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    SparselyBinning → AnyRef → Any
  22. def factory: SparselyBin.type

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    SparselyBinningContainer
  23. def fill[SUB <: Datum](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
    SparselyBinningAggregation
  24. def finalize(): Unit

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

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

    Definition Classes
    SparselyBinning → AnyRef → Any
  27. def high: Option[Double]

    Definition Classes
    SparselyBinningMethods
  28. def indexes: Seq[Long]

    Get a sequence of filled indexes.

    Get a sequence of filled indexes.

    Definition Classes
    SparselyBinningMethods
  29. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  30. def low: Option[Double]

    Definition Classes
    SparselyBinningMethods
  31. def maxBin: Option[Long]

    The last non-empty bin.

    The last non-empty bin.

    Definition Classes
    SparselyBinningMethods
  32. def minBin: Option[Long]

    The first non-empty bin.

    The first non-empty bin.

    Definition Classes
    SparselyBinningMethods
  33. 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
  34. val nanflow: N

    Container for data that resulted in NaN.

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

    Definition Classes
    AnyRef
  36. final def notify(): Unit

    Definition Classes
    AnyRef
  37. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  38. def num: Long

    The number of bins between the first non-empty one (inclusive) and the last non-empty one (exclusive).

    The number of bins between the first non-empty one (inclusive) and the last non-empty one (exclusive).

    Definition Classes
    SparselyBinningMethods
  39. def numFilled: Int

    The number of non-empty bins.

    The number of non-empty bins.

    Definition Classes
    SparselyBinningMethods
  40. val origin: Double

    Left edge of the bin whose index is zero.

    Left edge of the bin whose index is zero.

    Definition Classes
    SparselyBinningMethods
  41. val quantity: UserFcn[DATUM, Double]

    Numerical function to split into bins.

    Numerical function to split into bins.

    Definition Classes
    SparselyBinningAnyQuantity
  42. def range(index: Long): (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
    SparselyBinningMethods
  43. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  44. def toImmutable: EdType

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container
  45. 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
  46. def toJsonFile(fileName: String): Unit

    Definition Classes
    Container
  47. def toJsonFile(file: File): Unit

    Definition Classes
    Container
  48. 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
    SparselyBinningContainer
  49. def toJsonString: String

    Definition Classes
    Container
  50. def toString(): String

    Definition Classes
    SparselyBinning → AnyRef → Any
  51. val v: V

    Attributes
    protected
  52. def values: Iterable[V]

  53. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. def zero: SparselyBinning[DATUM, 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
    SparselyBinningContainer

Inherited from Methods

Inherited from NumericalQuantity[DATUM]

Inherited from AnyQuantity[DATUM, Double]

Inherited from AggregationOnData

Inherited from Aggregation

Inherited from Container[SparselyBinning[DATUM, V, N]]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped