Object

org.dianahep.histogrammar

Bag

Related Doc: package histogrammar

Permalink

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
Visibility
  1. Public
  2. All

Type Members

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def apply[DATUM, RANGE](quantity: UserFcn[DATUM, RANGE], range: String = "")(implicit arg0: ClassTag[RANGE]): Bagging[DATUM, RANGE]

    Permalink

    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.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. val detailedHelp: String

    Permalink

    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
    Bag → Factory

  8. def ed[RANGE](entries: Double, values: Map[RANGE, Double], range: String): Bagged[RANGE]

    Permalink

    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.

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

    Permalink
    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Permalink

    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
    Bag → Factory

  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  15. val help: String

    Permalink

    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
    Bag → Factory

  16. def ing[DATUM, RANGE](quantity: UserFcn[DATUM, RANGE], range: String = "")(implicit arg0: ClassTag[RANGE]): Bagging[DATUM, RANGE]

    Permalink

    Synonym for apply.

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  18. val name: String

    Permalink

    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
    Bag → Factory

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  24. def unapply[DATUM, RANGE](x: Bagging[DATUM, RANGE]): Map[HandleNaN[RANGE], Double]

    Permalink

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

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

    Permalink

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

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Factory

Inherited from AnyRef

Inherited from Any

Ungrouped