Branching

Type Members

type Datum = HEAD.Datum

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

Definition Classes
Branching → Aggregation
type EdType = Branched[HEAD.EdType, TAIL.EdType]

The type of the immutable version of this container.
The type of the immutable version of this container.

Definition Classes
Branching → BranchingList → Container
type Type = Branching[HEAD, TAIL]

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
Branching → Container

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def *(factor: Double): Branching[HEAD, TAIL]

Reweight the contents in all nested aggregators by a scalar factor, as though they had been filled with a different weight.
Reweight the contents in all nested aggregators by a scalar factor, as though they had been filled with a different weight.
If the container is mutable (with org.dianahep.histogrammar.Aggregation), the new one will be, too.
The original is unaffected.

Definition Classes
Branching → Container
def +(that: Branching[HEAD, TAIL]): Branching[HEAD, TAIL]

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
Branching → Container
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def apply(indexes: CollectionIndex*): Container[_]

Attempt to get key indexes, throwing an exception if it does not exist.
Attempt to get key indexes, throwing an exception if it does not exist.

Definition Classes
Branching → Collection
def apply(index: CollectionIndex): Container[_]

Attempt to get key index, throwing an exception if it does not exist.
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 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[_]]

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
Branching → Container
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def copy: Branching[HEAD, TAIL]

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
Branching → Container
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
Branching → AnyRef → Any
def factory: Branch.type

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

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get(i: Int): Option[Container[_]]

Attempt to get index i, returning None if it does not exist.
Attempt to get index i, returning None if it does not exist.

Definition Classes
Branching → BranchingList
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getOrElse(i: Int, default: ⇒ Container[_]): Container[_]

Attempt to get index i, returning an alternative if it does not exist.
def hashCode(): Int

Definition Classes
Branching → AnyRef → Any
val head: HEAD

Container associated with the first item in the list.
def indexes: Seq[Seq[CollectionIndex]]

Definition Classes
Collection
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
def size: Int

Return the number of containers.
Return the number of containers.

Definition Classes
Branching → BranchingList
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tail: TAIL

List of all other Branching objects (or BranchingNil, the end of the list).
List of all other Branching objects (or BranchingNil, the end of the list). Note that concrete instances of Branching implicitly have fields i0 through i9, which are shortcuts to the first ten items.
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
Branching → Container
def toJsonString: String

Definition Classes
Container
def toString(): String

Definition Classes
Branching → AnyRef → Any
def values: List[Container[_]]

List the containers (dropping type information).
List the containers (dropping type information).

Definition Classes
Branching → BranchingList
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 walk[X](op: (Seq[CollectionIndex]) ⇒ X): Seq[X]

Definition Classes
Collection
def zero: Branching[HEAD, TAIL]

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
Branching → BranchingList → Container

Related Doc: package histogrammar

class Branching[HEAD <: Container[HEAD] with Aggregation, TAIL <: BranchingList] extends Container[Branching[HEAD, TAIL]] with AggregationOnData with Collection with BranchingList

Type Members

type Datum = HEAD.Datum

type EdType = Branched[HEAD.EdType, TAIL.EdType]

type Type = Branching[HEAD, TAIL]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def *(factor: Double): Branching[HEAD, TAIL]

def +(that: Branching[HEAD, TAIL]): Branching[HEAD, TAIL]

final def ==(arg0: Any): Boolean

def apply(indexes: CollectionIndex*): Container[_]

def apply(index: CollectionIndex): Container[_]

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

final def asInstanceOf[T0]: T0

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

var checkedForCrossReferences: Boolean

def children: List[Container[_]]

def clone(): AnyRef

def copy: Branching[HEAD, TAIL]

var entries: Double

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def factory: Branch.type

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

def finalize(): Unit

def get(i: Int): Option[Container[_]]

final def getClass(): Class[_]

def getOrElse(i: Int, default: ⇒ Container[_]): Container[_]

def hashCode(): Int

val head: HEAD

def indexes: Seq[Seq[CollectionIndex]]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def size: Int

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

val tail: TAIL

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: List[Container[_]]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def walk[X](op: (Seq[CollectionIndex]) ⇒ X): Seq[X]

def zero: Branching[HEAD, TAIL]

Inherited from BranchingList

Inherited from Collection

Inherited from AggregationOnData

Inherited from Aggregation

Inherited from Container[Branching[HEAD, TAIL]]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped