object Bag extends Factory
Accumulate raw numbers, vectors of numbers, or strings, with identical values merged.
A bag is the appropriate data type for scatter plots: a container that collects raw values, maintaining multiplicity but not order. (A "bag" is also known as a "multiset.") Conceptually, it is a mapping from distinct raw values to the number of observations: when two instances of the same raw value are observed, one key is stored and their weights add.
Although the user-defined function may return scalar numbers, fixed-dimension vectors of numbers, or categorical strings, it may not mix range types. For the purposes of Label and Index (which can only collect aggregators of a single type), bags with different ranges are different types.
Factory produces mutable org.dianahep.histogrammar.Bagging and immutable org.dianahep.histogrammar.Bagged objects.
- Alphabetic
- By Inheritance
- Bag
- Factory
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- case class DoubleNaN(x: Double) extends HandleNaN[Double] with Product with Serializable
- trait HandleNaN[RANGE] extends Ordered[HandleNaN[RANGE]]
- case class IgnoreNaN(x: String) extends HandleNaN[String] with Product with Serializable
- case class SeqNaN[RANGE](components: Double*) extends HandleNaN[RANGE] with Seq[Double] with Product with Serializable
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
- def apply[DATUM, RANGE](quantity: UserFcn[DATUM, RANGE], range: String = "")(implicit arg0: ClassTag[RANGE]): Bagging[DATUM, RANGE]
Create an empty, mutable org.dianahep.histogrammar.Bagging.
Create an empty, mutable org.dianahep.histogrammar.Bagging.
- quantity
Function that produces numbers, vectors of numbers, or strings.
- range
The data type: "N" for number, "N#" where "#" is a positive integer for vector of numbers, or "S" for string.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- val detailedHelp: String
Help text that can be queried interactively: more detail than
help. - def ed[RANGE](entries: Double, values: Map[RANGE, Double], range: String): Bagged[RANGE]
Create an immutable org.dianahep.histogrammar.Bagged from arguments (instead of JSON).
Create an immutable org.dianahep.histogrammar.Bagged from arguments (instead of JSON).
- entries
Weighted number of entries (sum of all observed weights).
- values
Distinct multidimensional vectors and the (weighted) number of times they were observed or
Noneif they were dropped.- range
The data type: "N" for number, "N#" where "#" is a positive integer for vector of numbers, or "S" for string.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fromJsonFragment(json: Json, nameFromParent: Option[String]): Container[_] with NoAggregation
Reconstructs a container of known type from JSON.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val help: String
Help text that can be queried interactively: a one-liner that can be included in a menu.
- def ing[DATUM, RANGE](quantity: UserFcn[DATUM, RANGE], range: String = "")(implicit arg0: ClassTag[RANGE]): Bagging[DATUM, RANGE]
Synonym for
apply. - final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val name: String
Name of the concrete
Factoryas a string; used to label the container type in JSON. - final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unapply[DATUM, RANGE](x: Bagging[DATUM, RANGE]): Map[HandleNaN[RANGE], Double]
Use org.dianahep.histogrammar.Bagging in Scala pattern-matching.
- def unapply[RANGE](x: Bagged[RANGE]): Map[HandleNaN[RANGE], Double]
Use org.dianahep.histogrammar.Bagged in Scala pattern-matching.
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)