Spec-Zone.ru › Kotlin 1.7

MatchGroupCollection

kotlin-stdlib / kotlin.text / MatchGroupCollection
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)
interface MatchGroupCollection : Collection<MatchGroup?>

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

Размер этой коллекции равен groupCount + 1, где groupCount — количество групп в регулярном выражении. Группы индексируются от 1 до groupCount, а группа с индексом 0 соответствует всему совпадению.

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

Функции

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

get

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

abstract operator fun get(index: Int): MatchGroup?

Расширяемые свойства

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

indices

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

val Collection<*>.indices: IntRange

Расширяемые функции

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

all

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

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

any

Возвращает 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)

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

Заполняет и возвращает изменяемую карту 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

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

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)

contains

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

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)

dropWhile

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

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

elementAt

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

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

elementAtOrElse

Возвращает элемент по заданному индексу или результат вызова функции 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> Iterable<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
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

filterIsInstance

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

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

filterIsInstanceTo

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

fun <R, C : MutableCollection<in R>> Iterable<*>.filterIsInstanceTo(
    destination: C
): 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> 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 значение, полученное в результате применения функции transform к элементам этого набора в порядке итерации, или выбрасывает исключение NoSuchElementException, если не было получено не-null значение.

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 значение.

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

firstOrNull

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

null

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

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

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

indexOfFirst

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

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

indexOfLast

Возвращает индекс последнего элемента, соответствующего заданному предикату, или -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 , если этот набираемый набор либо 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> Iterable<T>.last(): T

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

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

lastIndexOf

Возвращает последний индекс элемента, или -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?

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

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

map

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

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

mapIndexed

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

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

mapIndexedNotNull

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

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

mapIndexedNotNullTo

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

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

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.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

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

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

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

maxWith

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

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

maxWithOrNull

Возвращает первый элемент, имеющий наибольшее значение в соответствии с предоставленным comparator или 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

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

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

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

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

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

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

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

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

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

minWith

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

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

minWithOrNull

Возвращает первый элемент с наименьшим значением согласно предоставленному comparator или 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 если ни один элемент не соответствует заданному predicate.

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> Collection<T>?.orEmpty(): Collection<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

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

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

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

shuffled

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

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

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

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

sumOf

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

fun <T> Iterable<T>.sumOf(selector: (T) -> Double): Double
fun <T> Iterable<T>.sumOf(selector: (T) -> Int): Int
fun <T> Iterable<T>.sumOf(selector: (T) -> Long): Long
fun <T> Iterable<T>.sumOf(selector: (T) -> UInt): UInt
fun <T> Iterable<T>.sumOf(selector: (T) -> ULong): ULong
Требования к платформе и версии: 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

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

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)

toMutableSet

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

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)

union

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

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

windowed

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

fun <T> Iterable<T>.windowed(
    size: Int, 
    step: Int = 1, 
    partialWindows: Boolean = false
): List<List<T>>

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

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

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

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>>

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

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

Наследники

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

MatchNamedGroupCollection

Расширяет MatchGroupCollection, вводя способ получения совпавших групп по имени, когда это поддерживается регулярным выражением.

interface MatchNamedGroupCollection : MatchGroupCollection

© 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.text/-match-group-collection/index.html

Spec-Zone.ru

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