Class

org.dianahep.histogrammar

Maximized

Related Doc: package histogrammar

Permalink

class Maximized extends Container[Maximized] with NoAggregation with QuantityName

An accumulated 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
QuantityName, NoAggregation, Container[Maximized], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Maximized
  2. QuantityName
  3. NoAggregation
  4. Container
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type EdType = Maximized

    Permalink

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    MaximizedContainer
  2. type Type = Maximized

    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
    MaximizedContainer

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): Maximized

    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
    MaximizedContainer
  4. def +(that: Maximized): Maximized

    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
    MaximizedContainer
  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: Nil.type

    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
    MaximizedContainer
  9. def clone(): AnyRef

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

    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 entries: Double

    Permalink

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

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

    Definition Classes
    MaximizedContainer
  12. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    Maximized → AnyRef → Any
  14. def factory: Maximize.type

    Permalink

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    MaximizedContainer
  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Maximized → AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. val max: Double

    Permalink

    Highest observed value.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  23. val quantityName: Option[String]

    Permalink

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

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

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

    Permalink
    Definition Classes
    AnyRef
  25. def toImmutable: EdType

    Permalink

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container
  26. 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
  27. def toJsonFile(fileName: String): Unit

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

    Permalink
    Definition Classes
    Container
  29. 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
    MaximizedContainer
  30. def toJsonString: String

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

    Permalink
    Definition Classes
    Maximized → AnyRef → Any
  32. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def zero: Maximized

    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
    MaximizedContainer

Inherited from QuantityName

Inherited from NoAggregation

Inherited from Container[Maximized]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped