Packages

c

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, 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. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type Datum = DATUM

    Type of data expected by fill.

    Type of data expected by fill.

    Definition Classes
    SparselyBinning → Aggregation
  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
    SparselyBinning → Container
  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
    SparselyBinning → 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): 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
    SparselyBinning → Container
  4. 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
    SparselyBinning → 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: Long): Option[V]

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

  9. 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
  10. val binWidth: Double
    Definition Classes
    SparselyBinning → Methods
  11. val bins: Map[Long, V]
  12. def checkForCrossReferences(memo: Set[Aggregation] = mutable.Set[Aggregation]()): Unit
    Attributes
    protected
    Definition Classes
    Aggregation
  13. val 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
  14. def children: List[Container[_ >: V with N <: Container[_ >: V with N <: Aggregation with Serializable] 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
    SparselyBinning → Container
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  16. 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
  17. var 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
    SparselyBinning → Container
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(that: Any): Boolean
    Definition Classes
    SparselyBinning → AnyRef → Any
  20. def factory: SparselyBin

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    SparselyBinning → Container
  21. 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
    SparselyBinning → Aggregation
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. def hashCode(): Int
    Definition Classes
    SparselyBinning → AnyRef → Any
  24. def high: Option[Double]
    Definition Classes
    SparselyBinning → Methods
  25. def indexes: Seq[Long]

    Get a sequence of filled indexes.

    Get a sequence of filled indexes.

    Definition Classes
    SparselyBinning → Methods
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def low: Option[Double]
    Definition Classes
    SparselyBinning → Methods
  28. def maxBin: Option[Long]

    The last non-empty bin.

    The last non-empty bin.

    Definition Classes
    SparselyBinning → Methods
  29. def minBin: Option[Long]

    The first non-empty bin.

    The first non-empty bin.

    Definition Classes
    SparselyBinning → Methods
  30. 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
  31. val nanflow: N
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  35. 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
    SparselyBinning → Methods
  36. def numFilled: Int

    The number of non-empty bins.

    The number of non-empty bins.

    Definition Classes
    SparselyBinning → Methods
  37. val origin: Double
    Definition Classes
    SparselyBinning → Methods
  38. val quantity: UserFcn[DATUM, Double]
    Definition Classes
    SparselyBinning → AnyQuantity
  39. 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
    SparselyBinning → Methods
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. def toImmutable: EdType

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container
  42. 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
  43. def toJsonFile(fileName: String): Unit
    Definition Classes
    Container
  44. def toJsonFile(file: File): Unit
    Definition Classes
    Container
  45. 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
    SparselyBinning → Container
  46. def toJsonString: String
    Definition Classes
    Container
  47. def toString(): String
    Definition Classes
    SparselyBinning → AnyRef → Any
  48. val v: V
    Attributes
    protected
  49. def values: Iterable[V]
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  52. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. 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
    SparselyBinning → 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 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 AnyRef

Inherited from Any

Ungrouped