Spec-Zone.ru › Kotlin 2

MutableList

kotlin-stdlib/kotlin.collections/MutableList

Требования к платформе и версии: Common (1.0), JS (1.1), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect interface MutableList<E> : List<E> , MutableCollection<E> 

Упорядоченная коллекция элементов обобщённого типа, которая поддерживает добавление, замену и удаление элементов, а также перебор содержащихся элементов, доступ к ним по индексу и проверку наличия определённого значения в коллекции.

Если в конкретном случае использования не требуется изменять список, вместо него можно использовать доступный только для чтения аналог — List.

MutableList расширяет контракт List функциями, позволяющими добавлять, заменять и удалять элементы.

В отличие от List, итераторы, возвращаемые функциями iterator и listIterator, позволяют изменять список во время итерации. Представление, возвращаемое функцией subList, также позволяет изменять базовый список.

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

Параметры типа

E

тип элементов, содержащихся в списке. Тип элементов изменяемого списка инвариантен.

Наследники

AbstractMutableList
ArrayList

Требования к платформе и версии: JVM (1.0)

actual interface MutableList<E> : List<E> , MutableCollection<E> 

Упорядоченная коллекция элементов обобщённого типа, которая поддерживает добавление, замену и удаление элементов, а также перебор содержащихся элементов, доступ к ним по индексу и проверку наличия определённого значения в коллекции.

Если в конкретном случае использования не требуется изменять список, вместо него можно использовать доступный только для чтения аналог — List.

MutableList расширяет контракт List функциями, позволяющими добавлять, заменять и удалять элементы.

В отличие от List, итераторы, возвращаемые функциями iterator и listIterator, позволяют изменять список во время итерации. Представление, возвращаемое функцией subList, также позволяет изменять базовый список.

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

По соглашению, реализации MutableList также реализуют интерфейс java.io.Serializable.

Параметры типа

E

тип элементов, содержащихся в списке. Тип элементов изменяемого списка инвариантен.

Наследники

AbstractMutableList

Свойства

indices

Требования к платформе и версии: Common (1.0)

val Collection<*>.indices: IntRange

Возвращает IntRange допустимых индексов этой коллекции.

lastIndex

Требования к платформе и версии: Common (1.0)

val <T> List<T>.lastIndex: Int

Возвращает индекс последнего элемента списка или -1, если список пуст.

size

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract override val size: Int

Возвращает размер коллекции.

Функции

add

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

@IgnorableReturnValue
expect abstract override fun add(element: E): Boolean

Добавляет указанный элемент в конец этого списка.

expect abstract fun add(index: Int, element: E)

Вставляет элемент в список по указанному индексу.

addAll

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

@IgnorableReturnValue
expect abstract override fun addAll(elements: Collection<E>): Boolean

Добавляет все элементы указанной коллекции в конец этого списка.

@IgnorableReturnValue
expect abstract fun addAll(index: Int, elements: Collection<E>): Boolean

Вставляет все элементы указанной коллекции в этот список по указанному индексу.

addAll

Требования к платформе и версии: Common (1.0)

@IgnorableReturnValue
fun <T> MutableCollection<in T>.addAll(elements: Array<out T>): Boolean

Добавляет все элементы данного массива elements в эту MutableCollection.

@IgnorableReturnValue
fun <T> MutableCollection<in T>.addAll(elements: Iterable<T>): Boolean

Добавляет все элементы данной коллекции elements в эту MutableCollection.

@IgnorableReturnValue
fun <T> MutableCollection<in T>.addAll(elements: Sequence<T>): Boolean

Добавляет все элементы данной последовательности elements в эту MutableCollection.

all

Требования к платформе и версии: Common (1.0)

inline fun <T> Iterable<T>.all(predicate: (T) -> Boolean): Boolean

Возвращает true, если все элементы соответствуют заданному предикату.

allDistinct

Требования к платформе и версии: Common (2.4)

@ExperimentalStdlibApi
fun <T> Iterable<T>.allDistinct(): Boolean

Возвращает true, если все элементы коллекции отличаются друг от друга, то есть никакие два элемента не равны.

allDistinctBy

Требования к платформе и версии: Common (2.4)

@ExperimentalStdlibApi
inline fun <T, K> Iterable<T>.allDistinctBy(selector: (T) -> K): Boolean

Возвращает true, если все значения, полученные применением функции selector к элементам коллекции, отличаются друг от друга.

allEqual

Требования к платформе и версии: Common (2.4)

@ExperimentalStdlibApi
fun <T> Iterable<T>.allEqual(): Boolean

Возвращает true, если все элементы коллекции равны друг другу.

allEqualBy

Требования к платформе и версии: Common (2.4)

@ExperimentalStdlibApi
inline fun <T, K> Iterable<T>.allEqualBy(selector: (T) -> K): Boolean

Возвращает true, если для всех элементов коллекции функция selector возвращает одно и то же значение.

any

Требования к платформе и версии: Common (1.0)

fun <T> Iterable<T>.any(): Boolean

Возвращает true, если коллекция содержит хотя бы один элемент.

inline fun <T> Iterable<T>.any(predicate: (T) -> Boolean): Boolean

Возвращает true, если хотя бы один элемент соответствует заданному предикату.

asIterable

Требования к платформе и версии: Common (1.0)

inline fun <T> Iterable<T>.asIterable(): Iterable<T>

Возвращает эту коллекцию как Iterable.

asJsArrayView

Требования к платформе и версии: JS (2.0)

@ExperimentalJsExport
@ExperimentalJsCollectionsApi
open fun asJsArrayView(): JsArray<E>

Возвращает представление с методами JsArray, позволяющее использовать его в JavaScript как обычный массив. Структурные изменения базового списка синхронизируются с представлением и наоборот.

asJsReadonlyArrayView

Требования к платформе и версии: JS (2.0)

@ExperimentalJsExport
@ExperimentalJsCollectionsApi
open fun asJsReadonlyArrayView(): JsReadonlyArray<E>

Возвращает представление с методами JsReadonlyArray, позволяющее использовать его в JavaScript как обычный массив только для чтения. Структурные изменения базового списка синхронизируются с представлением.

asReversed

Требования к платформе и версии: Common (1.0)

fun <T> List<T>.asReversed(): List<T>

Возвращает представление исходного List только для чтения в обратном порядке. Все изменения исходного списка отражаются в списке в обратном порядке.

@JvmName(name = "asReversedMutable")
fun <T> MutableList<T>.asReversed(): MutableList<T>

Возвращает изменяемое представление исходного изменяемого List в обратном порядке. Все изменения исходного списка отражаются в списке в обратном порядке и наоборот.

asSequence

Требования к платформе и версии: Common (1.0)

fun <T> Iterable<T>.asSequence(): Sequence<T>

Создает экземпляр Sequence, оборачивающий исходную коллекцию и возвращающий ее элементы при переборе.

associate

Требования к платформе и версии: Common (1.0)

inline fun <T, K, V> Iterable<T>.associate(transform: (T) -> Pair<K, V>): Map<K, V>

Возвращает Map, содержащую пары ключ-значение, предоставленные функцией transform, примененной к элементам данной коллекции.

associateBy

Требования к платформе и версии: Common (1.0)

inline fun <T, K> Iterable<T>.associateBy(keySelector: (T) -> K): Map<K, T>

Возвращает Map, содержащую элементы данной коллекции, индексированные ключом, возвращаемым функцией keySelector, примененной к каждому элементу.

inline fun <T, K, V> Iterable<T>.associateBy(keySelector: (T) -> K, valueTransform: (T) -> V): Map<K, V>

Возвращает Map, содержащую значения, предоставленные функцией valueTransform и индексированные ключами, возвращенными функцией keySelector, примененной к элементам данной коллекции.

associateByTo

Требования к платформе и версии: Common (1.0)

@IgnorableReturnValue
inline fun <T, K, M : MutableMap<in K, in T>> Iterable<T>.associateByTo(destination: M, keySelector: (T) -> K): M

Заполняет изменяемую карту destination парами ключ-значение и возвращает ее. Ключ предоставляется функцией keySelector, примененной к каждому элементу данной коллекции, а значение — сам элемент.

@IgnorableReturnValue
inline fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateByTo(destination: M, keySelector: (T) -> K, valueTransform: (T) -> V): M

Заполняет изменяемую карту destination парами ключ-значение и возвращает ее. Ключ предоставляется функцией keySelector, а значение — функцией valueTransform, примененной к элементам данной коллекции.

associateTo

Требования к платформе и версии: Common (1.0)

@IgnorableReturnValue
inline fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateTo(destination: M, transform: (T) -> Pair<K, V>): M

Заполняет изменяемую карту destination парами ключ-значение, предоставленными функцией transform, примененной к каждому элементу данной коллекции, и возвращает ее.

associateWith

Требования к платформе и версии: Common (1.3)

inline fun <K, V> Iterable<K>.associateWith(valueSelector: (K) -> V): Map<K, V>

Возвращает Map, в которой ключами являются элементы данной коллекции, а значениями — результаты функции valueSelector, примененной к каждому элементу.

associateWithTo

Требования к платформе и версии: Common (1.3)

@IgnorableReturnValue
inline fun <K, V, M : MutableMap<in K, in V>> Iterable<K>.associateWithTo(destination: M, valueSelector: (K) -> V): M

Заполняет изменяемую карту destination парами ключ-значение для каждого элемента данной коллекции и возвращает ее. Ключом является сам элемент, а значение предоставляется функцией valueSelector, примененной к этому ключу.

average

Требования к платформе и версии: Common (1.0)

@JvmName(name = "averageOfByte")
fun Iterable<Byte>.average(): Double
@JvmName(name = "averageOfDouble")
fun Iterable<Double>.average(): Double
@JvmName(name = "averageOfFloat")
fun Iterable<Float>.average(): Double
@JvmName(name = "averageOfInt")
fun Iterable<Int>.average(): Double
@JvmName(name = "averageOfLong")
fun Iterable<Long>.average(): Double
@JvmName(name = "averageOfShort")
fun Iterable<Short>.average(): Double

Возвращает среднее значение элементов коллекции.

binarySearch

Требования к платформе и версии: Common (1.0)

fun <T> List<T>.binarySearch(fromIndex: Int = 0, toIndex: Int = size, comparison: (T) -> Int): Int

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

fun <T : Comparable<T>> List<T?>.binarySearch(element: T?, fromIndex: Int = 0, toIndex: Int = size): Int

Выполняет двоичный поиск указанного элемента в этом списке или его диапазоне. Предполагается, что список отсортирован по возрастанию согласно естественному порядку элементов Comparable; в противном случае результат не определен.

fun <T> List<T>.binarySearch(element: T, comparator: Comparator<in T>, fromIndex: Int = 0, toIndex: Int = size): Int

Выполняет двоичный поиск указанного элемента в этом списке или его диапазоне. Предполагается, что список отсортирован по возрастанию согласно указанному компаратору; в противном случае результат не определен.

binarySearchBy

Требования к платформе и версии: Common (1.0)

inline fun <T, K : Comparable<K>> List<T>.binarySearchBy(key: K?, fromIndex: Int = 0, toIndex: Int = size, crossinline selector: (T) -> K?): Int

Выполняет двоичный поиск в этом списке или его диапазоне элемента, ключ которого, возвращаемый указанной функцией selector, равен заданному значению key. Предполагается, что список отсортирован по возрастанию согласно естественному порядку Comparable ключей его элементов; в противном случае результат не определен.

chunked

Требования к платформе и версии: Common (1.2)

fun <T> Iterable<T>.chunked(size: Int): List<List<T>>

Разбивает эту коллекцию на список списков, каждый из которых не превышает заданный размер.

fun <T, R> Iterable<T>.chunked(size: Int, transform: (List<T>) -> R): List<R>

Разбивает эту коллекцию на несколько списков, каждый из которых не превышает заданный размер, и применяет к каждому заданную функцию transform.

clear

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract override fun clear()

Удаляет все элементы из этой коллекции.

component1

Требования к платформе и версии: Common (1.0)

inline operator fun <T> List<T>.component1(): T

Возвращает 1-й элемент списка.

component2

Требования к платформе и версии: Common (1.0)

inline operator fun <T> List<T>.component2(): T

Возвращает 2-й элемент списка.

component3

Требования к платформе и версии: Common (1.0)

inline operator fun <T> List<T>.component3(): T

Возвращает 3-й элемент списка.

component4

Требования к платформе и версии: Common (1.0)

inline operator fun <T> List<T>.component4(): T

Возвращает 4-й элемент списка.

component5

Требования к платформе и версии: Common (1.0)

inline operator fun <T> List<T>.component5(): T

Возвращает 5-й элемент списка.

contains

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract operator override fun contains(element: E): Boolean

Проверяет, содержится ли указанный элемент в этой коллекции.

contains

Требования к платформе и версии: Common (1.0)

operator fun <T> Iterable<T>.contains(element: T): Boolean

Возвращает true, если в коллекции найден элемент.

containsAll

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract override fun containsAll(elements: Collection<E>): Boolean

Проверяет, содержатся ли все элементы указанной коллекции в этой коллекции.

containsAll

Требования к платформе и версии: Common (1.0)

inline fun <T> Collection<T>.containsAll(elements: Collection<T>): Boolean

Проверяет, содержатся ли все элементы указанной коллекции в этой коллекции.

count

Требования к платформе и версии: Common (1.0)

inline fun <T> Collection<T>.count(): Int
fun <T> Iterable<T>.count(): Int

Возвращает количество элементов в этой коллекции.

inline fun <T> Iterable<T>.count(predicate: (T) -> Boolean): Int

Возвращает количество элементов, соответствующих заданному предикату.

distinct

Требования к платформе и версии: Common (1.0)

fun <T> Iterable<T>.distinct(): List<T>

Возвращает список, содержащий только уникальные элементы данной коллекции.

distinctBy

Требования к платформе и версии: Common (1.0)

inline fun <T, K> Iterable<T>.distinctBy(selector: (T) -> K): List<T>

Возвращает список, содержащий только элементы данной коллекции с уникальными ключами, возвращенными заданной функцией selector.

drop

Требования к платформе и версии: Common (1.0)

fun <T> Iterable<T>.drop(n: Int): List<T>

Возвращает список, содержащий все элементы, кроме первых n элементов.

dropLast

Требования к платформе и версии: Common (1.0)

fun <T> List<T>.dropLast(n: Int): List<T>

Возвращает список, содержащий все элементы, кроме последних n элементов.

dropLastWhile

Требования к платформе и версии: Common (1.0)

inline fun <T> List<T>.dropLastWhile(predicate: (T) -> Boolean): List<T>

Возвращает список, содержащий все элементы, кроме последних элементов, соответствующих заданному предикату.

dropWhile

Требования к платформе и версии: Common (1.0)

inline fun <T> Iterable<T>.dropWhile(predicate: (T) -> Boolean): List<T>

Возвращает список, содержащий все элементы, кроме первых элементов, соответствующих заданному предикату.

elementAt

Требования к платформе и версии: Common (1.0)

fun <T> Iterable<T>.elementAt(index: Int): T

Возвращает элемент по заданному индексу или выбрасывает IndexOutOfBoundsException, если индекс выходит за границы этой коллекции.

inline fun <T> List<T>.elementAt(index: Int): T

Возвращает элемент по заданному индексу или выбрасывает IndexOutOfBoundsException, если индекс выходит за границы этого списка.

elementAtOrElse

Требования к платформе и версии: Common (1.0)

fun <T> Iterable<T>.elementAtOrElse(index: Int, defaultValue: (Int) -> T): T

Возвращает элемент по заданному индексу или результат вызова функции defaultValue, если индекс выходит за границы этой коллекции.

inline fun <T> List<T>.elementAtOrElse(index: Int, defaultValue: (Int) -> T): T

Возвращает элемент по заданному индексу или результат вызова функции defaultValue, если индекс выходит за границы этого списка.

elementAtOrNull

Требования к платформе и версии: Common (1.0)

fun <T> Iterable<T>.elementAtOrNull(index: Int): T?

Возвращает элемент по заданному индексу или null, если индекс выходит за границы этой коллекции.

inline fun <T> List<T>.elementAtOrNull(index: Int): T?

Возвращает элемент по заданному индексу или null, если индекс выходит за границы этого списка.

fill

Требования к платформе и версии: Common (1.2), JS (1.2), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect fun <T> MutableList<T>.fill(value: T)

Заполняет список указанным значением.

Требования к платформе и версии: JVM (1.2)

actual inline fun <T> MutableList<T>.fill(value: T)

Заполняет список указанным значением.

filter

Требования к платформе и версии: Common (1.0)

inline fun <T> Iterable<T>.filter(predicate: (T) -> Boolean): List<T>

Возвращает список, содержащий только элементы, соответствующие заданному предикату.

filterIndexed

Требования к платформе и версии: Common (1.0)

inline fun <T> Iterable<T>.filterIndexed(predicate: (index: Int, T) -> Boolean): List<T>

Возвращает список, содержащий только элементы, соответствующие заданному предикату.

filterIndexedTo

Требования к платформе и версии: Common (1.0)

@IgnorableReturnValue
inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterIndexedTo(destination: C, predicate: (index: Int, T) -> Boolean): C

Добавляет все элементы, соответствующие заданному предикату, в указанное назначение.

filterIsInstance

Требования к платформе и версии: Common (1.0)

inline fun <R> Iterable<*>.filterIsInstance(): List<R>

Возвращает список, содержащий все элементы, являющиеся экземплярами указанного параметра типа R.

Требования к платформе и версии: JVM (1.0)

fun <R> Iterable<*>.filterIsInstance(klass: Class<R>): List<R>

Возвращает список, содержащий все элементы, являющиеся экземплярами указанного класса.

filterIsInstanceTo

Требования к платформе и версии: Common (1.0)

@IgnorableReturnValue
inline fun <R, C : MutableCollection<in R>> Iterable<*>.filterIsInstanceTo(destination: C): C

Добавляет все элементы, являющиеся экземплярами указанного параметра типа R, в указанное назначение.

Требования к платформе и версии: JVM (1.0)

@IgnorableReturnValue
fun <C : MutableCollection<in R>, R> Iterable<*>.filterIsInstanceTo(destination: C, klass: Class<R>): C

Добавляет все элементы, являющиеся экземплярами указанного класса, в указанное назначение.

filterNot

Требования к платформе и версии: Common (1.0)

inline fun <T> Iterable<T>.filterNot(predicate: (T) -> Boolean): List<T>

Возвращает список, содержащий все элементы, не соответствующие заданному предикату.

filterNotNull

Требования к платформе и версии: Common (1.0)

fun <T : Any> Iterable<T?>.filterNotNull(): List<T>

Возвращает список, содержащий все элементы, которые не являются null.

filterNotNullTo

Требования к платформе и версии: Common (1.0)

@IgnorableReturnValue
fun <C : MutableCollection<in T>, T : Any> Iterable<T?>.filterNotNullTo(destination: C): C

Добавляет все элементы, которые не являются null, в указанное назначение.

filterNotTo

Требования к платформе и версии: Common (1.0)

@IgnorableReturnValue
inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo(destination: C, predicate: (T) -> Boolean): C

Добавляет все элементы, не соответствующие заданному предикату, в указанное назначение.

filterTo

Требования к платформе и версии: Common (1.0)

@IgnorableReturnValue
inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(destination: C, predicate: (T) -> Boolean): C

Добавляет все элементы, соответствующие заданному предикату, в указанное назначение.

find

Требования к платформе и версии: Common (1.0)

inline fun <T> Iterable<T>.find(predicate: (T) -> Boolean): T?

Возвращает первый элемент, соответствующий заданному предикату, или null, если такой элемент не найден.

findLast

Требования к платформе и версии: Common (1.0)

inline fun <T> Iterable<T>.findLast(predicate: (T) -> Boolean): T?
inline fun <T> List<T>.findLast(predicate: (T) -> Boolean): T?

Возвращает последний элемент, соответствующий заданному предикату, или null, если такой элемент не найден.

first

Требования к платформе и версии: Common (1.0)

fun <T> Iterable<T>.first(): T
fun <T> List<T>.first(): T

Возвращает первый элемент.

inline fun <T> Iterable<T>.first(predicate: (T) -> Boolean): T

Возвращает первый элемент, соответствующий заданному предикату.

firstNotNullOf

Требования к платформе и версии: Common (1.5)

inline fun <T, R : Any> Iterable<T>.firstNotNullOf(transform: (T) -> R?): R

Возвращает первое ненулевое значение, полученное функцией transform, применённой к элементам этой коллекции в порядке итерации, или выбрасывает исключение NoSuchElementException, если ненулевое значение не получено.

firstNotNullOfOrNull

Требования к платформе и версии: Common (1.5)

inline fun <T, R : Any> Iterable<T>.firstNotNullOfOrNull(transform: (T) -> R?): R?

Возвращает первое ненулевое значение, полученное функцией transform, применённой к элементам этой коллекции в порядке итерации, или null, если ненулевое значение не получено.

firstOrNull

Требования к платформе и версии: Common (1.0)

fun <T> Iterable<T>.firstOrNull(): T?

Возвращает первый элемент или null, если коллекция пуста.

fun <T> List<T>.firstOrNull(): T?

Возвращает первый элемент или null, если список пуст.

inline fun <T> Iterable<T>.firstOrNull(predicate: (T) -> Boolean): T?

Возвращает первый элемент, соответствующий заданному предикату, или null, если элемент не найден.

flatMap

Требования к платформе и версии: Common (1.0)

inline fun <T, R> Iterable<T>.flatMap(transform: (T) -> Iterable<R>): List<R>

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

@JvmName(name = "flatMapSequence")
inline fun <T, R> Iterable<T>.flatMap(transform: (T) -> Sequence<R>): List<R>

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

flatMapIndexed

Требования к платформе и версии: Common (1.4)

@JvmName(name = "flatMapIndexedIterable")
inline fun <T, R> Iterable<T>.flatMapIndexed(transform: (index: Int, T) -> Iterable<R>): List<R>
@JvmName(name = "flatMapIndexedSequence")
inline fun <T, R> Iterable<T>.flatMapIndexed(transform: (index: Int, T) -> Sequence<R>): List<R>

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

flatMapIndexedTo

Требования к платформе и версии: Common (1.4)

@JvmName(name = "flatMapIndexedIterableTo")
@IgnorableReturnValue
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapIndexedTo(destination: C, transform: (index: Int, T) -> Iterable<R>): C
@JvmName(name = "flatMapIndexedSequenceTo")
@IgnorableReturnValue
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapIndexedTo(destination: C, transform: (index: Int, T) -> Sequence<R>): C

Добавляет все элементы, полученные из результатов вызова функции transform для каждого элемента и его индекса в исходной коллекции, в указанное назначение.

flatMapTo

Требования к платформе и версии: Common (1.0)

@IgnorableReturnValue
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapTo(destination: C, transform: (T) -> Iterable<R>): C

Добавляет все элементы, полученные из результатов вызова функции transform для каждого элемента исходной коллекции, в указанное назначение.

@JvmName(name = "flatMapSequenceTo")
@IgnorableReturnValue
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapTo(destination: C, transform: (T) -> Sequence<R>): C

Добавляет все элементы, полученные из результатов вызова функции transform для каждого элемента исходной коллекции, в указанное назначение.

flatten

Требования к платформе и версии: Common (1.0)

fun <T> Iterable<Iterable<T>>.flatten(): List<T>

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

fold

Требования к платформе и версии: Common (1.0)

inline fun <T, R> Iterable<T>.fold(initial: R, operation: (acc: R, T) -> R): R

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

foldIndexed

Требования к платформе и версии: Common (1.0)

inline fun <T, R> Iterable<T>.foldIndexed(initial: R, operation: (index: Int, acc: R, T) -> R): R

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

foldRight

Требования к платформе и версии: Common (1.0)

inline fun <T, R> List<T>.foldRight(initial: R, operation: (T, acc: R) -> R): R

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

foldRightIndexed

Требования к платформе и версии: Common (1.0)

inline fun <T, R> List<T>.foldRightIndexed(initial: R, operation: (index: Int, T, acc: R) -> R): R

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

forEach

Требования к платформе и версии: Common (1.0)

inline fun <T> Iterable<T>.forEach(action: (T) -> Unit)

Выполняет заданное действие для каждого элемента.

forEachIndexed

Требования к платформе и версии: Common (1.0)

inline fun <T> Iterable<T>.forEachIndexed(action: (index: Int, T) -> Unit)

Выполняет заданное действие для каждого элемента, передавая вместе с ним последовательный индекс.

get

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract operator fun get(index: Int): E

Возвращает элемент списка по указанному индексу.

getOrElse

Требования к платформе и версии: Common (1.0)

inline fun <T> List<T>.getOrElse(index: Int, defaultValue: (Int) -> T): T

Возвращает элемент по заданному индексу или результат вызова функции defaultValue, если индекс выходит за границы этого списка.

getOrNull

Требования к платформе и версии: Common (1.0)

fun <T> List<T>.getOrNull(index: Int): T?

Возвращает элемент по заданному индексу или null, если индекс выходит за границы этого списка.

groupBy

Требования к платформе и версии: Common (1.0)

inline fun <T, K> Iterable<T>.groupBy(keySelector: (T) -> K): Map<K, List<T>>

Группирует элементы исходной коллекции по ключу, возвращаемому заданной функцией keySelector, применённой к каждому элементу, и возвращает карту, в которой каждому ключу группы соответствует список элементов этой группы.

inline fun <T, K, V> Iterable<T>.groupBy(keySelector: (T) -> K, valueTransform: (T) -> V): Map<K, List<V>>

Группирует значения, возвращаемые функцией valueTransform, применённой к каждому элементу исходной коллекции, по ключу, возвращаемому заданной функцией keySelector, применённой к элементу, и возвращает карту, в которой каждому ключу группы соответствует список соответствующих значений.

groupByTo

Требования к платформе и версии: Common (1.0)

@IgnorableReturnValue
inline fun <T, K, M : MutableMap<in K, MutableList<T>>> Iterable<T>.groupByTo(destination: M, keySelector: (T) -> K): M

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

@IgnorableReturnValue
inline fun <T, K, V, M : MutableMap<in K, MutableList<V>>> Iterable<T>.groupByTo(destination: M, keySelector: (T) -> K, valueTransform: (T) -> V): M

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

groupingBy

Требования к платформе и версии: Common (1.1)

inline fun <T, K> Iterable<T>.groupingBy(crossinline keySelector: (T) -> K): Grouping<T, K>

Создаёт источник Grouping на основе коллекции, который можно позднее использовать с одной из операций группировки и свёртки. Для извлечения ключа из каждого элемента используется указанная функция keySelector.

indexOf

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract fun indexOf(element: E): Int

Возвращает индекс первого вхождения указанного элемента в списке или -1, если указанный элемент отсутствует в списке.

indexOf

Требования к платформе и версии: Common (1.0)

fun <T> Iterable<T>.indexOf(element: T): Int

Возвращает первый индекс элемента или -1, если коллекция не содержит этот элемент.

fun <T> List<T>.indexOf(element: T): Int

Возвращает первый индекс элемента или -1, если список не содержит этот элемент.

indexOfFirst

Требования к платформе и версии: Common (1.0)

inline fun <T> Iterable<T>.indexOfFirst(predicate: (T) -> Boolean): Int

Возвращает индекс первого элемента, соответствующего заданному предикату, или -1, если коллекция не содержит такого элемента.

inline fun <T> List<T>.indexOfFirst(predicate: (T) -> Boolean): Int

Возвращает индекс первого элемента, соответствующего заданному предикату, или -1, если список не содержит такого элемента.

indexOfLast

Требования к платформе и версии: Common (1.0)

inline fun <T> Iterable<T>.indexOfLast(predicate: (T) -> Boolean): Int

Возвращает индекс последнего элемента, соответствующего заданному предикату, или -1, если коллекция не содержит такого элемента.

inline fun <T> List<T>.indexOfLast(predicate: (T) -> Boolean): Int

Возвращает индекс последнего элемента, соответствующего заданному предикату, или -1, если список не содержит такого элемента.

intersect

Требования к платформе и версии: Common (1.0)

infix fun <T> Iterable<T>.intersect(other: Iterable<T>): Set<T>

Возвращает множество, содержащее элементы этой коллекции, которые также входят в указанную другую коллекцию.

isEmpty

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract override fun isEmpty(): Boolean

Возвращает true, если коллекция пуста (не содержит элементов), и false в противном случае.

isNotEmpty

Требования к платформе и версии: Common (1.0)

inline fun <T> Collection<T>.isNotEmpty(): Boolean

Возвращает true, если коллекция не пуста.

isNullOrEmpty

Требования к платформе и версии: Common (1.3)

inline fun <T> Collection<T>?.isNullOrEmpty(): Boolean

Возвращает true, если эта nullable-коллекция равна null или пуста.

isSorted

Требования к платформе и версии: Common (2.4)

fun <T : Comparable<T>> Iterable<T>.isSorted(): Boolean

Возвращает true, если каждый элемент коллекции меньше или равен следующему элементу согласно естественному порядку сортировки.

isSortedBy

Требования к платформе и версии: Common (2.4)

inline fun <T, R : Comparable<R>> Iterable<T>.isSortedBy(selector: (T) -> R?): Boolean

Возвращает true, если для каждого элемента коллекции функция selector возвращает значение, меньшее или равное значению selector следующего элемента согласно естественному порядку сортировки значений selector.

isSortedByDescending

Требования к платформе и версии: Common (2.4)

inline fun <T, R : Comparable<R>> Iterable<T>.isSortedByDescending(selector: (T) -> R?): Boolean

Возвращает true, если для каждого элемента коллекции функция selector возвращает значение, большее или равное значению selector следующего элемента согласно естественному порядку сортировки значений selector.

isSortedDescending

Платформы и требования к версии: Общие (2.4)

fun <T : Comparable<T>> Iterable<T>.isSortedDescending(): Boolean

Возвращает true, если каждый элемент коллекции больше или равен следующему элементу согласно естественному порядку сортировки.

isSortedWith

Платформы и требования к версии: Общие (2.4)

fun <T> Iterable<T>.isSortedWith(comparator: Comparator<in T>): Boolean

Возвращает true, если каждый элемент коллекции меньше или равен следующему элементу согласно указанному компаратору.

iterator

Платформы и требования к версии: Общие (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract operator override fun iterator(): MutableIterator<E>

Возвращает итератор по элементам этого объекта.

joinTo

Платформы и требования к версии: Общие (1.0)

@IgnorableReturnValue
fun <T, A : Appendable> Iterable<T>.joinTo(buffer: A, separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: (T) -> CharSequence? = null): A

Добавляет строки всех элементов, разделённые с помощью разделителя, а также использует указанные префикс и суффикс, если они заданы.

joinToString

Платформы и требования к версии: Общие (1.0)

fun <T> Iterable<T>.joinToString(separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: (T) -> CharSequence? = null): String

Создаёт строку из всех элементов, разделённых с помощью разделителя, а также использует указанные префикс и суффикс, если они заданы.

last

Платформы и требования к версии: Общие (1.0)

fun <T> Iterable<T>.last(): T
fun <T> List<T>.last(): T

Возвращает последний элемент.

inline fun <T> Iterable<T>.last(predicate: (T) -> Boolean): T
inline fun <T> List<T>.last(predicate: (T) -> Boolean): T

Возвращает последний элемент, соответствующий заданному предикату.

lastIndexOf

Платформы и требования к версии: Общие (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract fun lastIndexOf(element: E): Int

Возвращает индекс последнего вхождения указанного элемента в списке или -1, если список не содержит указанный элемент.

lastIndexOf

Платформы и требования к версии: Общие (1.0)

fun <T> Iterable<T>.lastIndexOf(element: T): Int

Возвращает индекс последнего вхождения элемента или -1, если коллекция не содержит этот элемент.

fun <T> List<T>.lastIndexOf(element: T): Int

Возвращает индекс последнего вхождения элемента или -1, если список не содержит этот элемент.

lastOrNull

Платформы и требования к версии: Общие (1.0)

fun <T> Iterable<T>.lastOrNull(): T?

Возвращает последний элемент или null, если коллекция пуста.

fun <T> List<T>.lastOrNull(): T?

Возвращает последний элемент или null, если список пуст.

inline fun <T> Iterable<T>.lastOrNull(predicate: (T) -> Boolean): T?
inline fun <T> List<T>.lastOrNull(predicate: (T) -> Boolean): T?

Возвращает последний элемент, соответствующий заданному предикату, или null, если такой элемент не найден.

listIterator

Платформы и требования к версии: Общие (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract override fun listIterator(): MutableListIterator<E>

Возвращает итератор списка по элементам этого списка (в правильном порядке).

expect abstract override fun listIterator(index: Int): MutableListIterator<E>

Возвращает итератор списка по элементам этого списка (в правильном порядке), начиная с указанного индекса.

map

Платформы и требования к версии: Общие (1.0)

inline fun <T, R> Iterable<T>.map(transform: (T) -> R): List<R>

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

mapIndexed

Платформы и требования к версии: Общие (1.0)

inline fun <T, R> Iterable<T>.mapIndexed(transform: (index: Int, T) -> R): List<R>

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

mapIndexedNotNull

Платформы и требования к версии: Общие (1.0)

inline fun <T, R : Any> Iterable<T>.mapIndexedNotNull(transform: (index: Int, T) -> R?): List<R>

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

mapIndexedNotNullTo

Платформы и требования к версии: Общие (1.0)

@IgnorableReturnValue
inline fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapIndexedNotNullTo(destination: C, transform: (index: Int, T) -> R?): C

Применяет заданную функцию преобразования к каждому элементу и его индексу в исходной коллекции и добавляет только ненулевые результаты в заданную целевую коллекцию.

mapIndexedTo

Платформы и требования к версии: Общие (1.0)

@IgnorableReturnValue
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapIndexedTo(destination: C, transform: (index: Int, T) -> R): C

Применяет заданную функцию преобразования к каждому элементу и его индексу в исходной коллекции и добавляет результаты в заданную целевую коллекцию.

mapNotNull

Платформы и требования к версии: Общие (1.0)

inline fun <T, R : Any> Iterable<T>.mapNotNull(transform: (T) -> R?): List<R>

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

mapNotNullTo

Платформы и требования к версии: Общие (1.0)

@IgnorableReturnValue
inline fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapNotNullTo(destination: C, transform: (T) -> R?): C

Применяет заданную функцию преобразования к каждому элементу исходной коллекции и добавляет только ненулевые результаты в заданную целевую коллекцию.

mapTo

Платформы и требования к версии: Общие (1.0)

@IgnorableReturnValue
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapTo(destination: C, transform: (T) -> R): C

Применяет заданную функцию преобразования к каждому элементу исходной коллекции и добавляет результаты в заданную целевую коллекцию.

max

Платформы и требования к версии: Общие (1.7)

@JvmName(name = "maxOrThrow")
fun <T : Comparable<T>> Iterable<T>.max(): T
@JvmName(name = "maxOrThrow")
fun Iterable<Double>.max(): Double
@JvmName(name = "maxOrThrow")
fun Iterable<Float>.max(): Float

Возвращает наибольший элемент.

Платформы и требования к версии: JVM (1.0)

fun <T : Comparable<T>> Iterable<T>.max(): T?
fun Iterable<Double>.max(): Double?
fun Iterable<Float>.max(): Float?
maxBy

Платформы и требования к версии: Общие (1.7)

@JvmName(name = "maxByOrThrow")
inline fun <T, R : Comparable<R>> Iterable<T>.maxBy(selector: (T) -> R): T

Возвращает первый элемент, для которого функция выбора возвращает наибольшее значение.

Платформы и требования к версии: JVM (1.0)

inline fun <T, R : Comparable<R>> Iterable<T>.maxBy(selector: (T) -> R): T?
maxByOrNull

Платформы и требования к версии: Общие (1.4)

inline fun <T, R : Comparable<R>> Iterable<T>.maxByOrNull(selector: (T) -> R): T?

Возвращает первый элемент, для которого функция выбора возвращает наибольшее значение, или null, если элементов нет.

maxOf

Платформы и требования к версии: Общие (1.4)

inline fun <T, R : Comparable<R>> Iterable<T>.maxOf(selector: (T) -> R): R
inline fun <T> Iterable<T>.maxOf(selector: (T) -> Double): Double
inline fun <T> Iterable<T>.maxOf(selector: (T) -> Float): Float

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

maxOfOrNull

Платформы и требования к версии: Общие (1.4)

inline fun <T, R : Comparable<R>> Iterable<T>.maxOfOrNull(selector: (T) -> R): R?
inline fun <T> Iterable<T>.maxOfOrNull(selector: (T) -> Double): Double?
inline fun <T> Iterable<T>.maxOfOrNull(selector: (T) -> Float): Float?

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

maxOfWith

Платформы и требования к версии: Общие (1.4)

inline fun <T, R> Iterable<T>.maxOfWith(comparator: Comparator<in R>, selector: (T) -> R): R

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

maxOfWithOrNull

Платформы и требования к версии: Общие (1.4)

inline fun <T, R> Iterable<T>.maxOfWithOrNull(comparator: Comparator<in R>, selector: (T) -> R): R?

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

maxOrNull

Платформы и требования к версии: Общие (1.4)

fun <T : Comparable<T>> Iterable<T>.maxOrNull(): T?
fun Iterable<Double>.maxOrNull(): Double?
fun Iterable<Float>.maxOrNull(): Float?

Возвращает наибольший элемент или null, если коллекция пуста.

maxWith

Платформы и требования к версии: Общие (1.7)

@JvmName(name = "maxWithOrThrow")
fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): T

Возвращает первый элемент с наибольшим значением согласно заданному компаратору.

Платформы и требования к версии: JVM (1.0)

fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): T?
maxWithOrNull

Платформы и требования к версии: Общие (1.4)

fun <T> Iterable<T>.maxWithOrNull(comparator: Comparator<in T>): T?

Возвращает первый элемент с наибольшим значением согласно заданному компаратору или null, если элементов нет.

min

Платформы и требования к версии: Общие (1.7)

@JvmName(name = "minOrThrow")
fun <T : Comparable<T>> Iterable<T>.min(): T
@JvmName(name = "minOrThrow")
fun Iterable<Double>.min(): Double
@JvmName(name = "minOrThrow")
fun Iterable<Float>.min(): Float

Возвращает наименьший элемент.

Платформы и требования к версии: JVM (1.0)

fun <T : Comparable<T>> Iterable<T>.min(): T?
fun Iterable<Double>.min(): Double?
fun Iterable<Float>.min(): Float?
minBy

Платформы и требования к версии: Общие (1.7)

@JvmName(name = "minByOrThrow")
inline fun <T, R : Comparable<R>> Iterable<T>.minBy(selector: (T) -> R): T

Возвращает первый элемент, для которого функция выбора возвращает наименьшее значение.

Платформы и требования к версии: JVM (1.0)

inline fun <T, R : Comparable<R>> Iterable<T>.minBy(selector: (T) -> R): T?
minByOrNull

Платформы и требования к версии: Общие (1.4)

inline fun <T, R : Comparable<R>> Iterable<T>.minByOrNull(selector: (T) -> R): T?

Возвращает первый элемент, для которого функция выбора возвращает наименьшее значение, или null, если элементов нет.

minOf

Платформы и требования к версии: Общие (1.4)

inline fun <T, R : Comparable<R>> Iterable<T>.minOf(selector: (T) -> R): R
inline fun <T> Iterable<T>.minOf(selector: (T) -> Double): Double
inline fun <T> Iterable<T>.minOf(selector: (T) -> Float): Float

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

minOfOrNull

Платформы и требования к версии: Общие (1.4)

inline fun <T, R : Comparable<R>> Iterable<T>.minOfOrNull(selector: (T) -> R): R?
inline fun <T> Iterable<T>.minOfOrNull(selector: (T) -> Double): Double?
inline fun <T> Iterable<T>.minOfOrNull(selector: (T) -> Float): Float?

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

minOfWith

Платформы и требования к версии: Общие (1.4)

inline fun <T, R> Iterable<T>.minOfWith(comparator: Comparator<in R>, selector: (T) -> R): R

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

minOfWithOrNull

Платформы и требования к версии: Общие (1.4)

inline fun <T, R> Iterable<T>.minOfWithOrNull(comparator: Comparator<in R>, selector: (T) -> R): R?

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

minOrNull

Платформы и требования к версии: Общие (1.4)

fun <T : Comparable<T>> Iterable<T>.minOrNull(): T?
fun Iterable<Double>.minOrNull(): Double?
fun Iterable<Float>.minOrNull(): Float?

Возвращает наименьший элемент или null, если коллекция пуста.

minus

Платформы и требования к версии: Общие (1.0)

operator fun <T> Iterable<T>.minus(element: T): List<T>

Возвращает список, содержащий все элементы исходной коллекции, кроме первого вхождения заданного элемента.

operator fun <T> Iterable<T>.minus(elements: Array<out T>): List<T>

Возвращает список, содержащий все элементы исходной коллекции, кроме элементов, содержащихся в заданном массиве элементов.

operator fun <T> Iterable<T>.minus(elements: Iterable<T>): List<T>

Возвращает список, содержащий все элементы исходной коллекции, кроме элементов, содержащихся в заданной коллекции элементов.

operator fun <T> Iterable<T>.minus(elements: Sequence<T>): List<T>

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

minusAssign

Платформы и требования к версии: Общие (1.0)

inline operator fun <T> MutableCollection<in T>.minusAssign(element: T)

Удаляет один экземпляр указанного элемента из этой изменяемой коллекции.

inline operator fun <T> MutableCollection<in T>.minusAssign(elements: Array<T>)

Удаляет из этой изменяемой коллекции все элементы, содержащиеся в заданном массиве элементов.

inline operator fun <T> MutableCollection<in T>.minusAssign(elements: Iterable<T>)

Удаляет из этой изменяемой коллекции все элементы, содержащиеся в заданной коллекции элементов.

inline operator fun <T> MutableCollection<in T>.minusAssign(elements: Sequence<T>)

Удаляет из этой изменяемой коллекции все элементы, содержащиеся в заданной последовательности элементов.

minusElement

Платформы и требования к версии: Общие (1.0)

inline fun <T> Iterable<T>.minusElement(element: T): List<T>

Возвращает список, содержащий все элементы исходной коллекции, кроме первого вхождения заданного элемента.

minWith

Платформы и требования к версии: Общие (1.7)

@JvmName(name = "minWithOrThrow")
fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): T

Возвращает первый элемент с наименьшим значением согласно заданному компаратору.

Платформы и требования к версии: JVM (1.0)

fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): T?
minWithOrNull

Платформы и требования к версии: Общие (1.4)

fun <T> Iterable<T>.minWithOrNull(comparator: Comparator<in T>): T?

Возвращает первый элемент с наименьшим значением согласно заданному компаратору или null, если элементов нет.

none

Платформы и требования к версии: Общие (1.0)

fun <T> Iterable<T>.none(): Boolean

Возвращает true, если коллекция не содержит элементов.

inline fun <T> Iterable<T>.none(predicate: (T) -> Boolean): Boolean

Возвращает true, если ни один элемент не соответствует заданному предикату.

orEmpty

Платформы и требования к версии: Общие (1.0)

inline fun <T> Collection<T>?.orEmpty(): Collection<T>

Возвращает эту коллекцию, если она не null, и пустой список в противном случае.

inline fun <T> List<T>?.orEmpty(): List<T>

Возвращает этот список, если он не null, и пустой список в противном случае.

partition

Требования к платформе и версии: Common (1.0)

inline fun <T> Iterable<T>.partition(predicate: (T) -> Boolean): Pair<List<T>, List<T>>

Разбивает исходную коллекцию на пару списков: в первый список входят элементы, для которых предикат вернул true, а во второй список — элементы, для которых предикат вернул false.

plus

Требования к платформе и версии: Common (1.0)

operator fun <T> Collection<T>.plus(element: T): List<T>
operator fun <T> Iterable<T>.plus(element: T): List<T>

Возвращает список, содержащий все элементы исходной коллекции, а затем указанный элемент.

operator fun <T> Collection<T>.plus(elements: Array<out T>): List<T>
operator fun <T> Iterable<T>.plus(elements: Array<out T>): List<T>

Возвращает список, содержащий все элементы исходной коллекции, а затем все элементы указанного массива элементов.

operator fun <T> Collection<T>.plus(elements: Iterable<T>): List<T>
operator fun <T> Iterable<T>.plus(elements: Iterable<T>): List<T>

Возвращает список, содержащий все элементы исходной коллекции, а затем все элементы указанной коллекции элементов.

operator fun <T> Collection<T>.plus(elements: Sequence<T>): List<T>
operator fun <T> Iterable<T>.plus(elements: Sequence<T>): List<T>

Возвращает список, содержащий все элементы исходной коллекции, а затем все элементы указанной последовательности элементов.

plusAssign

Требования к платформе и версии: Common (1.0)

inline operator fun <T> MutableCollection<in T>.plusAssign(element: T)

Добавляет указанный элемент в эту изменяемую коллекцию.

inline operator fun <T> MutableCollection<in T>.plusAssign(elements: Array<T>)

Добавляет все элементы указанного массива элементов в эту изменяемую коллекцию.

inline operator fun <T> MutableCollection<in T>.plusAssign(elements: Iterable<T>)

Добавляет все элементы указанной коллекции элементов в эту изменяемую коллекцию.

inline operator fun <T> MutableCollection<in T>.plusAssign(elements: Sequence<T>)

Добавляет все элементы указанной последовательности элементов в эту изменяемую коллекцию.

plusElement

Требования к платформе и версии: Common (1.0)

inline fun <T> Collection<T>.plusElement(element: T): List<T>
inline fun <T> Iterable<T>.plusElement(element: T): List<T>

Возвращает список, содержащий все элементы исходной коллекции, а затем указанный элемент.

random

Требования к платформе и версии: Common (1.3)

inline fun <T> Collection<T>.random(): T

Возвращает случайный элемент из этой коллекции.

fun <T> Collection<T>.random(random: Random): T

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

randomOrNull

Требования к платформе и версии: Common (1.4)

inline fun <T> Collection<T>.randomOrNull(): T?

Возвращает случайный элемент из этой коллекции или null, если коллекция пуста.

fun <T> Collection<T>.randomOrNull(random: Random): T?

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

reduce

Требования к платформе и версии: Common (1.0)

inline fun <S, T : S> Iterable<T>.reduce(operation: (acc: S, T) -> S): S

Вычисляет итоговое значение, начиная с первого элемента и применяя операцию слева направо к текущему значению аккумулятора и каждому элементу.

reduceIndexed

Требования к платформе и версии: Common (1.0)

inline fun <S, T : S> Iterable<T>.reduceIndexed(operation: (index: Int, acc: S, T) -> S): S

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

reduceIndexedOrNull

Требования к платформе и версии: Common (1.4)

inline fun <S, T : S> Iterable<T>.reduceIndexedOrNull(operation: (index: Int, acc: S, T) -> S): S?

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

reduceOrNull

Требования к платформе и версии: Common (1.4)

inline fun <S, T : S> Iterable<T>.reduceOrNull(operation: (acc: S, T) -> S): S?

Вычисляет итоговое значение, начиная с первого элемента и применяя операцию слева направо к текущему значению аккумулятора и каждому элементу.

reduceRight

Требования к платформе и версии: Common (1.0)

inline fun <S, T : S> List<T>.reduceRight(operation: (T, acc: S) -> S): S

Вычисляет итоговое значение, начиная с последнего элемента и применяя операцию справа налево к каждому элементу и текущему значению аккумулятора.

reduceRightIndexed

Требования к платформе и версии: Common (1.0)

inline fun <S, T : S> List<T>.reduceRightIndexed(operation: (index: Int, T, acc: S) -> S): S

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

reduceRightIndexedOrNull

Требования к платформе и версии: Common (1.4)

inline fun <S, T : S> List<T>.reduceRightIndexedOrNull(operation: (index: Int, T, acc: S) -> S): S?

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

reduceRightOrNull

Требования к платформе и версии: Common (1.4)

inline fun <S, T : S> List<T>.reduceRightOrNull(operation: (T, acc: S) -> S): S?

Вычисляет итоговое значение, начиная с последнего элемента и применяя операцию справа налево к каждому элементу и текущему значению аккумулятора.

remove

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

@IgnorableReturnValue
expect abstract override fun remove(element: E): Boolean

Удаляет из этой коллекции один экземпляр указанного элемента, если коллекция его содержит.

remove

Требования к платформе и версии: Common (1.0)

@IgnorableReturnValue
inline fun <T> MutableCollection<out T>.remove(element: T): Boolean

Удаляет из этой коллекции один экземпляр указанного элемента, если он присутствует.

inline fun <T> MutableList<T>.remove(index: Int): T

Удаляет элемент с указанным индексом из этого списка. В Kotlin вместо этого следует использовать функцию MutableList.removeAt.

removeAll

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

@IgnorableReturnValue
expect abstract override fun removeAll(elements: Collection<E>): Boolean

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

removeAll

Требования к платформе и версии: Common (1.0)

@IgnorableReturnValue
fun <T> MutableCollection<in T>.removeAll(elements: Array<out T>): Boolean

Удаляет из этой MutableCollection все элементы, которые также входят в указанный массив элементов.

@IgnorableReturnValue
inline fun <T> MutableCollection<out T>.removeAll(elements: Collection<T>): Boolean

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

@IgnorableReturnValue
fun <T> MutableCollection<in T>.removeAll(elements: Iterable<T>): Boolean

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

@IgnorableReturnValue
fun <T> MutableCollection<in T>.removeAll(elements: Sequence<T>): Boolean

Удаляет из этой MutableCollection все элементы, которые также входят в указанную последовательность элементов.

@IgnorableReturnValue
fun <T> MutableIterable<T>.removeAll(predicate: (T) -> Boolean): Boolean

Удаляет из этой MutableIterable все элементы, соответствующие заданному предикату.

@IgnorableReturnValue
fun <T> MutableList<T>.removeAll(predicate: (T) -> Boolean): Boolean

Удаляет из этого MutableList все элементы, соответствующие заданному предикату.

removeAt

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

@IgnorableReturnValue
expect abstract fun removeAt(index: Int): E

Удаляет элемент списка с указанным индексом.

removeFirst

Требования к платформе и версии: Common (1.4)

@IgnorableReturnValue
fun <T> MutableList<T>.removeFirst(): T

Удаляет первый элемент из этого изменяемого списка и возвращает его; если список пуст, выбрасывает NoSuchElementException.

removeFirstOrNull

Требования к платформе и версии: Common (1.4)

@IgnorableReturnValue
fun <T> MutableList<T>.removeFirstOrNull(): T?

Удаляет первый элемент из этого изменяемого списка и возвращает его либо возвращает null, если список пуст.

removeLast

Требования к платформе и версии: Common (1.4)

@IgnorableReturnValue
fun <T> MutableList<T>.removeLast(): T

Удаляет последний элемент из этого изменяемого списка и возвращает его; если список пуст, выбрасывает NoSuchElementException.

removeLastOrNull

Требования к платформе и версии: Common (1.4)

@IgnorableReturnValue
fun <T> MutableList<T>.removeLastOrNull(): T?

Удаляет последний элемент из этого изменяемого списка и возвращает его либо возвращает null, если список пуст.

replaceAll

Требования к платформе и версии: Native (1.3)

@ExperimentalNativeApi
actual fun <T> MutableList<T>.replaceAll(transformation: (T) -> T)

Заменяет каждый элемент списка результатом указанного преобразования.

requireNoNulls

Требования к платформе и версии: Common (1.0)

fun <T : Any> Iterable<T?>.requireNoNulls(): Iterable<T>
fun <T : Any> List<T?>.requireNoNulls(): List<T>

Возвращает исходную коллекцию, содержащую все элементы, отличные от null; если в ней есть элементы null, выбрасывает IllegalArgumentException.

retainAll

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

@IgnorableReturnValue
expect abstract override fun retainAll(elements: Collection<E>): Boolean

Оставляет в этой коллекции только элементы, содержащиеся в указанной коллекции.

retainAll

Требования к платформе и версии: Common (1.0)

@IgnorableReturnValue
fun <T> MutableCollection<in T>.retainAll(elements: Array<out T>): Boolean

Оставляет в этой MutableCollection только элементы, содержащиеся в указанном массиве элементов.

@IgnorableReturnValue
inline fun <T> MutableCollection<out T>.retainAll(elements: Collection<T>): Boolean

Оставляет в этой коллекции только элементы, содержащиеся в указанной коллекции.

@IgnorableReturnValue
fun <T> MutableCollection<in T>.retainAll(elements: Iterable<T>): Boolean

Оставляет в этой MutableCollection только элементы, содержащиеся в указанной коллекции элементов.

@IgnorableReturnValue
fun <T> MutableCollection<in T>.retainAll(elements: Sequence<T>): Boolean

Оставляет в этой MutableCollection только элементы, содержащиеся в указанной последовательности элементов.

@IgnorableReturnValue
fun <T> MutableIterable<T>.retainAll(predicate: (T) -> Boolean): Boolean

Оставляет в этой MutableIterable только элементы, соответствующие заданному предикату.

@IgnorableReturnValue
fun <T> MutableList<T>.retainAll(predicate: (T) -> Boolean): Boolean

Оставляет в этом MutableList только элементы, соответствующие заданному предикату.

reverse

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect fun <T> MutableList<T>.reverse()

Меняет порядок элементов списка на обратный на месте.

reversed

Требования к платформе и версии: Common (1.0)

fun <T> Iterable<T>.reversed(): List<T>

Возвращает список с элементами в обратном порядке.

runningFold

Требования к платформе и версии: Common (1.4)

inline fun <T, R> Iterable<T>.runningFold(initial: R, operation: (acc: R, T) -> R): List<R>

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

runningFoldIndexed

Требования к платформе и версии: Common (1.4)

inline fun <T, R> Iterable<T>.runningFoldIndexed(initial: R, operation: (index: Int, acc: R, T) -> R): List<R>

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

runningReduce

Требования к платформе и версии: Common (1.4)

inline fun <S, T : S> Iterable<T>.runningReduce(operation: (acc: S, T) -> S): List<S>

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

runningReduceIndexed

Требования к платформе и версии: Common (1.4)

inline fun <S, T : S> Iterable<T>.runningReduceIndexed(operation: (index: Int, acc: S, T) -> S): List<S>

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

