SparselyBinned

Type Members

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
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

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
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
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
SparselyBinned → Methods
val bins: SortedMap[Long, V]

Centers and values of each bin.
def children: List[Container[_ >: V with N <: Container[_ >: V with N <: Serializable with NoAggregation] 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
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val contentType: String

Name of the intended content; used as a placeholder in cases with zero bins (due to no observed data).
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
val entries: Double

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

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

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

Definition Classes
SparselyBinned → 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
SparselyBinned → Container
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
SparselyBinned → AnyRef → Any
def high: Option[Double]

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

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

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

Definition Classes
Any
def low: Option[Double]

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

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

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

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

Definition Classes
SparselyBinned → 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
SparselyBinned → Methods
def numFilled: Int

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

Definition Classes
SparselyBinned → Methods
val origin: Double

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

Definition Classes
SparselyBinned → Methods
val quantityName: Option[String]

Optional name given to the quantity function, passed for bookkeeping.
Optional name given to the quantity function, passed for bookkeeping.

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

Definition Classes
Container
def toString(): String

Definition Classes
SparselyBinned → AnyRef → Any
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: 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

Related Doc: package histogrammar

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

Type Members

type EdType = SparselyBinned[V, N]

type Type = SparselyBinned[V, N]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(that: SparselyBinned[V, N]): SparselyBinned[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: SortedMap[Long, V]

def children: List[Container[_ >: V with N <: Container[_ >: V with N <: Serializable with NoAggregation] with NoAggregation] with NoAggregation]

def clone(): AnyRef

val contentType: String

def copy: SparselyBinned[V, N]

val entries: Double

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def factory: SparselyBin.type

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 quantityName: Option[String]

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

def values: Iterable[V]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def zero: SparselyBinned[V, N]

Inherited from Methods

Inherited from QuantityName

Inherited from NoAggregation

Inherited from Container[SparselyBinned[V, N]]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped