Класс IntSummaryStatistics

java.lang.Object

java.util.IntSummaryStatistics

Все реализуемые интерфейсы:: IntConsumer

public class IntSummaryStatistics extends Object implements IntConsumer

Объект состояния для сбора статистики, такой как количество, минимум, максимум, сумма и среднее значение.

Этот класс разработан для работы с (хотя не требует) потоками. Например, вы можете вычислить статистику по потоку целых чисел следующим образом:

 
 IntSummaryStatistics stats = intStream.collect(IntSummaryStatistics::new,
                                                IntSummaryStatistics::accept,
                                                IntSummaryStatistics::combine);

IntSummaryStatistics может использоваться в качестве оператора агрегирования для потока. Например:

 
 IntSummaryStatistics stats = people.stream()
                                    .collect(Collectors.summarizingInt(Person::getDependents));

Это вычисляет, в одном проходе, количество людей, а также минимум, максимум, сумму и среднее значение количества их иждивенцев.

Примечание об реализации:: Эта реализация не потокобезопасна. Однако, безопасно использовать Collectors.summarizingInt() над параллельным потоком, потому что параллельная реализация Stream.collect() обеспечивает необходимое разделение, изоляцию и объединение результатов для безопасного и эффективного параллельного выполнения.
Эта реализация не проверяет переполнение количества или суммы.
С:: 1.8

Краткое описание конструкторов

Конструктор	Описание
`IntSummaryStatistics()`	Создаёт пустой экземпляр с нулевым количеством, нулевой суммой, `Integer.MAX_VALUE` минимальным значением, `Integer.MIN_VALUE` максимальным значением и нулевым средним значением.
`IntSummaryStatistics(long count, int min, int max, long sum)`	Создаёт непустой экземпляр со значением `count`, `min`, `max`, и `sum`.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`accept(int value)`	Записывает новое значение в статистическую информацию
`void`	`combine(IntSummaryStatistics other)`	Объединяет состояние другого `IntSummaryStatistics` в текущий.
`final double`	`getAverage()`	Возвращает среднее арифметическое записанных значений, или ноль, если значения не записывались.
`final long`	`getCount()`	Возвращает количество записанных значений.
`final int`	`getMax()`	Возвращает максимальное записанное значение, или `Integer.MIN_VALUE` если значения не записывались.
`final int`	`getMin()`	Возвращает минимальное записанное значение, или `Integer.MAX_VALUE` если значения не записывались.
`final long`	`getSum()`	Возвращает сумму записанных значений, или ноль, если значения не записывались.
`String`	`toString()`	Возвращает непустую строку представления объекта, подходящую для отладки.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Методы, объявленные в интерфейсе java.util.function.IntConsumer

andThen

Подробное описание конструкторов

IntSummaryStatistics

public IntSummaryStatistics()

Создаёт пустой экземпляр с нулевым количеством, нулевой суммой, Integer.MAX_VALUE минимальным значением, Integer.MIN_VALUE максимальным значением и нулевым средним значением.

IntSummaryStatistics

public IntSummaryStatistics(long count, int min, int max, long sum) throws IllegalArgumentException

Создаёт непустой экземпляр со значением count, min, max, и sum.

Если count равно нулю, то остальные аргументы игнорируются, и создаётся пустой экземпляр.

Если аргументы не согласованы, то будет брошено IllegalArgumentException исключение. Необходимые условия согласованности аргументов:

count >= 0
min <= max

Замечание API:: Выполнение проверки корректности аргументов означает, что набор записанных значений, полученных из экземпляра IntSummaryStatistics источника, может не быть допустимым набором аргументов для этого конструктора из-за переполнения арифметики количества записанных значений источника. Условия согласованности аргументов недостаточны для предотвращения создания внутренне несогласованного экземпляра. Примером такого состояния может быть экземпляр со значением: count = 2, min = 1, max = 2, и sum = 0.
Параметры:: count - количество значений; min - минимальное значение; max - максимальное значение; sum - сумма всех значений
Исключение:: IllegalArgumentException - если аргументы не согласованы
С:: 10

Подробное описание методов

accept

public void accept(int value)

Записывает новое значение в статистическую информацию

Определено в:: accept в интерфейсе IntConsumer
Параметры:: value - значение на вход

combine

public void combine(IntSummaryStatistics other)

Объединяет состояние другого IntSummaryStatistics в текущий.

Параметры:: other - другое IntSummaryStatistics
Исключение:: NullPointerException - если other равно null

getCount

public final long getCount()

Возвращает количество записанных значений.

Возвращает:: количество значений

getSum

public final long getSum()

Возвращает сумму записанных значений, или ноль, если значения не записывались.

Возвращает:: сумма значений, или ноль, если значений нет

getMin

public final int getMin()

Возвращает минимальное записанное значение, или Integer.MAX_VALUE если значения не записывались.

Возвращает:: минимальное значение, или Integer.MAX_VALUE если значений нет

getMax

public final int getMax()

Возвращает максимальное записанное значение, или Integer.MIN_VALUE если значения не записывались.

Возвращает:: максимальное значение, или Integer.MIN_VALUE если значений нет

getAverage

public final double getAverage()

Возвращает среднее арифметическое записанных значений, или ноль, если значения не записывались.

Возвращает:: среднее арифметическое значений, или ноль, если значений нет

toString

public String toString()

Возвращает непустую строку представления этого объекта, подходящую для отладки. Точный формат представления не определён и может отличаться между реализациями и версиями.

Переопределяет:: toString в классе Object
Возвращает:: строковое представление объекта.

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/IntSummaryStatistics.html