Spec-Zone.ru › Kotlin 1.7

Список

kotlin-stdlib / kotlin.collections / Список
Требования к платформе и версии: JVM (1.0), JS (1.1), Native (1.0)
interface List<out E> : Collection<E>

Обобщённый упорядоченный набор элементов. Методы в этом интерфейсе поддерживают только чтение списка; чтение/запись поддерживается интерфейсом MutableList.

Параметры

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

Свойства

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

размер

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

abstract val size: Int

Функции

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

содержит

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

abstract fun contains(element: E): Boolean
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

содержит_все

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

abstract fun containsAll(elements: Collection<E>): Boolean
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

получить

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

abstract operator fun get(index: Int): E
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

индекс_первого_вхождения

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

abstract fun indexOf(element: E): Int
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

пустой

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

abstract fun isEmpty(): Boolean
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

итератор

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

abstract fun iterator(): Iterator<E>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

индекс_последнего_вхождения

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

abstract fun lastIndexOf(element: E): Int
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

итератор_списка

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

abstract fun listIterator(): ListIterator<E>

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

abstract fun listIterator(index: Int): ListIterator<E>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

подсписок

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

abstract fun subList(fromIndex: Int, toIndex: Int): List<E>

Расширяющие свойства

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

индексы

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

val Collection<*>.indices: IntRange
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

индекс_последнего_элемента

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

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

Расширяющие функции

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

все

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

fun <T> Iterable<T>.all(predicate: (T) -> Boolean): Boolean
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

любой

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

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

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

fun <T> Iterable<T>.any(predicate: (T) -> Boolean): Boolean
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

asIterable

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

fun <T> Iterable<T>.asIterable(): Iterable<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

asReversed

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

fun <T> List<T>.asReversed(): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

asSequence

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

fun <T> Iterable<T>.asSequence(): Sequence<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

associate

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

fun <T, K, V> Iterable<T>.associate(
    transform: (T) -> Pair<K, V>
): Map<K, V>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

associateBy

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

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

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

fun <T, K, V> Iterable<T>.associateBy(
    keySelector: (T) -> K, 
    valueTransform: (T) -> V
): Map<K, V>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

associateByTo

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

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

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

fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateByTo(
    destination: M, 
    keySelector: (T) -> K, 
    valueTransform: (T) -> V
): M
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

associateTo

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

fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateTo(
    destination: M, 
    transform: (T) -> Pair<K, V>
): M
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

associateWith

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

fun <K, V> Iterable<K>.associateWith(
    valueSelector: (K) -> V
): Map<K, V>
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

associateWithTo

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

fun <K, V, M : MutableMap<in K, in V>> Iterable<K>.associateWithTo(
    destination: M, 
    valueSelector: (K) -> V
): M
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

binarySearch

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

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

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

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

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

fun <T> List<T>.binarySearch(
    fromIndex: Int = 0, 
    toIndex: Int = size, 
    comparison: (T) -> Int
): Int
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

binarySearchBy

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

fun <T, K : Comparable<K>> List<T>.binarySearchBy(
    key: K?, 
    fromIndex: Int = 0, 
    toIndex: Int = size, 
    selector: (T) -> K?
): Int
Требования к платформе и версии: JVM (1.2), JS (1.2), Native (1.2)

chunked

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

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

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

fun <T, R> Iterable<T>.chunked(
    size: Int, 
    transform: (List<T>) -> R
): List<R>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

component1

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

operator fun <T> List<T>.component1(): T
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

component2

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

operator fun <T> List<T>.component2(): T
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

component3

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

operator fun <T> List<T>.component3(): T
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

component4

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

operator fun <T> List<T>.component4(): T
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

component5

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

operator fun <T> List<T>.component5(): T
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

contains

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

operator fun <T> Iterable<T>.contains(element: T): Boolean
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

containsAll

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

fun <T> Collection<T>.containsAll(
    elements: Collection<T>
): Boolean
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

count

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

fun <T> Iterable<T>.count(predicate: (T) -> Boolean): Int
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

distinct

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

fun <T> Iterable<T>.distinct(): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

distinctBy

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

fun <T, K> Iterable<T>.distinctBy(
    selector: (T) -> K
): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

drop

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

fun <T> Iterable<T>.drop(n: Int): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

dropLast

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

fun <T> List<T>.dropLast(n: Int): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

dropLastWhile

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

fun <T> List<T>.dropLastWhile(
    predicate: (T) -> Boolean
): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

dropWhile

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

fun <T> Iterable<T>.dropWhile(
    predicate: (T) -> Boolean
): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

elementAt

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

fun <T> List<T>.elementAt(index: Int): T
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

elementAtOrElse

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

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

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

fun <T> Iterable<T>.elementAtOrElse(
    index: Int, 
    defaultValue: (Int) -> T
): T
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

elementAtOrNull

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

fun <T> List<T>.elementAtOrNull(index: Int): T?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

filter

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

fun <T> Iterable<T>.filter(
    predicate: (T) -> Boolean
): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

filterIndexed

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

fun <T> Iterable<T>.filterIndexed(
    predicate: (index: Int, T) -> Boolean
): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

filterIndexedTo

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

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

filterIsInstance

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

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

fun <R> Iterable<*>.filterIsInstance(): List<R>
Требования к платформе и версии: JVM (1.0)

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

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

filterIsInstanceTo

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

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

fun <R, C : MutableCollection<in R>> Iterable<*>.filterIsInstanceTo(
    destination: C
): C
Требования к платформе и версии: JVM (1.0)

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

fun <C : MutableCollection<in R>, R> Iterable<*>.filterIsInstanceTo(
    destination: C, 
    klass: Class<R>
): C
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

filterNot

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

fun <T> Iterable<T>.filterNot(
    predicate: (T) -> Boolean
): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

filterNotNull

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

fun <T : Any> Iterable<T?>.filterNotNull(): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

filterNotNullTo

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

fun <C : MutableCollection<in T>, T : Any> Iterable<T?>.filterNotNullTo(
    destination: C
): C
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

filterNotTo

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

fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo(
    destination: C, 
    predicate: (T) -> Boolean
): C
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

filterTo

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

fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(
    destination: C, 
    predicate: (T) -> Boolean
): C
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

find

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

fun <T> Iterable<T>.find(predicate: (T) -> Boolean): T?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

findLast

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

fun <T> List<T>.findLast(predicate: (T) -> Boolean): T?
fun <T> Iterable<T>.findLast(predicate: (T) -> Boolean): T?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

first

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

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

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

fun <T> Iterable<T>.first(predicate: (T) -> Boolean): T
Требования к платформе и версии: JVM (1.5), JS (1.5), Native (1.5)

firstNotNullOf

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

fun <T, R : Any> Iterable<T>.firstNotNullOf(
    transform: (T) -> R?
): R
Требования к платформе и версии: JVM (1.5), JS (1.5), Native (1.5)

firstNotNullOfOrNull

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

fun <T, R : Any> Iterable<T>.firstNotNullOfOrNull(
    transform: (T) -> R?
): R?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

firstOrNull

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

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

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

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

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

flatMap

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

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

fun <T, R> Iterable<T>.flatMap(
    transform: (T) -> Sequence<R>
): List<R>
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

flatMapIndexed

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

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

fun <T, R> Iterable<T>.flatMapIndexed(
    transform: (index: Int, T) -> Sequence<R>
): List<R>
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

flatMapIndexedTo

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

fun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapIndexedTo(
    destination: C, 
    transform: (index: Int, T) -> Iterable<R>
): C
fun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapIndexedTo(
    destination: C, 
    transform: (index: Int, T) -> Sequence<R>
): C
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

flatMapTo

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

fun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapTo(
    destination: C, 
    transform: (T) -> Iterable<R>
): C
fun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapTo(
    destination: C, 
    transform: (T) -> Sequence<R>
): C
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

flatten

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

fun <T> Iterable<Iterable<T>>.flatten(): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

fold

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

fun <T, R> Iterable<T>.fold(
    initial: R, 
    operation: (acc: R, T) -> R
): R
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

foldIndexed

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

fun <T, R> Iterable<T>.foldIndexed(
    initial: R, 
    operation: (index: Int, acc: R, T) -> R
): R
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

foldRight

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

fun <T, R> List<T>.foldRight(
    initial: R, 
    operation: (T, acc: R) -> R
): R
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

foldRightIndexed

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

fun <T, R> List<T>.foldRightIndexed(
    initial: R, 
    operation: (index: Int, T, acc: R) -> R
): R
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

forEach

Выполняет заданное

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

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

forEachIndexed

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

fun <T> Iterable<T>.forEachIndexed(
    action: (index: Int, T) -> Unit)
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

getOrElse

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

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

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

getOrNull

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

fun <T> List<T>.getOrNull(index: Int): T?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

groupBy

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

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

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

fun <T, K, V> Iterable<T>.groupBy(
    keySelector: (T) -> K, 
    valueTransform: (T) -> V
): Map<K, List<V>>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

groupByTo

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

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

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

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

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

groupingBy

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

fun <T, K> Iterable<T>.groupingBy(
    keySelector: (T) -> K
): Grouping<T, K>
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

ifEmpty

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

fun <C, R> C.ifEmpty(
    defaultValue: () -> R
): R where C : Array<*>, C : R
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

indexOf

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

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

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

fun <T> Iterable<T>.indexOf(element: T): Int
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

indexOfFirst

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

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

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

fun <T> Iterable<T>.indexOfFirst(
    predicate: (T) -> Boolean
): Int
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

indexOfLast

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

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

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

fun <T> Iterable<T>.indexOfLast(
    predicate: (T) -> Boolean
): Int
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

intersect

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

infix fun <T> Iterable<T>.intersect(
    other: Iterable<T>
): Set<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

isNotEmpty

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

fun <T> Collection<T>.isNotEmpty(): Boolean
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

isNullOrEmpty

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

fun <T> Collection<T>?.isNullOrEmpty(): Boolean
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

joinTo

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

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
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

joinToString

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

fun <T> Iterable<T>.joinToString(
    separator: CharSequence = ", ", 
    prefix: CharSequence = "", 
    postfix: CharSequence = "", 
    limit: Int = -1, 
    truncated: CharSequence = "...", 
    transform: ((T) -> CharSequence)? = null
): String
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

last

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

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

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

fun <T> List<T>.last(predicate: (T) -> Boolean): T
fun <T> Iterable<T>.last(predicate: (T) -> Boolean): T
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

lastIndexOf

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

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

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

fun <T> Iterable<T>.lastIndexOf(element: T): Int
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

lastOrNull

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

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

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

fun <T> List<T>.lastOrNull(predicate: (T) -> Boolean): T?
fun <T> Iterable<T>.lastOrNull(predicate: (T) -> Boolean): T?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

map

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

fun <T, R> Iterable<T>.map(transform: (T) -> R): List<R>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

mapIndexed

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

fun <T, R> Iterable<T>.mapIndexed(
    transform: (index: Int, T) -> R
): List<R>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

mapIndexedNotNull

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

fun <T, R : Any> Iterable<T>.mapIndexedNotNull(
    transform: (index: Int, T) -> R?
): List<R>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

mapIndexedNotNullTo

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

fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapIndexedNotNullTo(
    destination: C, 
    transform: (index: Int, T) -> R?
): C
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

mapIndexedTo

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

fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapIndexedTo(
    destination: C, 
    transform: (index: Int, T) -> R
): C
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

mapNotNull

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

fun <T, R : Any> Iterable<T>.mapNotNull(
    transform: (T) -> R?
): List<R>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

mapNotNullTo

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

fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapNotNullTo(
    destination: C, 
    transform: (T) -> R?
): C
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

mapTo

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

fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapTo(
    destination: C, 
    transform: (T) -> R
): C
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

maxByOrNull

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

fun <T, R : Comparable<R>> Iterable<T>.maxByOrNull(
    selector: (T) -> R
): T?
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

maxOf

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

fun <T> Iterable<T>.maxOf(selector: (T) -> Double): Double
fun <T> Iterable<T>.maxOf(selector: (T) -> Float): Float
fun <T, R : Comparable<R>> Iterable<T>.maxOf(
    selector: (T) -> R
): R
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

maxOfOrNull

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

fun <T> Iterable<T>.maxOfOrNull(
    selector: (T) -> Double
): Double?
fun <T> Iterable<T>.maxOfOrNull(
    selector: (T) -> Float
): Float?
fun <T, R : Comparable<R>> Iterable<T>.maxOfOrNull(
    selector: (T) -> R
): R?
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

maxOfWith

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

fun <T, R> Iterable<T>.maxOfWith(
    comparator: Comparator<in R>, 
    selector: (T) -> R
): R
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

maxOfWithOrNull

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

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

maxWith

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

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

fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): T
Требования к платформе и версии: JVM (1.0)
fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): T?
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

maxWithOrNull

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

fun <T> Iterable<T>.maxWithOrNull(
    comparator: Comparator<in T>
): T?
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

minByOrNull

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

fun <T, R : Comparable<R>> Iterable<T>.minByOrNull(
    selector: (T) -> R
): T?
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

minOf

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

fun <T> Iterable<T>.minOf(selector: (T) -> Double): Double
fun <T> Iterable<T>.minOf(selector: (T) -> Float): Float
fun <T, R : Comparable<R>> Iterable<T>.minOf(
    selector: (T) -> R
): R
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

minOfOrNull

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

fun <T> Iterable<T>.minOfOrNull(
    selector: (T) -> Double
): Double?
fun <T> Iterable<T>.minOfOrNull(
    selector: (T) -> Float
): Float?
fun <T, R : Comparable<R>> Iterable<T>.minOfOrNull(
    selector: (T) -> R
): R?
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

minOfWith

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

fun <T, R> Iterable<T>.minOfWith(
    comparator: Comparator<in R>, 
    selector: (T) -> R
): R
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

minOfWithOrNull

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

fun <T, R> Iterable<T>.minOfWithOrNull(
    comparator: Comparator<in R>, 
    selector: (T) -> R
): R?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

minus

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

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>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

minusElement

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

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

minWith

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

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

fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): T
Требования к платформе и версии: JVM (1.0)
fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): T?
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

minWithOrNull

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

fun <T> Iterable<T>.minWithOrNull(
    comparator: Comparator<in T>
): T?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

none

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

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

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

fun <T> Iterable<T>.none(predicate: (T) -> Boolean): Boolean
Требования к платформе и версии: JVM (1.1), JS (1.1), Native (1.1)

onEach

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

fun <T, C : Iterable<T>> C.onEach(action: (T) -> Unit): C
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

onEachIndexed

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

fun <T, C : Iterable<T>> C.onEachIndexed(
    action: (index: Int, T) -> Unit
): C
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

orEmpty

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

fun <T> List<T>?.orEmpty(): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

partition

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

fun <T> Iterable<T>.partition(
    predicate: (T) -> Boolean
): Pair<List<T>, List<T>>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

plus

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

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

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

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

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

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

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

operator fun <T> Iterable<T>.plus(
    elements: Sequence<T>
): List<T>
operator fun <T> Collection<T>.plus(
    elements: Sequence<T>
): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

plusElement

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

fun <T> Iterable<T>.plusElement(element: T): List<T>
fun <T> Collection<T>.plusElement(element: T): List<T>
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

random

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

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

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

fun <T> Collection<T>.random(random: Random): T
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

randomOrNull

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

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

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

fun <T> Collection<T>.randomOrNull(random: Random): T?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

reduce

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

fun <S, T : S> Iterable<T>.reduce(
    operation: (acc: S, T) -> S
): S
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

reduceIndexed

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

fun <S, T : S> Iterable<T>.reduceIndexed(
    operation: (index: Int, acc: S, T) -> S
): S
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

reduceIndexedOrNull

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

fun <S, T : S> Iterable<T>.reduceIndexedOrNull(
    operation: (index: Int, acc: S, T) -> S
): S?
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

reduceOrNull

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

