Class IntMin
- All Implemented Interfaces:
DoubleSupplier
,IntConsumer
,IntSupplier
,LongSupplier
,IntStatistic
,StatisticAccumulator<IntMin>
,StatisticResult
Math.min
as an
underlying function to compute the minimum
.
- The result is
Integer.MAX_VALUE
if 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 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 Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(int value) Updates the state of the statistic to reflect the addition ofvalue
.Combines the state of theother
statistic into this one.static IntMin
create()
Creates an instance.Gets a result as aBigInteger
.double
int
getAsInt()
Gets the minimum of all input values.long
static IntMin
of
(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
-
Field Details
-
minimum
private int minimumCurrent minimum.
-
-
Constructor Details
-
IntMin
private IntMin()Create an instance.
-
-
Method Details
-
create
Creates an instance.The initial result is
Integer.MAX_VALUE
.- Returns:
Min
instance.
-
of
Returns an instance populated using the inputvalues
.When the input is an empty array, the result is
Integer.MAX_VALUE
.- Parameters:
values
- Values.- Returns:
Min
instance.
-
accept
public void accept(int value) Updates the state of the statistic to reflect the addition ofvalue
.- Specified by:
accept
in 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:
getAsInt
in interfaceIntSupplier
- Specified by:
getAsInt
in interfaceStatisticResult
- Returns:
- minimum of all values.
-
getAsLong
public long getAsLong()Description copied from interface:StatisticResult
The default implementation uses the closest representable
long
value of theDoubleSupplier.getAsDouble()
result
. In the event of ties the result is rounded towards positive infinity. This will raise anArithmeticException
if the closest integer result is not within the range[-2^63, 2^63)
.- Specified by:
getAsLong
in interfaceLongSupplier
- Specified by:
getAsLong
in interfaceStatisticResult
-
getAsDouble
public double getAsDouble()- Specified by:
getAsDouble
in interfaceDoubleSupplier
-
getAsBigInteger
Description copied from interface:StatisticResult
Gets a result as aBigInteger
.The default implementation uses the closest representable
BigInteger
value of theDoubleSupplier.getAsDouble()
result
. In the event of ties the result is rounded towards positive infinity. This will raise anArithmeticException
if theresult
is not finite.- Specified by:
getAsBigInteger
in interfaceStatisticResult
- Returns:
- a result
-
combine
Description copied from interface:StatisticAccumulator
Combines the state of theother
statistic into this one.- Specified by:
combine
in interfaceStatisticAccumulator<IntMin>
- Parameters:
other
- Another statistic to be combined.- Returns:
this
instance after combiningother
.
-