Branched

Type Members

type EdType = Branched[HEAD, TAIL]

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

Definition Classes
Branched → Container
type Type = Branched[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
Branched → Container

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def +(that: Branched[HEAD, TAIL]): Branched[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
Branched → 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
Branched → 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 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
Branched → Container
def clone(): AnyRef

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

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

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

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

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

Definition Classes
AnyRef
val tail: TAIL

List of all other Branched objects (or BranchedNil, the end of the list).
List of all other Branched objects (or BranchedNil, the end of the list). Note that concrete instances of Branched 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
Branched → Container
def toJsonString: String

Definition Classes
Container
def toString(): String

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

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

Definition Classes
Branched → BranchedList
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: Branched[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
Branched → BranchedList → Container

Related Doc: package histogrammar

class Branched[HEAD <: Container[HEAD] with NoAggregation, TAIL <: BranchedList] extends Container[Branched[HEAD, TAIL]] with NoAggregation with Collection with BranchedList

Type Members

type EdType = Branched[HEAD, TAIL]

type Type = Branched[HEAD, TAIL]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(that: Branched[HEAD, TAIL]): Branched[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 children: List[Container[_]]

def clone(): AnyRef

def copy: Branched[HEAD, TAIL]

val entries: Double

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def factory: Branch.type

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: Branched[HEAD, TAIL]

Inherited from BranchedList

Inherited from Collection

Inherited from NoAggregation

Inherited from Container[Branched[HEAD, TAIL]]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped