object IrregularlyBin extends Factory
Accumulate a suite of aggregators, each between two thresholds, filling exactly one per datum.
This is a variation on org.dianahep.histogrammar.Stack, which fills N + 1 aggregators with N successively tighter cut thresholds. IrregularlyBin fills N + 1 aggregators in the non-overlapping intervals between N thresholds.
IrregularlyBin is also similar to org.dianahep.histogrammar.CentrallyBin, in that they both partition a space into irregular subdomains with no gaps and no overlaps. However, CentrallyBin is defined by bin centers and IrregularlyBin is defined by bin edges, the first and last of which are at negative and positive infinity.
Factory produces mutable org.dianahep.histogrammar.IrregularlyBinning and immutable org.dianahep.histogrammar.IrregularlyBinned objects.
- Alphabetic
- By Inheritance
- IrregularlyBin
- 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 }](bins: Iterable[Double], quantity: UserFcn[DATUM, Double], value: => V = Count(), nanflow: N = Count()): IrregularlyBinning[DATUM, V, N]
Create an empty, mutable org.dianahep.histogrammar.IrregularlyBinning.
Create an empty, mutable org.dianahep.histogrammar.IrregularlyBinning.
- bins
Thresholds that will be used to determine which datum goes into a given container; this list gets sorted, duplicates get removed, and negative infinity gets added as the first element.
- quantity
Numerical quantity whose value is compared with the given thresholds.
- value
Template used to create zero values (by calling this
value'szeromethod).
- 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
- IrregularlyBin → Factory
- def ed[V <: Container[V] with NoAggregation, N <: Container[N] with NoAggregation](entries: Double, bins: Iterable[(Double, V)], nanflow: N): IrregularlyBinned[V, N]
Create an immutable org.dianahep.histogrammar.IrregularlyBinned from arguments (instead of JSON).
Create an immutable org.dianahep.histogrammar.IrregularlyBinned from arguments (instead of JSON).
- entries
Weighted number of entries (sum of all observed weights).
- bins
Lower thresholds and their associated containers, starting with negative infinity.
- nanflow
Container for data that resulted in
NaN.
- 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
- IrregularlyBin → 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
- IrregularlyBin → Factory
- def ing[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }, N <: Container[N] with Aggregation { type Datum >: DATUM }](bins: Iterable[Double], quantity: UserFcn[DATUM, Double], value: => V = Count(), nanflow: N = Count()): IrregularlyBinning[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
- IrregularlyBin → 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)