Class Max

  • All Implemented Interfaces:
    java.util.function.DoubleConsumer, java.util.function.DoubleSupplier, java.util.function.IntSupplier, java.util.function.LongSupplier, DoubleStatistic, StatisticAccumulator<Max>, StatisticResult

    public final class Max
    extends java.lang.Object
    implements DoubleStatistic, StatisticAccumulator<Max>
    Returns the maximum of the available values. Uses Math.max as an underlying function to compute the maximum.
    • The result is negative infinity if no values are added.
    • The result is NaN if any of the values is NaN.
    • The value -0.0 is considered strictly smaller than 0.0.

    This class is designed to work with (though does not require) streams.

    This implementation is not thread safe. If multiple threads access an instance of this class concurrently, and at least one of the threads invokes the accept or combine method, it must be synchronized externally.

    However, it is safe to use accept and combine as accumulator and combiner functions of Collector on a parallel stream, because the parallel implementation of Stream.collect() provides the necessary partitioning, isolation, and merging of results for safe and efficient parallel execution.

    Since:
    1.1
    See Also:
    Math.max(double, double)
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private double maximum
      Current maximum.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Max()
      Create an instance.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void accept​(double value)
      Updates the state of the statistic to reflect the addition of value.
      Max combine​(Max other)
      Combines the state of the other statistic into this one.
      static Max create()
      Creates an instance.
      double getAsDouble()
      Gets the maximum of all input values.
      static Max of​(double... values)
      Returns an instance populated using the input values.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface java.util.function.DoubleConsumer

        andThen
    • Field Detail

      • maximum

        private double maximum
        Current maximum.
    • Constructor Detail

      • Max

        private Max()
        Create an instance.
    • Method Detail

      • create

        public static Max create()
        Creates an instance.

        The initial result is negative infinity.

        Returns:
        Max instance.
      • of

        public static Max of​(double... values)
        Returns an instance populated using the input values.

        The result is NaN if any of the values is NaN.

        When the input is an empty array, the result is negative infinity.

        Parameters:
        values - Values.
        Returns:
        Max instance.
      • accept

        public void accept​(double value)
        Updates the state of the statistic to reflect the addition of value.
        Specified by:
        accept in interface java.util.function.DoubleConsumer
        Parameters:
        value - Value.
      • getAsDouble

        public double getAsDouble()
        Gets the maximum of all input values.

        When no values have been added, the result is negative infinity.

        Specified by:
        getAsDouble in interface java.util.function.DoubleSupplier
        Returns:
        maximum of all values.
      • combine

        public Max combine​(Max other)
        Description copied from interface: StatisticAccumulator
        Combines the state of the other statistic into this one.
        Specified by:
        combine in interface StatisticAccumulator<Max>
        Parameters:
        other - Another statistic to be combined.
        Returns:
        this instance after combining other.