fun <S, T : S> Iterable<T>.reduceOrNull(
    operation: (acc: S, T) -> S
): S?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

reduceRight

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

fun <S, T : S> List<T>.reduceRight(
    operation: (T, acc: S) -> S
): S
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

reduceRightIndexed

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

fun <S, T : S> List<T>.reduceRightIndexed(
    operation: (index: Int, T, acc: S) -> S
): S
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

reduceRightIndexedOrNull

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

fun <S, T : S> List<T>.reduceRightIndexedOrNull(
    operation: (index: Int, T, acc: S) -> S
): S?
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

reduceRightOrNull

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

fun <S, T : S> List<T>.reduceRightOrNull(
    operation: (T, acc: S) -> S
): S?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

requireNoNulls

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

fun <T : Any> List<T?>.requireNoNulls(): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

reversed

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

fun <T> Iterable<T>.reversed(): List<T>
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

runningFold

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

fun <T, R> Iterable<T>.runningFold(
    initial: R, 
    operation: (acc: R, T) -> R
): List<R>
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

runningFoldIndexed

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

fun <T, R> Iterable<T>.runningFoldIndexed(
    initial: R, 
    operation: (index: Int, acc: R, T) -> R
): List<R>
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

runningReduce

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

fun <S, T : S> Iterable<T>.runningReduce(
    operation: (acc: S, T) -> S
): List<S>
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

runningReduceIndexed

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

fun <S, T : S> Iterable<T>.runningReduceIndexed(
    operation: (index: Int, acc: S, T) -> S
): List<S>
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

scan

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

fun <T, R> Iterable<T>.scan(
    initial: R, 
    operation: (acc: R, T) -> R
): List<R>
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

scanIndexed

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

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

shuffled

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

Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)
fun <T> Iterable<T>.shuffled(random: Random): List<T>
Требования к платформе и версии: JVM (1.2)
fun <T> Iterable<T>.shuffled(random: Random): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

single

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

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

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

fun <T> Iterable<T>.single(predicate: (T) -> Boolean): T
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

singleOrNull

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

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

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

fun <T> Iterable<T>.singleOrNull(
    predicate: (T) -> Boolean
): T?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

slice

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

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

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

fun <T> List<T>.slice(indices: Iterable<Int>): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

sortedBy

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

fun <T, R : Comparable<R>> Iterable<T>.sortedBy(
    selector: (T) -> R?
): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

sortedByDescending

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

fun <T, R : Comparable<R>> Iterable<T>.sortedByDescending(
    selector: (T) -> R?
): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

sortedWith

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

fun <T> Iterable<T>.sortedWith(
    comparator: Comparator<in T>
): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

subtract

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

infix fun <T> Iterable<T>.subtract(
    other: Iterable<T>
): Set<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

sumBy

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

fun <T> Iterable<T>.sumBy(selector: (T) -> Int): Int
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

sumByDouble

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

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

sumOf

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

Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)
fun <T> Iterable<T>.sumOf(selector: (T) -> Double): Double
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)
fun <T> Iterable<T>.sumOf(selector: (T) -> Int): Int
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)
fun <T> Iterable<T>.sumOf(selector: (T) -> Long): Long
Требования к платформе и версии: JVM (1.5), JS (1.5), Native (1.5)
fun <T> Iterable<T>.sumOf(selector: (T) -> UInt): UInt
Требования к платформе и версии: JVM (1.5), JS (1.5), Native (1.5)
fun <T> Iterable<T>.sumOf(selector: (T) -> ULong): ULong
Требования к платформе и версии: JVM (1.4)
fun <T> Iterable<T>.sumOf(
    selector: (T) -> BigDecimal
): BigDecimal
Требования к платформе и версии: JVM (1.4)
fun <T> Iterable<T>.sumOf(
    selector: (T) -> BigInteger
): BigInteger
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

take

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

fun <T> Iterable<T>.take(n: Int): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

takeLast

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

fun <T> List<T>.takeLast(n: Int): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

takeLastWhile

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

fun <T> List<T>.takeLastWhile(
    predicate: (T) -> Boolean
): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

takeWhile

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

