Spec-Zone.ru › Kotlin 1.6

MutableIterable

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

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

Параметры

T - тип итерируемого элемента. Изменяемый итератор инвариантен по типу элемента.

Функции

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

iterator

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

abstract fun iterator(): MutableIterator<T>

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

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

какIterable

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

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

какПоследовательность

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

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

отобразить

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

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

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

отобразитьПоКлючу

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

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

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

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)

отобразитьПоКлючуВ

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

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

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

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)

отобразитьВ

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

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)

отобразитьСоЗначением

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

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

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

associateWithTo

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

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

chunked

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

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

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

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

contains

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

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

count

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

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

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

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)

dropWhile

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

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

elementAt

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

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

elementAtOrElse

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

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

elementAtOrNull

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

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

filter

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

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

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

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

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

findLast

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

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

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

first

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

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

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

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

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

firstNotNullOf

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

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

firstNotNullOfOrNull

Возвращает первое не-null значение, полученное функцией transform, применяемой к элементам этого набора в порядке итерации, или 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> Iterable<T>.firstOrNull(): T?

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

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

flatMap

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

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

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

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

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

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

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

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

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

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

foldIndexed

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

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)

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)

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, применённой к каждому элементу, и помещает в карту destination каждый ключ группы, связанный со списком соответствующих элементов.

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

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

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

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

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

indexOf

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

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

indexOfFirst

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

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

indexOfLast

Возвращает индекс последнего элемента, удовлетворяющего заданному predicate, или -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)

joinTo

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

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

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

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> Iterable<T>.last(): T

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

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

lastIndexOf

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

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

lastOrNull

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

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

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

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

Возвращает список, содержащий только ненулевые результаты применения заданной функции 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 к каждому элементу и его индексу в исходной коллекции и добавляет только ненулевые результаты в заданный destination.

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 к каждому элементу и его индексу в исходной коллекции и добавляет результаты в заданный destination.

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

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

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

mapNotNullTo

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

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 к каждому элементу исходной коллекции и добавляет результаты в заданный destination.

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

maxBy

fun <T, R : Comparable<R>> Iterable<T>.maxBy(
    selector: (T) -> R
): T?
Требования к платформе и версии: 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

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

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

maxOfWithOrNull

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

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

maxWith

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.0), JS (1.0), Native (1.0)

minBy

fun <T, R : Comparable<R>> Iterable<T>.minBy(
    selector: (T) -> R
): 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

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

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

Возвращает наименьшее значение среди всех значений, полученных функцией selector, применённой к каждому элементу в коллекции, или 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

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

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

minWith

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)

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> Iterable<T>.plus(
    elements: Array<out T>
): List<T>

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

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

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

operator fun <T> Iterable<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>
Требования к платформе и версии: 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)

removeAll

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

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

requireNoNulls

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

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

retainAll

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

fun <T> MutableIterable<T>.retainAll(
    predicate: (T) -> Boolean
): Boolean
Требования к платформе и версии: 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

Возвращает список, содержащий последовательные значения накопления, сгенерированные применением операции слева направо к каждому элементу и текущему значению накопителя, которое начинается со значения 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

Возвращает список, содержащий последовательные значения накопления, сгенерированные применением операции слева направо к каждому элементу, его индексу в исходной коллекции и текущему значению накопителя, которое начинается со значения 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

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

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

runningReduceIndexed

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

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

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

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

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

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

shuffled

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

Требования к платформе и версии: 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> Iterable<T>.single(): T

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

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

singleOrNull

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

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

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

fun <T> Iterable<T>.singleOrNull(
    predicate: (T) -> Boolean
): 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

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

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

takeWhile

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

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

toCollection

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

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

toList

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

fun <T> Iterable<T>.toList(): List<T>
Требования к платформе и версии: 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)

toMutableList

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

fun <T> Iterable<T>.toMutableList(): MutableList<T>
Требования к платформе и версии: 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

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

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

toSortedSet

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

fun <T> Iterable<T>.toSortedSet(
    comparator: Comparator<in T>
): SortedSet<T>
Требования к платформе и версии: 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.0), JS (1.0), Native (1.0)

MutableCollection

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

interface MutableCollection<E> : 
    Collection<E>, 
    MutableIterable<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/-mutable-iterable/index.html

Spec-Zone.ru

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