Packages

class Maximizing[DATUM] extends Container[Maximizing[DATUM]] with AggregationOnData with NumericalQuantity[DATUM]

Accumulating the maximum of a given quantity. If no data are observed, the result is NaN.

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

Linear Supertypes
NumericalQuantity[DATUM], AnyQuantity[DATUM, Double], AggregationOnData, Aggregation, Container[Maximizing[DATUM]], Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Maximizing
  2. NumericalQuantity
  3. AnyQuantity
  4. AggregationOnData
  5. Aggregation
  6. Container
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type Datum = DATUM

    Type of data expected by fill.

    Type of data expected by fill.

    Definition Classes
    Maximizing → Aggregation
  2. type EdType = Maximized

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    Maximizing → Container
  3. type Type = Maximizing[DATUM]

    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
    Maximizing → Container

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def *(factor: Double): Maximizing[DATUM]

    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
    Maximizing → Container
  4. def +(that: Maximizing[DATUM]): Maximizing[DATUM]

    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
    Maximizing → Container
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def as[OTHER <: Container[OTHER]]: OTHER

    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
    Definition Classes
    Any
  8. def checkForCrossReferences(memo: Set[Aggregation] = mutable.Set[Aggregation]()): Unit
    Attributes
    protected
    Definition Classes
    Aggregation
  9. val checkedForCrossReferences: Boolean

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

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

    Attributes
    protected
    Definition Classes
    Aggregation
  10. def children: Nil

    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
    Maximizing → Container
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  12. def copy: Maximizing[DATUM]

    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
  13. var entries: Double

    Every Container accumulates a sum of weights of observed data.

    Every Container accumulates a sum of weights of observed data.

    The org.dianahep.histogrammar.Counting/org.dianahep.histogrammar.Counted container only accumulates a sum of weights.

    Its data type is Double because in principal, it can be any non-negative real number.

    Definition Classes
    Maximizing → Container
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(that: Any): Boolean
    Definition Classes
    Maximizing → AnyRef → Any
  16. def factory: Maximize

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    Maximizing → Container
  17. def fill[SUB <: Datum](datum: SUB, weight: Double = 1.0): Unit

    Entry point for the general user to pass data into the container for aggregation.

    Entry point for the general user to pass data into the container for aggregation.

    Usually all containers in a collection of histograms take the same input data by passing it recursively through the tree. Quantities to plot are specified by the individual container's lambda functions.

    The container is changed in-place.

    Definition Classes
    Maximizing → Aggregation
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. def hashCode(): Int
    Definition Classes
    Maximizing → AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. var max: Double
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  25. val quantity: UserFcn[DATUM, Double]
    Definition Classes
    Maximizing → AnyQuantity
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toImmutable: EdType

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container
  28. def toJson: Json

    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
    Definition Classes
    Container
  30. def toJsonFile(file: File): Unit
    Definition Classes
    Container
  31. def toJsonFragment(suppressName: Boolean): JsonObject

    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
    Maximizing → Container
  32. def toJsonString: String
    Definition Classes
    Container
  33. def toString(): String
    Definition Classes
    Maximizing → AnyRef → Any
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. def zero: Maximizing[DATUM]

    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
    Maximizing → Container

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from NumericalQuantity[DATUM]

Inherited from AnyQuantity[DATUM, Double]

Inherited from AggregationOnData

Inherited from Aggregation

Inherited from Container[Maximizing[DATUM]]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped