Index

Accumulate any number of aggregators of the same type in a list. Every sub-aggregator is filled with every input datum.

This primitive provides an anonymous collection of aggregators (unless the integer index is taken to have special meaning, but generally such bookkeeping should be encoded in strings). Indexes can be nested to create two-dimensional ordinal grids of aggregators. (Use org.dianahep.histogrammar.Bin if the space is to have a metric interpretation.)

Note that all sub-aggregators within an Index must have the same type (e.g. histograms of different binnings, but all histograms). To collect objects of different types, still indexed by integer, use org.dianahep.histogrammar.Branch.

To collect aggregators of the same type with string-based labels, use org.dianahep.histogrammar.Label. To collect aggregators of different types with string-based labels, use org.dianahep.histogrammar.UntypedLabel.

Factory produces mutable org.dianahep.histogrammar.Indexing and immutable org.dianahep.histogrammar.Indexed objects.

Linear Supertypes

Factory, AnyRef, Any

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
def apply[V <: Container[V] with Aggregation](values: V*): Indexing[V]

Create an empty, mutable org.dianahep.histogrammar.Indexing.
Create an empty, mutable org.dianahep.histogrammar.Indexing.
values
Ordered list of containers that can be retrieved by index number.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Help text that can be queried interactively: more detail than help.
Help text that can be queried interactively: more detail than help. (FIXME: currently only contains the apply signature.)

Definition Classes
Index → Factory
def ed[V <: Container[V] with NoAggregation](entries: Double, values: V*): Indexed[V]

Create an immutable org.dianahep.histogrammar.Indexed from arguments (instead of JSON).
Create an immutable org.dianahep.histogrammar.Indexed from arguments (instead of JSON).
entries
Weighted number of entries (sum of all observed weights).
values
Ordered list of containers that can be retrieved by index number.
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] )
def fromJsonFragment(json: Json, nameFromParent: Option[String]): Container[_] with NoAggregation

Reconstructs a container of known type from JSON.
Reconstructs a container of known type from JSON. General users should call the Factory object's fromJson, which uses header data to identify the container type. (This is called by fromJson.)

Definition Classes
Index → Factory
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
val help: String

Help text that can be queried interactively: a one-liner that can be included in a menu.
Help text that can be queried interactively: a one-liner that can be included in a menu.

Definition Classes
Index → Factory
def ing[V <: Container[V] with Aggregation](values: V*): Indexing[V]

Synonym for apply.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val name: String

Name of the concrete Factory as a string; used to label the container type in JSON.
Name of the concrete Factory as a string; used to label the container type in JSON.

Definition Classes
Index → Factory
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( ... )

object Index extends Factory

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def apply[V <: Container[V] with Aggregation](values: V*): Indexing[V]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val detailedHelp: String

def ed[V <: Container[V] with NoAggregation](entries: Double, values: V*): Indexed[V]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fromJsonFragment(json: Json, nameFromParent: Option[String]): Container[_] with NoAggregation

final def getClass(): Class[_]

def hashCode(): Int

val help: String

def ing[V <: Container[V] with Aggregation](values: V*): Indexing[V]

final def isInstanceOf[T0]: Boolean

val name: String

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 Factory

Inherited from AnyRef

Inherited from Any

Ungrouped