scan

Требования к платформе и версии: Common (1.4)

inline fun <T, R> Iterable<T>.scan(initial: R, operation: (acc: R, T) -> R): List<R>

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

scanIndexed

Требования к платформе и версии: Common (1.4)

inline fun <T, R> Iterable<T>.scanIndexed(initial: R, operation: (index: Int, acc: R, T) -> R): List<R>

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

set

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

@IgnorableReturnValue
expect abstract operator fun set(index: Int, element: E): E

Заменяет элемент в указанной позиции этого списка указанным элементом.

shuffle

Требования к платформе и версии: Common (1.2)

expect fun <T> MutableList<T>.shuffle()

Случайным образом перемешивает элементы этого списка на месте.

fun <T> MutableList<T>.shuffle(random: Random)

Случайным образом перемешивает элементы этого списка на месте, используя указанный экземпляр генератора случайных чисел в качестве источника случайности.

Требования к платформе и версии: JS (1.2), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

actual fun <T> MutableList<T>.shuffle()

Случайным образом перемешивает элементы этого списка на месте.

Требования к платформе и версии: JVM (1.2)

actual inline fun <T> MutableList<T>.shuffle()

Случайным образом перемешивает элементы этого изменяемого списка.

inline fun <T> MutableList<T>.shuffle(random: Random)

Случайным образом перемешивает элементы этого изменяемого списка, используя указанный экземпляр генератора случайных чисел в качестве источника случайности.

shuffled

Требования к платформе и версии: Common (1.2)

expect fun <T> Iterable<T>.shuffled(): List<T>

Возвращает новый список со случайным образом перемешанными элементами этой коллекции.

fun <T> Iterable<T>.shuffled(random: Random): List<T>

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

Требования к платформе и версии: JS (1.2), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

actual fun <T> Iterable<T>.shuffled(): List<T>

Возвращает новый список со случайным образом перемешанными элементами этой коллекции.

Требования к платформе и версии: JVM (1.2)

actual fun <T> Iterable<T>.shuffled(): List<T>

Возвращает новый список со случайным образом перемешанными элементами этой коллекции.

fun <T> Iterable<T>.shuffled(random: Random): List<T>

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

single

Требования к платформе и версии: Common (1.0)

fun <T> Iterable<T>.single(): T

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

fun <T> List<T>.single(): T

Возвращает единственный элемент или выбрасывает исключение, если список пуст или содержит более одного элемента.

inline fun <T> Iterable<T>.single(predicate: (T) -> Boolean): T

Возвращает единственный элемент, соответствующий заданному предикату, или выбрасывает исключение, если совпадений нет или найдено более одного элемента.

singleOrNull

Платформы и требования к версии: Common (1.0)

fun <T> Iterable<T>.singleOrNull(): T?

Возвращает единственный элемент или null, если коллекция пуста или содержит более одного элемента.

fun <T> List<T>.singleOrNull(): T?

Возвращает единственный элемент или null, если список пуст или содержит более одного элемента.

inline fun <T> Iterable<T>.singleOrNull(predicate: (T) -> Boolean): T?

Возвращает единственный элемент, соответствующий заданному предикату, или null, если элемент не найден или найдено более одного элемента.

slice

Платформы и требования к версии: Common (1.0)

fun <T> List<T>.slice(indices: Iterable<Int>): List<T>

Возвращает список, содержащий элементы с указанными индексами.

fun <T> List<T>.slice(indices: IntRange): List<T>

Возвращает список, содержащий элементы с индексами из указанного диапазона индексов.

sort

Платформы и требования к версии: Common (1.0), JS (1.1), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect fun <T : Comparable<T>> MutableList<T>.sort()

Сортирует элементы списка на месте в соответствии с их естественным порядком сортировки.

Платформы и требования к версии: JVM (1.0)

actual fun <T : Comparable<T>> MutableList<T>.sort()

Сортирует элементы списка на месте в соответствии с их естественным порядком сортировки.

inline fun <T> MutableList<T>.sort(comparator: Comparator<in T>)
inline fun <T> MutableList<T>.sort(comparison: (T, T) -> Int)
sortBy

Платформы и требования к версии: Common (1.0)

inline fun <T, R : Comparable<R>> MutableList<T>.sortBy(crossinline selector: (T) -> R?)

Сортирует элементы списка на месте в соответствии с естественным порядком сортировки значений, возвращаемых указанной функцией выбора.

sortByDescending

Платформы и требования к версии: Common (1.0)

inline fun <T, R : Comparable<R>> MutableList<T>.sortByDescending(crossinline selector: (T) -> R?)

Сортирует элементы списка на месте по убыванию в соответствии с естественным порядком сортировки значений, возвращаемых указанной функцией выбора.

sortDescending

Платформы и требования к версии: Common (1.0)

fun <T : Comparable<T>> MutableList<T>.sortDescending()

Сортирует элементы списка на месте по убыванию в соответствии с их естественным порядком сортировки.

sorted

Платформы и требования к версии: Common (1.0)

fun <T : Comparable<T>> Iterable<T>.sorted(): List<T>

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

sortedBy

Платформы и требования к версии: Common (1.0)

inline fun <T, R : Comparable<R>> Iterable<T>.sortedBy(crossinline selector: (T) -> R?): List<T>

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

sortedByDescending

Платформы и требования к версии: Common (1.0)

inline fun <T, R : Comparable<R>> Iterable<T>.sortedByDescending(crossinline selector: (T) -> R?): List<T>

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

sortedDescending

Платформы и требования к версии: Common (1.0)

fun <T : Comparable<T>> Iterable<T>.sortedDescending(): List<T>

Возвращает список всех элементов, отсортированных по убыванию в соответствии с их естественным порядком сортировки.

sortedWith

Платформы и требования к версии: Common (1.0)

fun <T> Iterable<T>.sortedWith(comparator: Comparator<in T>): List<T>

Возвращает список всех элементов, отсортированных с помощью указанного компаратора.

sortWith

Платформы и требования к версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect fun <T> MutableList<T>.sortWith(comparator: Comparator<in T>)

Сортирует элементы списка на месте в порядке, заданном компаратором.

subList

Платформы и требования к версии: Common (1.0), JS (1.1)

expect abstract override fun subList(fromIndex: Int, toIndex: Int): MutableList<E>

Возвращает представление части этого списка между указанными fromIndex (включительно) и toIndex (не включительно). Возвращённый список основан на этом списке, поэтому изменения в возвращённом списке отражаются в этом списке, и наоборот.

Платформы и требования к версии: JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

actual abstract override fun subList(fromIndex: Int, toIndex: Int): MutableList<E>

Возвращает представление части этого списка между указанными fromIndex (включительно) и toIndex (не включительно). Возвращённый список основан на этом списке, поэтому изменения в возвращённом списке отражаются в этом списке, и наоборот.

subtract

Платформы и требования к версии: Common (1.0)

infix fun <T> Iterable<T>.subtract(other: Iterable<T>): Set<T>

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

sum

Платформы и требования к версии: Common (1.0)

@JvmName(name = "sumOfByte")
fun Iterable<Byte>.sum(): Int
@JvmName(name = "sumOfDouble")
fun Iterable<Double>.sum(): Double
@JvmName(name = "sumOfFloat")
fun Iterable<Float>.sum(): Float
@JvmName(name = "sumOfInt")
fun Iterable<Int>.sum(): Int
@JvmName(name = "sumOfLong")
fun Iterable<Long>.sum(): Long
@JvmName(name = "sumOfShort")
fun Iterable<Short>.sum(): Int

Возвращает сумму всех элементов коллекции.

@JvmName(name = "sumOfUByte")
fun Iterable<UByte>.sum(): UInt
@JvmName(name = "sumOfUInt")
fun Iterable<UInt>.sum(): UInt
@JvmName(name = "sumOfULong")
fun Iterable<ULong>.sum(): ULong
@JvmName(name = "sumOfUShort")
fun Iterable<UShort>.sum(): UInt

Возвращает сумму всех элементов коллекции.

sumBy

Платформы и требования к версии: Common (1.0)

inline fun <T> Iterable<T>.sumBy(selector: (T) -> Int): Int

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

sumByDouble

Платформы и требования к версии: Common (1.0)

inline fun <T> Iterable<T>.sumByDouble(selector: (T) -> Double): Double

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

sumOf

Платформы и требования к версии: Common (1.4)

@JvmName(name = "sumOfDouble")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Double): Double
@JvmName(name = "sumOfInt")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Int): Int
@JvmName(name = "sumOfLong")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Long): Long

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

@JvmName(name = "sumOfUInt")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> UInt): UInt
@JvmName(name = "sumOfULong")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> ULong): ULong

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

Платформы и требования к версии: JVM (1.4)

@JvmName(name = "sumOfBigDecimal")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> BigDecimal): BigDecimal
@JvmName(name = "sumOfBigInteger")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> BigInteger): BigInteger

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

take

Платформы и требования к версии: Common (1.0)

fun <T> Iterable<T>.take(n: Int): List<T>

Возвращает список, содержащий первые n элементов.

takeLast

Платформы и требования к версии: Common (1.0)

fun <T> List<T>.takeLast(n: Int): List<T>

Возвращает список, содержащий последние n элементов.

takeLastWhile