fun <T> Iterable<T>.takeWhile(
    predicate: (T) -> Boolean
): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toBooleanArray

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

fun Collection<Boolean>.toBooleanArray(): BooleanArray
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toByteArray

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

fun Collection<Byte>.toByteArray(): ByteArray
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toCharArray

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

fun Collection<Char>.toCharArray(): CharArray
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toCollection

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

fun <T, C : MutableCollection<in T>> Iterable<T>.toCollection(
    destination: C
): C
Требования к платформе и версии: Native (1.3)

toCStringArray

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

fun List<String>.toCStringArray(
    autofreeScope: AutofreeScope
): CPointer<CPointerVar<ByteVar>>
Требования к платформе и версии: Native (1.3)

toCValues

fun <T : CPointed> List<CPointer<T>?>.toCValues(): CValues<CPointerVar<T>>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toDoubleArray

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

fun Collection<Double>.toDoubleArray(): DoubleArray
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toFloatArray

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

fun Collection<Float>.toFloatArray(): FloatArray
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toHashSet

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

fun <T> Iterable<T>.toHashSet(): HashSet<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toIntArray

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

fun Collection<Int>.toIntArray(): IntArray
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toList

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

fun <T> Iterable<T>.toList(): List<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toLongArray

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

fun Collection<Long>.toLongArray(): LongArray
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toMap

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

fun <K, V> Iterable<Pair<K, V>>.toMap(): Map<K, V>

Заполняет и возвращает изменяемую карту destination парами ключ-значение из данной коллекции пар.

fun <K, V, M : MutableMap<in K, in V>> Iterable<Pair<K, V>>.toMap(
    destination: M
): M
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toMutableSet

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

fun <T> Iterable<T>.toMutableSet(): MutableSet<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toSet

Возвращает Set всех элементов.

fun <T> Iterable<T>.toSet(): Set<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toShortArray

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

fun Collection<Short>.toShortArray(): ShortArray
Требования к платформе и версии: JVM (1.0)

toSortedSet

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

fun <T> Iterable<T>.toSortedSet(
    comparator: Comparator<in T>
): SortedSet<T>
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

toUByteArray

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

fun Collection<UByte>.toUByteArray(): UByteArray
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

toUIntArray

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

fun Collection<UInt>.toUIntArray(): UIntArray
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

toULongArray

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

fun Collection<ULong>.toULongArray(): ULongArray
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

toUShortArray

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

fun Collection<UShort>.toUShortArray(): UShortArray
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

union

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

infix fun <T> Iterable<T>.union(other: Iterable<T>): Set<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

unzip

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

fun <T, R> Iterable<Pair<T, R>>.unzip(): Pair<List<T>, List<R>>
Требования к платформе и версии: JVM (1.2), JS (1.2), Native (1.2)

windowed

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

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>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

withIndex

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

fun <T> Iterable<T>.withIndex(): Iterable<IndexedValue<T>>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

zip

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

infix fun <T, R> Iterable<T>.zip(
    other: Array<out R>
): List<Pair<T, R>>

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

fun <T, R, V> Iterable<T>.zip(
    other: Array<out R>, 
    transform: (a: T, b: R) -> V
): List<V>

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

infix fun <T, R> Iterable<T>.zip(
    other: Iterable<R>
): List<Pair<T, R>>

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

fun <T, R, V> Iterable<T>.zip(
    other: Iterable<R>, 
    transform: (a: T, b: R) -> V
): List<V>
Требования к платформе и версии: JVM (1.2), JS (1.2), Native (1.2)

zipWithNext

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

fun <T> Iterable<T>.zipWithNext(): List<Pair<T, T>>

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

fun <T, R> Iterable<T>.zipWithNext(
    transform: (a: T, b: T) -> R
): List<R>

Наследники

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

AbstractList

Предоставляет скелетное реализацию интерфейса read-only List.

abstract class AbstractList<out E> : 
    AbstractCollection<E>, 
    List<E>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

MutableList

Обобщённый упорядоченный набор элементов, поддерживающий добавление и удаление элементов.

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

© 2010–2022 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API