Class IntMin
- java.lang.Object
-
- org.apache.commons.statistics.descriptive.IntMin
-
- All Implemented Interfaces:
DoubleSupplier,IntConsumer,IntSupplier,LongSupplier,IntStatistic,StatisticAccumulator<IntMin>,StatisticResult
public final class IntMin extends Object implements IntStatistic, StatisticAccumulator<IntMin>
Returns the minimum of the available values. UsesMath.minas an underlying function to compute theminimum.- The result is
Integer.MAX_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.min(int, int)
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(int value)Updates the state of the statistic to reflect the addition ofvalue.IntMincombine(IntMin other)Combines the state of theotherstatistic into this one.static IntMincreate()Creates an instance.BigIntegergetAsBigInteger()Gets a result as aBigInteger.doublegetAsDouble()intgetAsInt()Gets the minimum of all input values.longgetAsLong()static IntMinof(int... 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.IntConsumer
andThen
-
-
-
-
Method Detail
-
create
public static IntMin create()
Creates an instance.The initial result is
Integer.MAX_VALUE.- Returns:
Mininstance.
-
of
public static IntMin of(int... values)
Returns an instance populated using the inputvalues.When the input is an empty array, the result is
Integer.MAX_VALUE.- Parameters:
values- Values.- Returns:
Mininstance.
-
accept
public void accept(int value)
Updates the state of the statistic to reflect the addition ofvalue.- Specified by:
acceptin interfaceIntConsumer- Parameters:
value- Value.
-
getAsInt
public int getAsInt()
Gets the minimum of all input values.When no values have been added, the result is
Integer.MAX_VALUE.- Specified by:
getAsIntin interfaceIntSupplier- Specified by:
getAsIntin interfaceStatisticResult- Returns:
- minimum of all values.
-
getAsLong
public long getAsLong()
Description copied from interface:StatisticResultThe default implementation uses the closest representable
longvalue of theDoubleSupplier.getAsDouble()result. In the event of ties the result is rounded towards positive infinity. This will raise anArithmeticExceptionif the closest integer result is not within the range[-2^63, 2^63).- Specified by:
getAsLongin interfaceLongSupplier- Specified by:
getAsLongin interfaceStatisticResult
-
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 IntMin combine(IntMin other)
Description copied from interface:StatisticAccumulatorCombines the state of theotherstatistic into this one.- Specified by:
combinein interfaceStatisticAccumulator<IntMin>- Parameters:
other- Another statistic to be combined.- Returns:
thisinstance after combiningother.
-
-