IrregularlyBin

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.

Linear Supertypes

Factory, AnyRef, Any

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's zero method).
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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 the apply signature.)

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: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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 Factory object's fromJson, which uses header data to identify the container type. (This is called by fromJson.)

Definition Classes
IrregularlyBin → Factory
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
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 Factory as a string; used to label the container type in JSON.
Name of the concrete Factory as 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
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package histogrammar

object IrregularlyBin extends Factory

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

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]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val detailedHelp: String

def ed[V <: Container[V] with NoAggregation, N <: Container[N] with NoAggregation](entries: Double, bins: Iterable[(Double, V)], nanflow: N): IrregularlyBinned[V, N]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fromJsonFragment(json: Json, nameFromParent: Option[String]): Container[_] with NoAggregation

final def getClass(): Class[_]

def hashCode(): Int

val help: String

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]

final def isInstanceOf[T0]: Boolean

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Factory

Inherited from AnyRef

Inherited from Any

Ungrouped