Платформы и требования к версии: Common (1.0)

inline fun <T> List<T>.takeLastWhile(predicate: (T) -> Boolean): List<T>

Возвращает список, содержащий последние элементы, удовлетворяющие заданному предикату.

takeWhile

Платформы и требования к версии: Common (1.0)

inline fun <T> Iterable<T>.takeWhile(predicate: (T) -> Boolean): List<T>

Возвращает список, содержащий первые элементы, удовлетворяющие заданному предикату.

toBooleanArray

Платформы и требования к версии: Common (1.0)

fun Collection<Boolean>.toBooleanArray(): BooleanArray

Возвращает массив Boolean, содержащий все элементы этой коллекции.

toByteArray

Платформы и требования к версии: Common (1.0)

fun Collection<Byte>.toByteArray(): ByteArray

Возвращает массив Byte, содержащий все элементы этой коллекции.

toCharArray

Платформы и требования к версии: Common (1.0)

fun Collection<Char>.toCharArray(): CharArray

Возвращает массив Char, содержащий все элементы этой коллекции.

toCollection

Платформы и требования к версии: Common (1.0)

@IgnorableReturnValue
fun <T, C : MutableCollection<in T>> Iterable<T>.toCollection(destination: C): C

Добавляет все элементы в указанную коллекцию назначения.

toCStringArray

Платформы и требования к версии: Native (1.3)

fun List<String>.toCStringArray(autofreeScope: AutofreeScope): CPointer<CPointerVar<ByteVar>>

Преобразует этот список строк Kotlin в массив C-строк, выделяя память для массива и C-строк в указанном AutofreeScope.

toCValues

Платформы и требования к версии: Native (1.3)

fun <T : CPointed> List<CPointer<T>?>.toCValues(): CValues<CPointerVar<T>>
toDoubleArray

Платформы и требования к версии: Common (1.0)

fun Collection<Double>.toDoubleArray(): DoubleArray

Возвращает массив Double, содержащий все элементы этой коллекции.

toFloatArray

Платформы и требования к версии: Common (1.0)

fun Collection<Float>.toFloatArray(): FloatArray

Возвращает массив Float, содержащий все элементы этой коллекции.

toHashSet

Платформы и требования к версии: Common (1.0)

fun <T> Iterable<T>.toHashSet(): HashSet<T>

Возвращает новый HashSet, содержащий все элементы.

toIntArray

Платформы и требования к версии: Common (1.0)

fun Collection<Int>.toIntArray(): IntArray

Возвращает массив Int, содержащий все элементы этой коллекции.

toJsArray

Платформы и требования к версии: JS (2.2)

@ExperimentalWasmJsInterop
actual inline fun <T> List<T>.toJsArray(): JsArray<T>

Платформы и требования к версии: Wasm-JS (1.8)

@ExperimentalWasmJsInterop
actual fun <T : JsAny?> List<T>.toJsArray(): JsArray<T>

Возвращает новый JsArray, содержащий все элементы этого списка.

toList

Платформы и требования к версии: Common (1.0)

fun <T> Iterable<T>.toList(): List<T>

Возвращает список, содержащий все элементы.

toLongArray

Платформы и требования к версии: Common (1.0)

fun Collection<Long>.toLongArray(): LongArray

Возвращает массив Long, содержащий все элементы этой коллекции.

toMap

Платформы и требования к версии: Common (1.0)

fun <K, V> Iterable<Pair<K, V>>.toMap(): Map<K, V>

Возвращает новую карту, содержащую все пары «ключ-значение» из заданной коллекции пар.

@IgnorableReturnValue
fun <K, V, M : MutableMap<in K, in V>> Iterable<Pair<K, V>>.toMap(destination: M): M

Заполняет изменяемую карту назначения парами «ключ-значение» из заданной коллекции пар и возвращает её.

toMutableList

Платформы и требования к версии: Common (1.0)

fun <T> Collection<T>.toMutableList(): MutableList<T>
fun <T> Iterable<T>.toMutableList(): MutableList<T>

Возвращает новый MutableList, заполненный всеми элементами этой коллекции.

toMutableSet

Платформы и требования к версии: Common (1.0)

fun <T> Iterable<T>.toMutableSet(): MutableSet<T>

Возвращает новый MutableSet, содержащий все уникальные элементы заданной коллекции.

toSet

Платформы и требования к версии: Common (1.0)

fun <T> Iterable<T>.toSet(): Set<T>

Возвращает множество, содержащее все элементы.

toShortArray

Платформы и требования к версии: Common (1.0)

fun Collection<Short>.toShortArray(): ShortArray

Возвращает массив Short, содержащий все элементы этой коллекции.

toSortedSet

Платформы и требования к версии: JVM (1.0)

fun <T : Comparable<T>> Iterable<T>.toSortedSet(): SortedSet<T>
fun <T> Iterable<T>.toSortedSet(comparator: Comparator<in T>): SortedSet<T>

Возвращает новый SortedSet, содержащий все элементы.

toTypedArray

Платформы и требования к версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect inline fun <T> Collection<T>.toTypedArray(): Array<T>

Возвращает типизированный массив, содержащий все элементы этой коллекции.

toUByteArray

Платформы и требования к версии: Common (1.3)

@ExperimentalUnsignedTypes
fun Collection<UByte>.toUByteArray(): UByteArray

Возвращает массив UByte, содержащий все элементы этой коллекции.

toUIntArray

Платформы и требования к версии: Common (1.3)

@ExperimentalUnsignedTypes
fun Collection<UInt>.toUIntArray(): UIntArray

Возвращает массив UInt, содержащий все элементы этой коллекции.

toULongArray

Платформы и требования к версии: Common (1.3)

@ExperimentalUnsignedTypes
fun Collection<ULong>.toULongArray(): ULongArray

Возвращает массив ULong, содержащий все элементы этой коллекции.

toUShortArray

Платформы и требования к версии: Common (1.3)

@ExperimentalUnsignedTypes
fun Collection<UShort>.toUShortArray(): UShortArray

Возвращает массив UShort, содержащий все элементы этой коллекции.

union

Платформы и требования к версии: Common (1.0)

infix fun <T> Iterable<T>.union(other: Iterable<T>): Set<T>

Возвращает множество, содержащее все уникальные элементы обеих коллекций.

unzip

Платформы и требования к версии: Common (1.0)

fun <T, R> Iterable<Pair<T, R>>.unzip(): Pair<List<T>, List<R>>

Возвращает пару списков: первый список формируется из первых значений каждой пары этой коллекции, а второй список — из вторых значений каждой пары этой коллекции.

waitForMultipleFutures

Платформы и требования к версии: Native (1.3)

@ObsoleteWorkersApi
fun <T> Collection<Future<T>>.waitForMultipleFutures(millis: Int): Set<Future<T>>
windowed

Платформа и требования к версии: Common (1.2)

fun <T> Iterable<T>.windowed(size: Int, step: Int = 1, partialWindows: Boolean = false): List<List<T>>

Возвращает список снимков окна заданного размера, скользящего по этой коллекции с заданным шагом, где каждый снимок является списком.

fun <T, R> Iterable<T>.windowed(size: Int, step: Int = 1, partialWindows: Boolean = false, transform: (List<T>) -> R): List<R>

Возвращает список результатов применения заданной функции transform к каждому списку, представляющему представление окна заданного размера, скользящего по этой коллекции с заданным шагом.

withIndex

Платформа и требования к версии: Common (1.0)

fun <T> Iterable<T>.withIndex(): Iterable<IndexedValue<T>>

Возвращает ленивый Iterable, который оборачивает каждый элемент исходной коллекции в IndexedValue, содержащий индекс этого элемента и сам элемент.

zip

Платформа и требования к версии: Common (1.0)

infix fun <T, R> Iterable<T>.zip(other: Array<out R>): List<Pair<T, R>>

Возвращает список пар, составленных из элементов коллекции this и массива other с тем же индексом. Возвращаемый список имеет длину кратчайшей коллекции.

infix fun <T, R> Iterable<T>.zip(other: Iterable<R>): List<Pair<T, R>>

Возвращает список пар, составленных из элементов коллекции this и коллекции other с тем же индексом. Возвращаемый список имеет длину кратчайшей коллекции.

inline fun <T, R, V> Iterable<T>.zip(other: Array<out R>, transform: (a: T, b: R) -> V): List<V>

Возвращает список значений, полученных из элементов коллекции this и массива other с тем же индексом с помощью заданной функции transform, применённой к каждой паре элементов. Возвращаемый список имеет длину кратчайшей коллекции.

inline fun <T, R, V> Iterable<T>.zip(other: Iterable<R>, transform: (a: T, b: R) -> V): List<V>

Возвращает список значений, полученных из элементов коллекции this и коллекции other с тем же индексом с помощью заданной функции transform, применённой к каждой паре элементов. Возвращаемый список имеет длину кратчайшей коллекции.

zipWithNext

Платформа и требования к версии: Common (1.2)

fun <T> Iterable<T>.zipWithNext(): List<Pair<T, T>>

Возвращает список пар, состоящих из каждой пары соседних элементов этой коллекции.

inline fun <T, R> Iterable<T>.zipWithNext(transform: (a: T, b: T) -> R): List<R>

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

© 2010–2026 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API