Packages

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

An accumulated quantity that was split 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, QuantityName, NoAggregation, Container[SparselyBinned[V, N]], Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SparselyBinned
  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 = SparselyBinned[V, N]

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    SparselyBinned → Container
  2. type Type = SparselyBinned[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
    SparselyBinned → 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): SparselyBinned[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
    SparselyBinned → Container
  4. def +(that: SparselyBinned[V, N]): SparselyBinned[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
    SparselyBinned → 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
    SparselyBinned → Methods
  11. val bins: SortedMap[Long, V]
  12. def children: List[Container[_ >: V with N <: Container[_ >: V with N <: 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
    SparselyBinned → Container
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  14. val contentType: String
  15. def copy: SparselyBinned[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
  16. 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
    SparselyBinned → Container
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(that: Any): Boolean
    Definition Classes
    SparselyBinned → AnyRef → Any
  19. def factory: SparselyBin

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    SparselyBinned → Container
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def hashCode(): Int
    Definition Classes
    SparselyBinned → AnyRef → Any
  22. def high: Option[Double]
    Definition Classes
    SparselyBinned → Methods
  23. def indexes: Seq[Long]

    Get a sequence of filled indexes.

    Get a sequence of filled indexes.

    Definition Classes
    SparselyBinned → Methods
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def low: Option[Double]
    Definition Classes
    SparselyBinned → Methods
  26. def maxBin: Option[Long]

    The last non-empty bin.

    The last non-empty bin.

    Definition Classes
    SparselyBinned → Methods
  27. def minBin: Option[Long]

    The first non-empty bin.

    The first non-empty bin.

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

    The number of non-empty bins.

    The number of non-empty bins.

    Definition Classes
    SparselyBinned → Methods
  35. val origin: Double
    Definition Classes
    SparselyBinned → Methods
  36. val quantityName: Option[String]
    Definition Classes
    SparselyBinned → QuantityName
  37. 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
    SparselyBinned → Methods
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toImmutable: EdType

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

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

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped