Class Max
- java.lang.Object
-
- org.apache.commons.statistics.descriptive.Max
-
- All Implemented Interfaces:
DoubleConsumer,DoubleSupplier,IntSupplier,LongSupplier,DoubleStatistic,StatisticAccumulator<Max>,StatisticResult
public final class Max extends Object implements DoubleStatistic, StatisticAccumulator<Max>
Returns the maximum of the available values. UsesMath.maxas an underlying function to compute themaximum.- The result is
negative infinityif no values are added. - The result is
NaNif any of the values isNaN. - The value
-0.0is considered strictly smaller than0.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
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(double, double)
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(double value)Updates the state of the statistic to reflect the addition ofvalue.Maxcombine(Max other)Combines the state of theotherstatistic into this one.static Maxcreate()Creates an instance.doublegetAsDouble()Gets the maximum of all input values.static Maxof(double... 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.DoubleConsumer
andThen
-
Methods inherited from interface org.apache.commons.statistics.descriptive.StatisticResult
getAsBigInteger, getAsInt, getAsLong
-
-
-
-
Method Detail
-
create
public static Max create()
Creates an instance.The initial result is
negative infinity.- Returns:
Maxinstance.
-
of
public static Max of(double... values)
Returns an instance populated using the inputvalues.The result is
NaNif any of the values isNaN.When the input is an empty array, the result is
negative infinity.- Parameters:
values- Values.- Returns:
Maxinstance.
-
accept
public void accept(double value)
Updates the state of the statistic to reflect the addition ofvalue.- Specified by:
acceptin interfaceDoubleConsumer- 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:
getAsDoublein interfaceDoubleSupplier- Returns:
- maximum of all values.
-
combine
public Max combine(Max other)
Description copied from interface:StatisticAccumulatorCombines the state of theotherstatistic into this one.- Specified by:
combinein interfaceStatisticAccumulator<Max>- Parameters:
other- Another statistic to be combined.- Returns:
thisinstance after combiningother.
-
-