Aggregation

Mix-in to add mutability to a org.dianahep.histogrammar.Container.

Containers without Aggregation can only be merged with the + operator, but containers with Aggregation can additionally be accumulated with fill.

Containers without Aggregation are named as past-tense verbs, such as "Counted" and "Binned", which containers with Aggregation are named with the gerund form, such as "Counting" and "Binning".

Aggregation is parameterized by the fill data type Datum, which is an abstract type member rather than a type parameter (square brackets) for better type inference.

This data type is implemented as contravariant: a container that expects to be filled with a given data type can accept that data type's subclass.

Linear Supertypes

AnyRef, Any

Known Subclasses

AggregationOnData, Averaging, Bagging, Binning, Branching, Categorizing, CentrallyBinning, Counting, Deviating, Fractioning, Indexing, IrregularlyBinning, Labeling, Maximizing, Minimizing, Selecting, SparselyBinning, Stacking, Summing, UntypedLabeling

Type Members

abstract type Datum

Type of data expected by fill.

Abstract Value Members

abstract def entries_=(x: Double): Unit

The entries member of mutable containers is a var, rather than val.
abstract 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.

Concrete 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
final def asInstanceOf[T0]: T0

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

Attributes
protected
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
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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

trait Aggregation extends AnyRef

Type Members

abstract type Datum

Abstract Value Members

abstract def entries_=(x: Double): Unit

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

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

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

var checkedForCrossReferences: Boolean

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

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 AnyRef

Inherited from Any

Ungrouped