org.dianahep.histogrammar

Bag

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.

Linear Supertypes
Factory, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Bag
  2. Factory
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class DoubleNaN(x: Double) extends HandleNaN[Double] with Product with Serializable

  2. trait HandleNaN[RANGE] extends Ordered[HandleNaN[RANGE]]

  3. case class IgnoreNaN(x: String) extends HandleNaN[String] with Product with Serializable

  4. case class SeqNaN[RANGE](components: Double*) extends HandleNaN[RANGE] with Seq[Double] with Product with Serializable

Value Members

  1. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  3. final def ##(): Int

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

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

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

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. 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
    BagFactory
  10. 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 None if they were dropped.

    range

    The data type: "N" for number, "N#" where "#" is a positive integer for vector of numbers, or "S" for string.

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  17. 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
    BagFactory
  18. def ing[DATUM, RANGE](quantity: UserFcn[DATUM, RANGE], range: String = "")(implicit arg0: ClassTag[RANGE]): Bagging[DATUM, RANGE]

    Synonym for apply.

  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  20. 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
    BagFactory
  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  25. def toString(): String

    Definition Classes
    AnyRef → Any
  26. def unapply[DATUM, RANGE](x: Bagging[DATUM, RANGE]): Map[HandleNaN[RANGE], Double]

    Use org.dianahep.histogrammar.Bagging in Scala pattern-matching.

  27. def unapply[RANGE](x: Bagged[RANGE]): Map[HandleNaN[RANGE], Double]

    Use org.dianahep.histogrammar.Bagged in Scala pattern-matching.

  28. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Factory

Inherited from AnyRef

Inherited from Any

Ungrouped