object SparselyBin extends Factory
Split a quantity into equally spaced bins, creating them whenever their entries would be non-zero. Exactly one sub-aggregator is filled per datum.
Use this when you have a distribution of known scale (bin width) but unknown domain (lowest and highest bin index).
Unlike fixed-domain binning, this aggregator has the potential to use unlimited memory. A large number of distinct outliers can generate many unwanted bins.
Like fixed-domain binning, the bins are indexed by integers, though they are 64-bit and may be negative. Bin indexes below -(2**63 - 1) are put in the -(2**63 - 1) are bin and indexes above (2**63 - 1) are put in the (2**63 - 1) bin.
Factory produces mutable org.dianahep.histogrammar.SparselyBinning and immutable org.dianahep.histogrammar.SparselyBinned objects.
- Alphabetic
- By Inheritance
- SparselyBin
- Factory
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }, N <: Container[N] with Aggregation { type Datum >: DATUM }](binWidth: Double, quantity: UserFcn[DATUM, Double], value: => V = Count(), nanflow: N = Count(), origin: Double = 0.0): SparselyBinning[DATUM, V, N]
Create an empty, mutable org.dianahep.histogrammar.SparselyBinning.
Create an empty, mutable org.dianahep.histogrammar.SparselyBinning.
- binWidth
Width of the equally sized bins.
- quantity
Numerical function to split into bins.
- value
Template used to create zero values (by calling this
value'szeromethod).- nanflow
Container for data that resulted in
NaN.- origin
Left edge of the bin whose index is zero.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- val detailedHelp: String
Help text that can be queried interactively: more detail than
help.Help text that can be queried interactively: more detail than
help. (FIXME: currently only contains theapplysignature.)- Definition Classes
- SparselyBin → Factory
- def ed[V <: Container[V] with NoAggregation, N <: Container[N] with NoAggregation](binWidth: Double, entries: Double, contentType: String, bins: SortedMap[Long, V], nanflow: N, origin: Double): SparselyBinned[V, N]
Create an immutable org.dianahep.histogrammar.SparselyBinned from arguments (instead of JSON).
Create an immutable org.dianahep.histogrammar.SparselyBinned from arguments (instead of JSON).
- binWidth
Width of the equally sized bins.
- entries
Weighted number of entries (sum of all observed weights).
- contentType
Name of the intended content; used as a placeholder in cases with zero bins (due to no observed data).
- bins
Centers and values of each bin.
- nanflow
Container for data that resulted in
NaN.- origin
Left edge of the bin whose index is zero.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fromJsonFragment(json: Json, nameFromParent: Option[String]): Container[_] with NoAggregation
Reconstructs a container of known type from JSON.
Reconstructs a container of known type from JSON. General users should call the
Factoryobject'sfromJson, which uses header data to identify the container type. (This is called byfromJson.)- Definition Classes
- SparselyBin → Factory
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val help: String
Help text that can be queried interactively: a one-liner that can be included in a menu.
Help text that can be queried interactively: a one-liner that can be included in a menu.
- Definition Classes
- SparselyBin → Factory
- def ing[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }, N <: Container[N] with Aggregation { type Datum >: DATUM }](binWidth: Double, quantity: UserFcn[DATUM, Double], value: => V = Count(), nanflow: N = Count(), origin: Double = 0.0): SparselyBinning[DATUM, V, N]
Synonym for
apply. - final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val name: String
Name of the concrete
Factoryas a string; used to label the container type in JSON.Name of the concrete
Factoryas a string; used to label the container type in JSON.- Definition Classes
- SparselyBin → Factory
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)