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. UsesMath.maxas an underlying function to compute themaximum.- The result is
Long.MIN_VALUEif no values are added.
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
acceptorcombinemethod, it must be synchronized externally.However, it is safe to use
acceptandcombineasaccumulatorandcombinerfunctions ofCollectoron a parallel stream, because the parallel implementation ofStream.collect()provides the necessary partitioning, isolation, and merging of results for safe and efficient parallel execution.- Since:
- 1.1
- See Also:
Math.max(long, long)
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(long value)Updates the state of the statistic to reflect the addition ofvalue.LongMaxcombine(LongMax other)Combines the state of theotherstatistic into this one.static LongMaxcreate()Creates an instance.BigIntegergetAsBigInteger()Gets a result as aBigInteger.doublegetAsDouble()intgetAsInt()Gets the maximum of all input values.longgetAsLong()Gets the maximum of all input values.static LongMaxof(long... values)Returns an instance populated using the inputvalues.-
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.LongConsumer
andThen
-
-
-
-
Method Detail
-
create
public static LongMax create()
Creates an instance.The initial result is
Long.MIN_VALUE.- Returns:
Mininstance.
-
of
public static LongMax of(long... values)
Returns an instance populated using the inputvalues.When the input is an empty array, the result is
Long.MIN_VALUE.- Parameters:
values- Values.- Returns:
Mininstance.
-
accept
public void accept(long value)
Updates the state of the statistic to reflect the addition ofvalue.- Specified by:
acceptin interfaceLongConsumer- 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:
getAsLongin interfaceLongSupplier- Specified by:
getAsLongin interfaceStatisticResult- Returns:
- maximum of all values.
-
getAsInt
public int getAsInt()
Gets the maximum of all input values.This method will throw an
ArithmeticExceptionif thelongmaximum overflows anint; or no values have been added.- Specified by:
getAsIntin interfaceIntSupplier- Specified by:
getAsIntin interfaceStatisticResult- Returns:
- maximum of all values.
- See Also:
Math.toIntExact(long)
-
getAsDouble
public double getAsDouble()
- Specified by:
getAsDoublein interfaceDoubleSupplier
-
getAsBigInteger
public BigInteger getAsBigInteger()
Description copied from interface:StatisticResultGets a result as aBigInteger.The default implementation uses the closest representable
BigIntegervalue of theDoubleSupplier.getAsDouble()result. In the event of ties the result is rounded towards positive infinity. This will raise anArithmeticExceptionif theresultis not finite.- Specified by:
getAsBigIntegerin interfaceStatisticResult- Returns:
- a result
-
combine
public LongMax combine(LongMax other)
Description copied from interface:StatisticAccumulatorCombines the state of theotherstatistic into this one.- Specified by:
combinein interfaceStatisticAccumulator<LongMax>- Parameters:
other- Another statistic to be combined.- Returns:
thisinstance after combiningother.
-
-