SparselyBinning

Type Members

type Datum = DATUM

Type of data expected by fill.
Type of data expected by fill.

Definition Classes
SparselyBinning → Aggregation
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
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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
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
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def at(index: Long): Option[V]

Extract the container at a given index, if it exists.
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
val binWidth: Double

Width of the equally sized bins.
Width of the equally sized bins.

Definition Classes
SparselyBinning → Methods
val bins: Map[Long, V]

Centers and values of each bin.
def checkForCrossReferences(memo: Set[Aggregation] = mutable.Set[Aggregation]()): Unit

Attributes
protected
Definition Classes
Aggregation
var 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
def children: List[Container[_ >: V with N <: Container[_ >: V with N <: Serializable with Aggregation] 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
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
var entries: Double

Weighted number of entries (sum of all observed weights).
Weighted number of entries (sum of all observed weights).

Definition Classes
SparselyBinning → Container
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(that: Any): Boolean

Definition Classes
SparselyBinning → AnyRef → Any
def factory: SparselyBin.type

Reference to the container's factory for runtime reflection.
Reference to the container's factory for runtime reflection.

Definition Classes
SparselyBinning → Container
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
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
SparselyBinning → AnyRef → Any
def high: Option[Double]

Definition Classes
SparselyBinning → Methods
def indexes: Seq[Long]

Get a sequence of filled indexes.
Get a sequence of filled indexes.

Definition Classes
SparselyBinning → Methods
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def low: Option[Double]

Definition Classes
SparselyBinning → Methods
def maxBin: Option[Long]

The last non-empty bin.
The last non-empty bin.

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

The first non-empty bin.
The first non-empty bin.

Definition Classes
SparselyBinning → Methods
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
val nanflow: N

Container for data that resulted in NaN.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
def numFilled: Int

The number of non-empty bins.
The number of non-empty bins.

Definition Classes
SparselyBinning → Methods
val origin: Double

Left edge of the bin whose index is zero.
Left edge of the bin whose index is zero.

Definition Classes
SparselyBinning → Methods
val quantity: UserFcn[DATUM, Double]

Numerical function to split into bins.
Numerical function to split into bins.

Definition Classes
SparselyBinning → AnyQuantity
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toImmutable: EdType

Convert any Container into a NoAggregation Container.
Convert any Container into a NoAggregation Container.

Definition Classes
Container
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
def toJsonFile(fileName: String): Unit

Definition Classes
Container
def toJsonFile(file: File): Unit

Definition Classes
Container
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
def toJsonString: String

Definition Classes
Container
def toString(): String

Definition Classes
SparselyBinning → AnyRef → Any
val v: V

Attributes
protected
def values: Iterable[V]
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( ... )
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

Related Doc: package histogrammar

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

Type Members

type Datum = DATUM

type EdType = SparselyBinned[V.EdType, N.EdType]

type Type = SparselyBinning[DATUM, V, N]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(that: SparselyBinning[DATUM, V, N]): SparselyBinning[DATUM, V, N]

final def ==(arg0: Any): Boolean

def as[OTHER <: Container[OTHER]]: OTHER

final def asInstanceOf[T0]: T0

def at(index: Long): Option[V]

def bin(x: Double): Long

val binWidth: Double

val bins: Map[Long, V]

def checkForCrossReferences(memo: Set[Aggregation] = mutable.Set[Aggregation]()): Unit

var checkedForCrossReferences: Boolean

def children: List[Container[_ >: V with N <: Container[_ >: V with N <: Serializable with Aggregation] with Aggregation { type Datum >: DATUM }] with Aggregation { type Datum >: DATUM }]

def clone(): AnyRef

def copy: SparselyBinning[DATUM, V, N]

var entries: Double

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def factory: SparselyBin.type

def fill[SUB <: Datum](datum: SUB, weight: Double = 1.0): Unit

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def high: Option[Double]

def indexes: Seq[Long]

final def isInstanceOf[T0]: Boolean

def low: Option[Double]

def maxBin: Option[Long]

def minBin: Option[Long]

def nan(x: Double): Boolean

val nanflow: N

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def num: Long

def numFilled: Int

val origin: Double

val quantity: UserFcn[DATUM, Double]

def range(index: Long): (Double, Double)

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

def toImmutable: EdType

def toJson: Json

def toJsonFile(fileName: String): Unit

def toJsonFile(file: File): Unit

def toJsonFragment(suppressName: Boolean): JsonObject

def toJsonString: String

def toString(): String

val v: V

def values: Iterable[V]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def zero: SparselyBinning[DATUM, V, N]

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 Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped