Object

org.dianahep.histogrammar

Categorize

Related Doc: package histogrammar

Permalink

object Categorize extends Factory

Split a given quantity by its categorical value and fill only one category per datum.

A bar chart may be thought of as a histogram with string-valued (categorical) bins, so this is the equivalent of org.dianahep.histogrammar.Bin for bar charts. The order of the strings is deferred to the visualization stage.

Unlike org.dianahep.histogrammar.SparselyBin, this aggregator has the potential to use unlimited memory. A large number of distinct categories can generate many unwanted bins.

Factory produces mutable org.dianahep.histogrammar.Categorizing and immutable org.dianahep.histogrammar.Categorized objects.

Linear Supertypes
Factory, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Categorize
  2. Factory
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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, V <: Container[V] with Aggregation { type Datum >: DATUM }](quantity: UserFcn[DATUM, String], value: ⇒ V = Count()): Categorizing[DATUM, V]

    Permalink

    Create an empty, mutable org.dianahep.histogrammar.Categorizing.

    Create an empty, mutable org.dianahep.histogrammar.Categorizing.

    quantity

    Numerical function to split into bins.

    value

    New value (note the =>: expression is reevaluated every time a new value is needed).

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

  8. def ed[V <: Container[V] with NoAggregation](entries: Double, contentType: String, bins: Map[String, V]): Categorized[V]

    Permalink

    Create an immutable org.dianahep.histogrammar.Categorized from arguments (instead of JSON).

    Create an immutable org.dianahep.histogrammar.Categorized from arguments (instead of JSON).

    entries

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

    contentType

    Name of the intended content; used as a placeholder in cases with zero bins (due to no observed data).

    bins

    String category and the associated container of values associated with it.

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

  16. def ing[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }](quantity: UserFcn[DATUM, String], value: ⇒ V = Count()): Categorizing[DATUM, V]

    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
    Categorize → 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. final def wait(): Unit

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

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

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

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

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

Inherited from Factory

Inherited from AnyRef

Inherited from Any

Ungrouped