Class LongMax

java.lang.Object
org.apache.commons.statistics.descriptive.LongMax
All Implemented Interfaces:
DoubleSupplier, IntSupplier, LongConsumer, LongSupplier, LongStatistic, StatisticAccumulator<LongMax>, StatisticResult
public final class LongMax extends Object implements LongStatistic, StatisticAccumulator<LongMax>
Returns the maximum of the available values. Uses Math.max as an underlying function to compute the maximum.

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:

  • Field Details

    • maximum

      private long maximum
      Current maximum.

  • Constructor Details

    • LongMax

      private LongMax()
      Create an instance.

  • Method Details

    • create

      public static LongMax create()
      Creates an instance.

      The initial result is Long.MIN_VALUE.

      Returns:
      LongMax instance.

    • of

      public static LongMax of(long... values)
      Returns an instance populated using the input values.

      When the input is an empty array, the result is Long.MIN_VALUE.

      Parameters:
      values - Values.
      Returns:
      LongMax instance.

    • ofRange

      public static LongMax ofRange(long[] values, int from, int to)
      Returns an instance populated using the specified range of values.

      When the range is empty, the result is Long.MIN_VALUE.

      Parameters:
      values - Values.
      from - Inclusive start of the range.
      to - Exclusive end of the range.
      Returns:
      LongMax instance.
      Throws:
      IndexOutOfBoundsException - if the sub-range is out of bounds
      Since:
      1.2

    • createFromRange

      static LongMax createFromRange(long[] values, int from, int to)
      Create an instance using the specified range of values.

      Warning: No range checks are performed.

      Parameters:
      values - Values.
      from - Inclusive start of the range.
      to - Exclusive end of the range.
      Returns:
      LongMax instance.

    • accept

      public void accept(long value)
      Updates the state of the statistic to reflect the addition of value.
      Specified by:
      accept in interface LongConsumer
      Parameters:
      value - Value.

    • getAsLong

      public long getAsLong()
      Gets the maximum of all input values.

      When no values have been added, the result is Long.MIN_VALUE.

      Specified by:
      getAsLong in interface LongSupplier
      Specified by:
      getAsLong in interface StatisticResult
      Returns:
      maximum of all values.

    • getAsInt

      public int getAsInt()
      Gets the maximum of all input values.

      This method will throw an ArithmeticException if the long maximum overflows an int; or no values have been added.

      Specified by:
      getAsInt in interface IntSupplier
      Specified by:
      getAsInt in interface StatisticResult
      Returns:
      maximum of all values.
      See Also:

    • getAsDouble

      public double getAsDouble()
      Specified by:
      getAsDouble in interface DoubleSupplier

    • getAsBigInteger

      public BigInteger getAsBigInteger()
      Description copied from interface: StatisticResult
      Gets a result as a BigInteger.

      The default implementation uses the closest representable BigInteger value of the DoubleSupplier.getAsDouble() result. In the event of ties the result is rounded towards positive infinity. This will raise an ArithmeticException if the result is not finite.

      Specified by:
      getAsBigInteger in interface StatisticResult
      Returns:
      a result

    • combine

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