Class

org.dianahep.histogrammar

Fractioned

Related Doc: package histogrammar

Permalink

class Fractioned[N <: Container[N], D <: Container[D]] extends Container[Fractioned[N, D]] with NoAggregation with QuantityName with Methods

An accumulated pair of containers, one with all data (denominator), and one with data that passed a given selection (numerator).

Use the factory org.dianahep.histogrammar.Fraction to construct an instance.

Linear Supertypes
Methods, QuantityName, NoAggregation, Container[Fractioned[N, D]], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Fractioned
  2. Methods
  3. QuantityName
  4. NoAggregation
  5. Container
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type EdType = Fractioned[N, D]

    Permalink

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    FractionedContainer
  2. type Type = Fractioned[N, D]

    Permalink

    Intended for the general user to copy a complex container's type into the as method of a container whose type is not known at compile-time.

    Intended for the general user to copy a complex container's type into the as method of a container whose type is not known at compile-time.

    Typical use: filledHistogram.as[initialHistogram.Type]

    Definition Classes
    FractionedContainer

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def *(factor: Double): Fractioned[N, D]

    Permalink

    Reweight the contents in all nested aggregators by a scalar factor, as though they had been filled with a different weight.

    Reweight the contents in all nested aggregators by a scalar factor, as though they had been filled with a different weight.

    If the container is mutable (with org.dianahep.histogrammar.Aggregation), the new one will be, too.

    The original is unaffected.

    Definition Classes
    FractionedContainer
  4. def +(that: Fractioned[N, D]): Fractioned[N, D]

    Permalink

    Add two containers of the same type.

    Add two containers of the same type.

    If these containers are mutable (with org.dianahep.histogrammar.Aggregation), the new one will be, too.

    The originals are unaffected.

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

    Permalink
    Definition Classes
    AnyRef → Any
  6. def as[OTHER <: Container[OTHER]]: OTHER

    Permalink

    Cast the container to a given type.

    Cast the container to a given type. Especially useful for containers reconstructed from JSON or stored in org.dianahep.histogrammar.UntypedLabeling/org.dianahep.histogrammar.UntypedLabeled.

    Definition Classes
    Container
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def children: List[Container[_ >: D with N <: Container[_ >: D with N <: Serializable]]]

    Permalink

    List of sub-aggregators, to make it possible to walk the tree.

    List of sub-aggregators, to make it possible to walk the tree.

    Definition Classes
    FractionedContainer
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def copy: Fractioned[N, D]

    Permalink

    Copy this container, making a clone with no reference to the original.

    Copy this container, making a clone with no reference to the original.

    If these containers are mutable (with org.dianahep.histogrammar.Aggregation), the new one will be, too.

    Definition Classes
    Container
  11. val denominator: D

    Permalink

    Container for all data, regardless of whether it passed the given selection.

  12. val entries: Double

    Permalink

    Weighted number of entries (sum of all observed weights without the cut applied).

    Weighted number of entries (sum of all observed weights without the cut applied).

    Definition Classes
    FractionedContainer
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(that: Any): Boolean

    Permalink
    Definition Classes
    Fractioned → AnyRef → Any
  15. def factory: Fraction.type

    Permalink

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    FractionedContainer
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def fractionPassing: Double

    Permalink

    Fraction of weights that pass the quantity.

    Fraction of weights that pass the quantity.

    Definition Classes
    FractionedMethods
  18. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Fractioned → AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  24. val numerator: N

    Permalink

    Container for data that passed the given selection.

  25. val quantityName: Option[String]

    Permalink

    Optional name given to the selection function, passed for bookkeeping.

    Optional name given to the selection function, passed for bookkeeping.

    Definition Classes
    FractionedQuantityName
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. def toImmutable: EdType

    Permalink

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container
  28. def toJson: Json

    Permalink

    Convert this container to JSON (dropping its fill method, making it immutable).

    Convert this container to JSON (dropping its fill method, making it immutable).

    Note that the org.dianahep.histogrammar.json.Json object has a stringify method to serialize.

    Definition Classes
    Container
  29. def toJsonFile(fileName: String): Unit

    Permalink
    Definition Classes
    Container
  30. def toJsonFile(file: File): Unit

    Permalink
    Definition Classes
    Container
  31. def toJsonFragment(suppressName: Boolean): JsonObject

    Permalink

    Used internally to convert the container to JSON without its "type" header.

    Used internally to convert the container to JSON without its "type" header.

    Definition Classes
    FractionedContainer
  32. def toJsonString: String

    Permalink
    Definition Classes
    Container
  33. def toString(): String

    Permalink
    Definition Classes
    Fractioned → AnyRef → Any
  34. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def zero: Fractioned[N, D]

    Permalink

    Create an empty container with the same parameters as this one.

    Create an empty container with the same parameters as this one.

    If this container is mutable (with org.dianahep.histogrammar.Aggregation), the new one will be, too.

    The original is unaffected.

    Definition Classes
    FractionedContainer

Inherited from Methods

Inherited from QuantityName

Inherited from NoAggregation

Inherited from Container[Fractioned[N, D]]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped