public class IntSummaryStatistics extends Object implements IntConsumer
This class is designed to work with (though does not require) streams. For example, you can compute summary statistics on a stream of ints with:
IntSummaryStatistics stats = intStream.collect(IntSummaryStatistics::new,
IntSummaryStatistics::accept,
IntSummaryStatistics::combine);
IntSummaryStatistics can be used as a
reduction
target for a stream. For example:
IntSummaryStatistics stats = people.stream()
.collect(Collectors.summarizingInt(Person::getDependents));
This computes, in a single pass, the count of people, as well as the minimum,
maximum, sum, and average of their number of dependents.Collectors.toIntStatistics() 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.
This implementation does not check for overflow of the sum.
| Constructor and Description |
|---|
IntSummaryStatistics()
Construct an empty instance with zero count, zero sum,
Integer.MAX_VALUE min, Integer.MIN_VALUE max and zero
average. |
| Modifier and Type | Method and Description |
|---|---|
void |
accept(int value)
Records a new value into the summary information
|
void |
combine(IntSummaryStatistics other)
Combines the state of another
IntSummaryStatistics into this one. |
double |
getAverage()
Returns the arithmetic mean of values recorded, or zero if no values have been
recorded.
|
long |
getCount()
Returns the count of values recorded.
|
int |
getMax()
Returns the maximum value recorded, or
Integer.MIN_VALUE if no
values have been recorded. |
int |
getMin()
Returns the minimum value recorded, or
Integer.MAX_VALUE if no
values have been recorded. |
long |
getSum()
Returns the sum of values recorded, or zero if no values have been
recorded.
|
String |
toString()
Returns a string representation of the object.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitandThenpublic IntSummaryStatistics()
Integer.MAX_VALUE min, Integer.MIN_VALUE max and zero
average.public void accept(int value)
accept in interface IntConsumervalue - the input valuepublic void combine(IntSummaryStatistics other)
IntSummaryStatistics into this one.other - another IntSummaryStatisticsNullPointerException - if other is nullpublic final long getCount()
public final long getSum()
public final int getMin()
Integer.MAX_VALUE if no
values have been recorded.Integer.MAX_VALUE if nonepublic final int getMax()
Integer.MIN_VALUE if no
values have been recorded.Integer.MIN_VALUE if nonepublic final double getAverage()
public String toString()
ObjecttoString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.