kotlin-stdlib/kotlin.collections/MutableSet

MutableSet

interface MutableSet<E> : Set<E> , MutableCollection<E>

A generic unordered collection of elements that does not support duplicate elements, and supports adding and removing elements.

interface MutableSet<E> : Set<E> , MutableCollection<E>

A generic unordered collection of elements that does not support duplicate elements, and supports adding and removing elements.

interface MutableSet<E> : Set<E> , MutableCollection<E>

A generic unordered collection of elements that does not support duplicate elements, and supports adding and removing elements.

interface MutableSet<E> : Set<E> , MutableCollection<E>

A generic unordered collection of elements that does not support duplicate elements, and supports adding and removing elements.

Parameters

E

the type of elements contained in the set. The mutable set is invariant in its element type.

E

the type of elements contained in the set. The mutable set is invariant in its element type.

E

the type of elements contained in the set. The mutable set is invariant in its element type.

E

the type of elements contained in the set. The mutable set is invariant in its element type.

Functions

Link copied to clipboard
abstract override fun add(element: E): Boolean

Adds the specified element to the set.

abstract override fun add(element: E): Boolean

Adds the specified element to the set.

abstract override fun add(element: E): Boolean

Adds the specified element to the set.

abstract override fun add(element: E): Boolean

Adds the specified element to the set.

Link copied to clipboard
abstract override fun addAll(elements: Collection<E>): Boolean
abstract override fun addAll(elements: Collection<E>): Boolean

Adds all of the elements of the specified collection to this collection.

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

Adds all of the elements of the specified collection to this collection.

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

Adds all of the elements of the specified collection to this collection.

Link copied to clipboard
abstract override fun clear()
abstract override fun clear()

Removes all elements from this collection.

abstract override fun clear()

Removes all elements from this collection.

abstract override fun clear()

Removes all elements from this collection.

Link copied to clipboard
abstract operator override fun contains(element: E): Boolean
abstract operator override fun contains(element: E): Boolean

Checks if the specified element is contained in this collection.

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

Checks if the specified element is contained in this collection.

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

Checks if the specified element is contained in this collection.

Link copied to clipboard
abstract override fun containsAll(elements: Collection<E>): Boolean
abstract override fun containsAll(elements: Collection<E>): Boolean

Checks if all elements in the specified collection are contained in this collection.

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

Checks if all elements in the specified collection are contained in this collection.

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

Checks if all elements in the specified collection are contained in this collection.

Link copied to clipboard
abstract override fun isEmpty(): Boolean
abstract override fun isEmpty(): Boolean

Returns true if the collection is empty (contains no elements), false otherwise.

abstract override fun isEmpty(): Boolean

Returns true if the collection is empty (contains no elements), false otherwise.

abstract override fun isEmpty(): Boolean

Returns true if the collection is empty (contains no elements), false otherwise.

Link copied to clipboard
abstract operator override fun iterator(): MutableIterator<E>
abstract operator override fun iterator(): MutableIterator<E>

Returns an iterator over the elements of this object.

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

Returns an iterator over the elements of this object.

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

Returns an iterator over the elements of this object.

Link copied to clipboard
abstract override fun remove(element: E): Boolean
abstract override fun remove(element: E): Boolean

Removes a single instance of the specified element from this collection, if it is present.

abstract override fun remove(element: E): Boolean

Removes a single instance of the specified element from this collection, if it is present.

abstract override fun remove(element: E): Boolean

Removes a single instance of the specified element from this collection, if it is present.

Link copied to clipboard
abstract override fun removeAll(elements: Collection<E>): Boolean
abstract override fun removeAll(elements: Collection<E>): Boolean

Removes all of this collection's elements that are also contained in the specified collection.

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

Removes all of this collection's elements that are also contained in the specified collection.

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

Removes all of this collection's elements that are also contained in the specified collection.

Link copied to clipboard
abstract override fun retainAll(elements: Collection<E>): Boolean
abstract override fun retainAll(elements: Collection<E>): Boolean

Retains only the elements in this collection that are contained in the specified collection.

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

Retains only the elements in this collection that are contained in the specified collection.

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

Retains only the elements in this collection that are contained in the specified collection.

Properties

Link copied to clipboard
abstract override val size: Int
abstract override val size: Int

Returns the size of the collection.

abstract override val size: Int

Returns the size of the collection.

abstract override val size: Int

Returns the size of the collection.

Inheritors

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Extensions

Link copied to clipboard
fun <T> MutableCollection<in T>.addAll(elements: Iterable<T>): Boolean
fun <T> MutableCollection<in T>.addAll(elements: Iterable<T>): Boolean
fun <T> MutableCollection<in T>.addAll(elements: Iterable<T>): Boolean
fun <T> MutableCollection<in T>.addAll(elements: Iterable<T>): Boolean

Adds all elements of the given elements collection to this MutableCollection.

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

Adds all elements of the given elements sequence to this MutableCollection.

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

Adds all elements of the given elements array to this MutableCollection.

Link copied to clipboard
inline fun <T> Iterable<T>.all(predicate: (T) -> Boolean): Boolean
inline fun <T> Iterable<T>.all(predicate: (T) -> Boolean): Boolean
inline fun <T> Iterable<T>.all(predicate: (T) -> Boolean): Boolean
inline fun <T> Iterable<T>.all(predicate: (T) -> Boolean): Boolean

Returns true if all elements match the given predicate.

Link copied to clipboard
fun <T> Iterable<T>.any(): Boolean
fun <T> Iterable<T>.any(): Boolean
fun <T> Iterable<T>.any(): Boolean
fun <T> Iterable<T>.any(): Boolean

Returns true if collection has at least one element.

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

Returns true if at least one element matches the given predicate.

Link copied to clipboard
inline fun <T> Iterable<T>.asIterable(): Iterable<T>
inline fun <T> Iterable<T>.asIterable(): Iterable<T>
inline fun <T> Iterable<T>.asIterable(): Iterable<T>
inline fun <T> Iterable<T>.asIterable(): Iterable<T>

Returns this collection as an Iterable.

Link copied to clipboard
fun <T> Iterable<T>.asSequence(): Sequence<T>
fun <T> Iterable<T>.asSequence(): Sequence<T>
fun <T> Iterable<T>.asSequence(): Sequence<T>
fun <T> Iterable<T>.asSequence(): Sequence<T>

Creates a Sequence instance that wraps the original collection returning its elements when being iterated.

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

Returns a Map containing key-value pairs provided by transform function applied to elements of the given collection.

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

Returns a Map containing the elements from the given collection indexed by the key returned from keySelector function applied to each element.

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

Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to elements of the given collection.

Link copied to clipboard
inline fun <T, K, M : MutableMap<in K, in T>> Iterable<T>.associateByTo(destination: M, keySelector: (T) -> K): M
inline fun <T, K, M : MutableMap<in K, in T>> Iterable<T>.associateByTo(destination: M, keySelector: (T) -> K): M
inline fun <T, K, M : MutableMap<in K, in T>> Iterable<T>.associateByTo(destination: M, keySelector: (T) -> K): M
inline fun <T, K, M : MutableMap<in K, in T>> Iterable<T>.associateByTo(destination: M, keySelector: (T) -> K): M

Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function applied to each element of the given collection and value is the element itself.

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

Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function and and value is provided by the valueTransform function applied to elements of the given collection.

Link copied to clipboard
inline fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateTo(destination: M, transform: (T) -> Pair<K, V>): M
inline fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateTo(destination: M, transform: (T) -> Pair<K, V>): M
inline fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateTo(destination: M, transform: (T) -> Pair<K, V>): M
inline fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateTo(destination: M, transform: (T) -> Pair<K, V>): M

Populates and returns the destination mutable map with key-value pairs provided by transform function applied to each element of the given collection.

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

Returns a Map where keys are elements from the given collection and values are produced by the valueSelector function applied to each element.

Link copied to clipboard
inline fun <K, V, M : MutableMap<in K, in V>> Iterable<K>.associateWithTo(destination: M, valueSelector: (K) -> V): M
inline fun <K, V, M : MutableMap<in K, in V>> Iterable<K>.associateWithTo(destination: M, valueSelector: (K) -> V): M
inline fun <K, V, M : MutableMap<in K, in V>> Iterable<K>.associateWithTo(destination: M, valueSelector: (K) -> V): M
inline fun <K, V, M : MutableMap<in K, in V>> Iterable<K>.associateWithTo(destination: M, valueSelector: (K) -> V): M

Populates and returns the destination mutable map with key-value pairs for each element of the given collection, where key is the element itself and value is provided by the valueSelector function applied to that key.

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

Returns an average value of elements in the collection.

Link copied to clipboard
fun <T> Iterable<T>.chunked(size: Int): List<List<T>>
fun <T> Iterable<T>.chunked(size: Int): List<List<T>>
fun <T> Iterable<T>.chunked(size: Int): List<List<T>>
fun <T> Iterable<T>.chunked(size: Int): List<List<T>>

Splits this collection into a list of lists each not exceeding the given size.

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

Splits this collection into several lists each not exceeding the given size and applies the given transform function to an each.

Link copied to clipboard
operator fun <T> Iterable<T>.contains(element: T): Boolean
operator fun <T> Iterable<T>.contains(element: T): Boolean
operator fun <T> Iterable<T>.contains(element: T): Boolean
operator fun <T> Iterable<T>.contains(element: T): Boolean

Returns true if element is found in the collection.

Link copied to clipboard
inline fun <T> Collection<T>.containsAll(elements: Collection<T>): Boolean
inline fun <T> Collection<T>.containsAll(elements: Collection<T>): Boolean
inline fun <T> Collection<T>.containsAll(elements: Collection<T>): Boolean
inline fun <T> Collection<T>.containsAll(elements: Collection<T>): Boolean

Checks if all elements in the specified collection are contained in this collection.

Link copied to clipboard
inline fun <T> Collection<T>.count(): Int
fun <T> Iterable<T>.count(): Int
inline fun <T> Collection<T>.count(): Int
fun <T> Iterable<T>.count(): Int
inline fun <T> Collection<T>.count(): Int
fun <T> Iterable<T>.count(): Int
inline fun <T> Collection<T>.count(): Int
fun <T> Iterable<T>.count(): Int

Returns the number of elements in this collection.

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

Returns the number of elements matching the given predicate.

Link copied to clipboard
fun <T> Iterable<T>.distinct(): List<T>
fun <T> Iterable<T>.distinct(): List<T>
fun <T> Iterable<T>.distinct(): List<T>
fun <T> Iterable<T>.distinct(): List<T>

Returns a list containing only distinct elements from the given collection.

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

Returns a list containing only elements from the given collection having distinct keys returned by the given selector function.

Link copied to clipboard
fun <T> Iterable<T>.drop(n: Int): List<T>
fun <T> Iterable<T>.drop(n: Int): List<T>
fun <T> Iterable<T>.drop(n: Int): List<T>
fun <T> Iterable<T>.drop(n: Int): List<T>

Returns a list containing all elements except first n elements.

Link copied to clipboard
inline fun <T> Iterable<T>.dropWhile(predicate: (T) -> Boolean): List<T>
inline fun <T> Iterable<T>.dropWhile(predicate: (T) -> Boolean): List<T>
inline fun <T> Iterable<T>.dropWhile(predicate: (T) -> Boolean): List<T>
inline fun <T> Iterable<T>.dropWhile(predicate: (T) -> Boolean): List<T>

Returns a list containing all elements except first elements that satisfy the given predicate.

Link copied to clipboard
fun <T> Iterable<T>.elementAt(index: Int): T
fun <T> Iterable<T>.elementAt(index: Int): T
fun <T> Iterable<T>.elementAt(index: Int): T
fun <T> Iterable<T>.elementAt(index: Int): T

Returns an element at the given index or throws an IndexOutOfBoundsException if the index is out of bounds of this collection.

Link copied to clipboard
fun <T> Iterable<T>.elementAtOrElse(index: Int, defaultValue: (Int) -> T): T
fun <T> Iterable<T>.elementAtOrElse(index: Int, defaultValue: (Int) -> T): T
fun <T> Iterable<T>.elementAtOrElse(index: Int, defaultValue: (Int) -> T): T
fun <T> Iterable<T>.elementAtOrElse(index: Int, defaultValue: (Int) -> T): T

Returns an element at the given index or the result of calling the defaultValue function if the index is out of bounds of this collection.

Link copied to clipboard
fun <T> Iterable<T>.elementAtOrNull(index: Int): T?
fun <T> Iterable<T>.elementAtOrNull(index: Int): T?
fun <T> Iterable<T>.elementAtOrNull(index: Int): T?
fun <T> Iterable<T>.elementAtOrNull(index: Int): T?

Returns an element at the given index or null if the index is out of bounds of this collection.

Link copied to clipboard
inline fun <T> Iterable<T>.filter(predicate: (T) -> Boolean): List<T>
inline fun <T> Iterable<T>.filter(predicate: (T) -> Boolean): List<T>
inline fun <T> Iterable<T>.filter(predicate: (T) -> Boolean): List<T>
inline fun <T> Iterable<T>.filter(predicate: (T) -> Boolean): List<T>

Returns a list containing only elements matching the given predicate.

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

Returns a list containing only elements matching the given predicate.

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

Appends all elements matching the given predicate to the given destination.

Link copied to clipboard
inline fun <R> Iterable<*>.filterIsInstance(): List<R>
inline fun <R> Iterable<*>.filterIsInstance(): List<R>
inline fun <R> Iterable<*>.filterIsInstance(): List<R>
inline fun <R> Iterable<*>.filterIsInstance(): List<R>

Returns a list containing all elements that are instances of specified type parameter R.

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

Returns a list containing all elements that are instances of specified class.

Link copied to clipboard
inline fun <R, C : MutableCollection<in R>> Iterable<*>.filterIsInstanceTo(destination: C): C
inline fun <R, C : MutableCollection<in R>> Iterable<*>.filterIsInstanceTo(destination: C): C
inline fun <R, C : MutableCollection<in R>> Iterable<*>.filterIsInstanceTo(destination: C): C
inline fun <R, C : MutableCollection<in R>> Iterable<*>.filterIsInstanceTo(destination: C): C

Appends all elements that are instances of specified type parameter R to the given destination.

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

Appends all elements that are instances of specified class to the given destination.

Link copied to clipboard
inline fun <T> Iterable<T>.filterNot(predicate: (T) -> Boolean): List<T>
inline fun <T> Iterable<T>.filterNot(predicate: (T) -> Boolean): List<T>
inline fun <T> Iterable<T>.filterNot(predicate: (T) -> Boolean): List<T>
inline fun <T> Iterable<T>.filterNot(predicate: (T) -> Boolean): List<T>

Returns a list containing all elements not matching the given predicate.

Link copied to clipboard
fun <T : Any> Iterable<T?>.filterNotNull(): List<T>
fun <T : Any> Iterable<T?>.filterNotNull(): List<T>
fun <T : Any> Iterable<T?>.filterNotNull(): List<T>
fun <T : Any> Iterable<T?>.filterNotNull(): List<T>

Returns a list containing all elements that are not null.

Link copied to clipboard
fun <C : MutableCollection<in T>, T : Any> Iterable<T?>.filterNotNullTo(destination: C): C
fun <C : MutableCollection<in T>, T : Any> Iterable<T?>.filterNotNullTo(destination: C): C
fun <C : MutableCollection<in T>, T : Any> Iterable<T?>.filterNotNullTo(destination: C): C
fun <C : MutableCollection<in T>, T : Any> Iterable<T?>.filterNotNullTo(destination: C): C

Appends all elements that are not null to the given destination.

Link copied to clipboard
inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo(destination: C, predicate: (T) -> Boolean): C
inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo(destination: C, predicate: (T) -> Boolean): C
inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo(destination: C, predicate: (T) -> Boolean): C
inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo(destination: C, predicate: (T) -> Boolean): C

Appends all elements not matching the given predicate to the given destination.

Link copied to clipboard
inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(destination: C, predicate: (T) -> Boolean): C
inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(destination: C, predicate: (T) -> Boolean): C
inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(destination: C, predicate: (T) -> Boolean): C
inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(destination: C, predicate: (T) -> Boolean): C

Appends all elements matching the given predicate to the given destination.

Link copied to clipboard
inline fun <T> Iterable<T>.find(predicate: (T) -> Boolean): T?
inline fun <T> Iterable<T>.find(predicate: (T) -> Boolean): T?
inline fun <T> Iterable<T>.find(predicate: (T) -> Boolean): T?
inline fun <T> Iterable<T>.find(predicate: (T) -> Boolean): T?

Returns the first element matching the given predicate, or null if no such element was found.

Link copied to clipboard
inline fun <T> Iterable<T>.findLast(predicate: (T) -> Boolean): T?
inline fun <T> Iterable<T>.findLast(predicate: (T) -> Boolean): T?
inline fun <T> Iterable<T>.findLast(predicate: (T) -> Boolean): T?
inline fun <T> Iterable<T>.findLast(predicate: (T) -> Boolean): T?

Returns the last element matching the given predicate, or null if no such element was found.

Link copied to clipboard
fun <T> Iterable<T>.first(): T
fun <T> Iterable<T>.first(): T
fun <T> Iterable<T>.first(): T
fun <T> Iterable<T>.first(): T

Returns first element.

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

Returns the first element matching the given predicate.

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

Returns the first non-null value produced by transform function being applied to elements of this collection in iteration order, or throws NoSuchElementException if no non-null value was produced.

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

Returns the first non-null value produced by transform function being applied to elements of this collection in iteration order, or null if no non-null value was produced.

Link copied to clipboard
fun <T> Iterable<T>.firstOrNull(): T?
fun <T> Iterable<T>.firstOrNull(): T?
fun <T> Iterable<T>.firstOrNull(): T?
fun <T> Iterable<T>.firstOrNull(): T?

Returns the first element, or null if the collection is empty.

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

Returns the first element matching the given predicate, or null if element was not found.

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

Returns a single list of all elements yielded from results of transform function being invoked on each element of original collection.

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

Returns a single list of all elements yielded from results of transform function being invoked on each element and its index in the original collection.

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

Appends all elements yielded from results of transform function being invoked on each element and its index in the original collection, to the given destination.

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

Appends all elements yielded from results of transform function being invoked on each element of original collection, to the given destination.

Link copied to clipboard
fun <T> Iterable<Iterable<T>>.flatten(): List<T>
fun <T> Iterable<Iterable<T>>.flatten(): List<T>
fun <T> Iterable<Iterable<T>>.flatten(): List<T>
fun <T> Iterable<Iterable<T>>.flatten(): List<T>

Returns a single list of all elements from all collections in the given collection.

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

Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each element.

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

Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each element with its index in the original collection.

Link copied to clipboard
inline fun <T> Iterable<T>.forEach(action: (T) -> Unit)
inline fun <T> Iterable<T>.forEach(action: (T) -> Unit)
inline fun <T> Iterable<T>.forEach(action: (T) -> Unit)
inline fun <T> Iterable<T>.forEach(action: (T) -> Unit)

Performs the given action on each element.

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

Performs the given action on each element, providing sequential index with the element.

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

Groups elements of the original collection by the key returned by the given keySelector function applied to each element and returns a map where each group key is associated with a list of corresponding elements.

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

Groups values returned by the valueTransform function applied to each element of the original collection by the key returned by the given keySelector function applied to the element and returns a map where each group key is associated with a list of corresponding values.

Link copied to clipboard
inline fun <T, K, M : MutableMap<in K, MutableList<T>>> Iterable<T>.groupByTo(destination: M, keySelector: (T) -> K): M
inline fun <T, K, M : MutableMap<in K, MutableList<T>>> Iterable<T>.groupByTo(destination: M, keySelector: (T) -> K): M
inline fun <T, K, M : MutableMap<in K, MutableList<T>>> Iterable<T>.groupByTo(destination: M, keySelector: (T) -> K): M
inline fun <T, K, M : MutableMap<in K, MutableList<T>>> Iterable<T>.groupByTo(destination: M, keySelector: (T) -> K): M

Groups elements of the original collection by the key returned by the given keySelector function applied to each element and puts to the destination map each group key associated with a list of corresponding elements.

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

Groups values returned by the valueTransform function applied to each element of the original collection by the key returned by the given keySelector function applied to the element and puts to the destination map each group key associated with a list of corresponding values.

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

Creates a Grouping source from a collection to be used later with one of group-and-fold operations using the specified keySelector function to extract a key from each element.

Link copied to clipboard
fun <T> Iterable<T>.indexOf(element: T): Int
fun <T> Iterable<T>.indexOf(element: T): Int
fun <T> Iterable<T>.indexOf(element: T): Int
fun <T> Iterable<T>.indexOf(element: T): Int

Returns first index of element, or -1 if the collection does not contain element.

Link copied to clipboard
inline fun <T> Iterable<T>.indexOfFirst(predicate: (T) -> Boolean): Int
inline fun <T> Iterable<T>.indexOfFirst(predicate: (T) -> Boolean): Int
inline fun <T> Iterable<T>.indexOfFirst(predicate: (T) -> Boolean): Int
inline fun <T> Iterable<T>.indexOfFirst(predicate: (T) -> Boolean): Int

Returns index of the first element matching the given predicate, or -1 if the collection does not contain such element.

Link copied to clipboard
inline fun <T> Iterable<T>.indexOfLast(predicate: (T) -> Boolean): Int
inline fun <T> Iterable<T>.indexOfLast(predicate: (T) -> Boolean): Int
inline fun <T> Iterable<T>.indexOfLast(predicate: (T) -> Boolean): Int
inline fun <T> Iterable<T>.indexOfLast(predicate: (T) -> Boolean): Int

Returns index of the last element matching the given predicate, or -1 if the collection does not contain such element.

Link copied to clipboard
val Collection<*>.indices: IntRange
val Collection<*>.indices: IntRange
val Collection<*>.indices: IntRange
val Collection<*>.indices: IntRange

Returns an IntRange of the valid indices for this collection.

Link copied to clipboard
infix fun <T> Iterable<T>.intersect(other: Iterable<T>): Set<T>
infix fun <T> Iterable<T>.intersect(other: Iterable<T>): Set<T>
infix fun <T> Iterable<T>.intersect(other: Iterable<T>): Set<T>
infix fun <T> Iterable<T>.intersect(other: Iterable<T>): Set<T>

Returns a set containing all elements that are contained by both this collection and the specified collection.

Link copied to clipboard
inline fun <T> Collection<T>.isNotEmpty(): Boolean
inline fun <T> Collection<T>.isNotEmpty(): Boolean
inline fun <T> Collection<T>.isNotEmpty(): Boolean
inline fun <T> Collection<T>.isNotEmpty(): Boolean

Returns true if the collection is not empty.

Link copied to clipboard
inline fun <T> Collection<T>?.isNullOrEmpty(): Boolean
inline fun <T> Collection<T>?.isNullOrEmpty(): Boolean
inline fun <T> Collection<T>?.isNullOrEmpty(): Boolean
inline fun <T> Collection<T>?.isNullOrEmpty(): Boolean

Returns true if this nullable collection is either null or empty.

Link copied to clipboard
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
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
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
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

Appends the string from all the elements separated using separator and using the given prefix and postfix if supplied.

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

Creates a string from all the elements separated using separator and using the given prefix and postfix if supplied.

Link copied to clipboard
fun <T> Iterable<T>.last(): T
fun <T> Iterable<T>.last(): T
fun <T> Iterable<T>.last(): T
fun <T> Iterable<T>.last(): T

Returns the last element.

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

Returns the last element matching the given predicate.

Link copied to clipboard
fun <T> Iterable<T>.lastIndexOf(element: T): Int
fun <T> Iterable<T>.lastIndexOf(element: T): Int
fun <T> Iterable<T>.lastIndexOf(element: T): Int
fun <T> Iterable<T>.lastIndexOf(element: T): Int

Returns last index of element, or -1 if the collection does not contain element.

Link copied to clipboard
fun <T> Iterable<T>.lastOrNull(): T?
fun <T> Iterable<T>.lastOrNull(): T?
fun <T> Iterable<T>.lastOrNull(): T?
fun <T> Iterable<T>.lastOrNull(): T?

Returns the last element, or null if the collection is empty.

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

Returns the last element matching the given predicate, or null if no such element was found.

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

Returns a list containing the results of applying the given transform function to each element in the original collection.

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

Returns a list containing the results of applying the given transform function to each element and its index in the original collection.

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

Returns a list containing only the non-null results of applying the given transform function to each element and its index in the original collection.

Link copied to clipboard
inline fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapIndexedNotNullTo(destination: C, transform: (index: Int, T) -> R?): C
inline fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapIndexedNotNullTo(destination: C, transform: (index: Int, T) -> R?): C
inline fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapIndexedNotNullTo(destination: C, transform: (index: Int, T) -> R?): C
inline fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapIndexedNotNullTo(destination: C, transform: (index: Int, T) -> R?): C

Applies the given transform function to each element and its index in the original collection and appends only the non-null results to the given destination.

Link copied to clipboard
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapIndexedTo(destination: C, transform: (index: Int, T) -> R): C
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapIndexedTo(destination: C, transform: (index: Int, T) -> R): C
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapIndexedTo(destination: C, transform: (index: Int, T) -> R): C
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapIndexedTo(destination: C, transform: (index: Int, T) -> R): C

Applies the given transform function to each element and its index in the original collection and appends the results to the given destination.

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

Returns a list containing only the non-null results of applying the given transform function to each element in the original collection.

Link copied to clipboard
inline fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapNotNullTo(destination: C, transform: (T) -> R?): C
inline fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapNotNullTo(destination: C, transform: (T) -> R?): C
inline fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapNotNullTo(destination: C, transform: (T) -> R?): C
inline fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapNotNullTo(destination: C, transform: (T) -> R?): C

Applies the given transform function to each element in the original collection and appends only the non-null results to the given destination.

Link copied to clipboard
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapTo(destination: C, transform: (T) -> R): C
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapTo(destination: C, transform: (T) -> R): C
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapTo(destination: C, transform: (T) -> R): C
inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapTo(destination: C, transform: (T) -> R): C

Applies the given transform function to each element of the original collection and appends the results to the given destination.

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

Returns the first element yielding the largest value of the given function or null if there are no elements.

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

Returns the largest value among all values produced by selector function applied to each element in the collection.

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

Returns the largest value among all values produced by selector function applied to each element in the collection or null if there are no elements.

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

Returns the largest value according to the provided comparator among all values produced by selector function applied to each element in the collection.

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

Returns the largest value according to the provided comparator among all values produced by selector function applied to each element in the collection or null if there are no elements.

Link copied to clipboard
fun Iterable<Double>.maxOrNull(): Double?
fun Iterable<Float>.maxOrNull(): Float?
fun <T : Comparable<T>> Iterable<T>.maxOrNull(): T?
fun Iterable<Double>.maxOrNull(): Double?
fun Iterable<Float>.maxOrNull(): Float?
fun <T : Comparable<T>> Iterable<T>.maxOrNull(): T?
fun Iterable<Double>.maxOrNull(): Double?
fun Iterable<Float>.maxOrNull(): Float?
fun <T : Comparable<T>> Iterable<T>.maxOrNull(): T?
fun Iterable<Double>.maxOrNull(): Double?
fun Iterable<Float>.maxOrNull(): Float?
fun <T : Comparable<T>> Iterable<T>.maxOrNull(): T?

Returns the largest element or null if there are no elements.

Link copied to clipboard
fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): T?
fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): T?
fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): T?
fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): T?
Link copied to clipboard
fun <T> Iterable<T>.maxWithOrNull(comparator: Comparator<in T>): T?
fun <T> Iterable<T>.maxWithOrNull(comparator: Comparator<in T>): T?
fun <T> Iterable<T>.maxWithOrNull(comparator: Comparator<in T>): T?
fun <T> Iterable<T>.maxWithOrNull(comparator: Comparator<in T>): T?

Returns the first element having the largest value according to the provided comparator or null if there are no elements.

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

Returns the first element yielding the smallest value of the given function or null if there are no elements.

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

Returns the smallest value among all values produced by selector function applied to each element in the collection.

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

Returns the smallest value among all values produced by selector function applied to each element in the collection or null if there are no elements.

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

Returns the smallest value according to the provided comparator among all values produced by selector function applied to each element in the collection.

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

Returns the smallest value according to the provided comparator among all values produced by selector function applied to each element in the collection or null if there are no elements.

Link copied to clipboard
fun Iterable<Double>.minOrNull(): Double?
fun Iterable<Float>.minOrNull(): Float?
fun <T : Comparable<T>> Iterable<T>.minOrNull(): T?
fun Iterable<Double>.minOrNull(): Double?
fun Iterable<Float>.minOrNull(): Float?
fun <T : Comparable<T>> Iterable<T>.minOrNull(): T?
fun Iterable<Double>.minOrNull(): Double?
fun Iterable<Float>.minOrNull(): Float?
fun <T : Comparable<T>> Iterable<T>.minOrNull(): T?
fun Iterable<Double>.minOrNull(): Double?
fun Iterable<Float>.minOrNull(): Float?
fun <T : Comparable<T>> Iterable<T>.minOrNull(): T?

Returns the smallest element or null if there are no elements.

Link copied to clipboard
operator fun <T> Set<T>.minus(element: T): Set<T>
operator fun <T> Set<T>.minus(element: T): Set<T>
operator fun <T> Set<T>.minus(element: T): Set<T>
operator fun <T> Set<T>.minus(element: T): Set<T>

Returns a set containing all elements of the original set except the given element.

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

Returns a set containing all elements of the original set except the elements contained in the given elements array.

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

Returns a set containing all elements of the original set except the elements contained in the given elements collection.

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

Returns a set containing all elements of the original set except the elements contained in the given elements sequence.

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

Returns a list containing all elements of the original collection without the first occurrence of the given element.

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

Returns a list containing all elements of the original collection except the elements contained in the given elements array.

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

Returns a list containing all elements of the original collection except the elements contained in the given elements collection.

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

Returns a list containing all elements of the original collection except the elements contained in the given elements sequence.

Link copied to clipboard
inline operator fun <T> MutableCollection<in T>.minusAssign(element: T)
inline operator fun <T> MutableCollection<in T>.minusAssign(element: T)
inline operator fun <T> MutableCollection<in T>.minusAssign(element: T)
inline operator fun <T> MutableCollection<in T>.minusAssign(element: T)

Removes a single instance of the specified element from this mutable collection.

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

Removes all elements contained in the given elements collection from this mutable collection.

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

Removes all elements contained in the given elements array from this mutable collection.

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

Removes all elements contained in the given elements sequence from this mutable collection.

Link copied to clipboard
inline fun <T> Set<T>.minusElement(element: T): Set<T>
inline fun <T> Set<T>.minusElement(element: T): Set<T>
inline fun <T> Set<T>.minusElement(element: T): Set<T>
inline fun <T> Set<T>.minusElement(element: T): Set<T>

Returns a set containing all elements of the original set except the given element.

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

Returns a list containing all elements of the original collection without the first occurrence of the given element.

Link copied to clipboard
fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): T?
fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): T?
fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): T?
fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): T?
Link copied to clipboard
fun <T> Iterable<T>.minWithOrNull(comparator: Comparator<in T>): T?
fun <T> Iterable<T>.minWithOrNull(comparator: Comparator<in T>): T?
fun <T> Iterable<T>.minWithOrNull(comparator: Comparator<in T>): T?
fun <T> Iterable<T>.minWithOrNull(comparator: Comparator<in T>): T?

Returns the first element having the smallest value according to the provided comparator or null if there are no elements.

Link copied to clipboard
fun <T> Iterable<T>.none(): Boolean
fun <T> Iterable<T>.none(): Boolean
fun <T> Iterable<T>.none(): Boolean
fun <T> Iterable<T>.none(): Boolean

Returns true if the collection has no elements.

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

Returns true if no elements match the given predicate.

Link copied to clipboard
inline fun <T> Set<T>?.orEmpty(): Set<T>
inline fun <T> Set<T>?.orEmpty(): Set<T>
inline fun <T> Set<T>?.orEmpty(): Set<T>
inline fun <T> Set<T>?.orEmpty(): Set<T>

Returns this Set if it's not null and the empty set otherwise.

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

Returns this Collection if it's not null and the empty list otherwise.

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

Splits the original collection into pair of lists, where first list contains elements for which predicate yielded true, while second list contains elements for which predicate yielded false.

Link copied to clipboard
operator fun <T> Set<T>.plus(element: T): Set<T>
operator fun <T> Set<T>.plus(element: T): Set<T>
operator fun <T> Set<T>.plus(element: T): Set<T>
operator fun <T> Set<T>.plus(element: T): Set<T>

Returns a set containing all elements of the original set and then the given element if it isn't already in this set.

operator fun <T> Set<T>.plus(elements: Array<out T>): Set<T>
operator fun <T> Set<T>.plus(elements: Array<out T>): Set<T>
operator fun <T> Set<T>.plus(elements: Array<out T>): Set<T>
operator fun <T> Set<T>.plus(elements: Array<out T>): Set<T>

Returns a set containing all elements of the original set and the given elements array, which aren't already in this set.

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

Returns a set containing all elements of the original set and the given elements collection, which aren't already in this set. The returned set preserves the element iteration order of the original set.

operator fun <T> Set<T>.plus(elements: Sequence<T>): Set<T>
operator fun <T> Set<T>.plus(elements: Sequence<T>): Set<T>
operator fun <T> Set<T>.plus(elements: Sequence<T>): Set<T>
operator fun <T> Set<T>.plus(elements: Sequence<T>): Set<T>

Returns a set containing all elements of the original set and the given elements sequence, which aren't already in this set.

operator fun <T> Collection<T>.plus(element: T): List<T>
operator fun <T> Iterable<T>.plus(element: T): List<T>
operator fun <T> Collection<T>.plus(element: T): List<T>
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(element: T): List<T>
operator fun <T> Collection<T>.plus(element: T): List<T>
operator fun <T> Iterable<T>.plus(element: T): List<T>

Returns a list containing all elements of the original collection and then the given element.

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

Returns a list containing all elements of the original collection and then all elements of the given elements array.

operator fun <T> Collection<T>.plus(elements: Iterable<T>): List<T>
operator fun <T> Iterable<T>.plus(elements: Iterable<T>): List<T>
operator fun <T> Collection<T>.plus(elements: Iterable<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: Iterable<T>): List<T>
operator fun <T> Collection<T>.plus(elements: Iterable<T>): List<T>
operator fun <T> Iterable<T>.plus(elements: Iterable<T>): List<T>

Returns a list containing all elements of the original collection and then all elements of the given elements collection.

operator fun <T> Collection<T>.plus(elements: Sequence<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>
operator fun <T> Iterable<T>.plus(elements: Sequence<T>): List<T>
operator fun <T> Collection<T>.plus(elements: Sequence<T>): List<T>
operator fun <T> Iterable<T>.plus(elements: Sequence<T>): List<T>
operator fun <T> Collection<T>.plus(elements: Sequence<T>): List<T>
operator fun <T> Iterable<T>.plus(elements: Sequence<T>): List<T>

Returns a list containing all elements of the original collection and then all elements of the given elements sequence.

Link copied to clipboard
inline operator fun <T> MutableCollection<in T>.plusAssign(element: T)
inline operator fun <T> MutableCollection<in T>.plusAssign(element: T)
inline operator fun <T> MutableCollection<in T>.plusAssign(element: T)
inline operator fun <T> MutableCollection<in T>.plusAssign(element: T)

Adds the specified element to this mutable collection.

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

Adds all elements of the given elements collection to this mutable collection.

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

Adds all elements of the given elements array to this mutable collection.

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

Adds all elements of the given elements sequence to this mutable collection.

Link copied to clipboard
inline fun <T> Set<T>.plusElement(element: T): Set<T>
inline fun <T> Set<T>.plusElement(element: T): Set<T>
inline fun <T> Set<T>.plusElement(element: T): Set<T>
inline fun <T> Set<T>.plusElement(element: T): Set<T>

Returns a set containing all elements of the original set and then the given element if it isn't already in this set.

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

Returns a list containing all elements of the original collection and then the given element.

Link copied to clipboard
inline fun <T> Collection<T>.random(): T
inline fun <T> Collection<T>.random(): T
inline fun <T> Collection<T>.random(): T
inline fun <T> Collection<T>.random(): T

Returns a random element from this collection.

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

Returns a random element from this collection using the specified source of randomness.

Link copied to clipboard
inline fun <T> Collection<T>.randomOrNull(): T?
inline fun <T> Collection<T>.randomOrNull(): T?
inline fun <T> Collection<T>.randomOrNull(): T?
inline fun <T> Collection<T>.randomOrNull(): T?

Returns a random element from this collection, or null if this collection is empty.

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

Returns a random element from this collection using the specified source of randomness, or null if this collection is empty.

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

Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element.

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

Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element with its index in the original collection.

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

Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element with its index in the original collection.

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

Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element.

Link copied to clipboard
inline fun <T> MutableCollection<out T>.remove(element: T): Boolean
inline fun <T> MutableCollection<out T>.remove(element: T): Boolean
inline fun <T> MutableCollection<out T>.remove(element: T): Boolean
inline fun <T> MutableCollection<out T>.remove(element: T): Boolean

Removes a single instance of the specified element from this collection, if it is present.

Link copied to clipboard
inline fun <T> MutableCollection<out T>.removeAll(elements: Collection<T>): Boolean
inline fun <T> MutableCollection<out T>.removeAll(elements: Collection<T>): Boolean
inline fun <T> MutableCollection<out T>.removeAll(elements: Collection<T>): Boolean
inline fun <T> MutableCollection<out T>.removeAll(elements: Collection<T>): Boolean

Removes all of this collection's elements that are also contained in the specified collection.

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

Removes all elements from this MutableCollection that are also contained in the given elements collection.

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

Removes all elements from this MutableCollection that are also contained in the given elements sequence.

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

Removes all elements from this MutableCollection that are also contained in the given elements array.

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

Removes all elements from this MutableIterable that match the given predicate.

Link copied to clipboard
fun <T : Any> Iterable<T?>.requireNoNulls(): Iterable<T>
fun <T : Any> Iterable<T?>.requireNoNulls(): Iterable<T>
fun <T : Any> Iterable<T?>.requireNoNulls(): Iterable<T>
fun <T : Any> Iterable<T?>.requireNoNulls(): Iterable<T>

Returns an original collection containing all the non-null elements, throwing an IllegalArgumentException if there are any null elements.

Link copied to clipboard
inline fun <T> MutableCollection<out T>.retainAll(elements: Collection<T>): Boolean
inline fun <T> MutableCollection<out T>.retainAll(elements: Collection<T>): Boolean
inline fun <T> MutableCollection<out T>.retainAll(elements: Collection<T>): Boolean
inline fun <T> MutableCollection<out T>.retainAll(elements: Collection<T>): Boolean

Retains only the elements in this collection that are contained in the specified collection.

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

Retains only elements of this MutableCollection that are contained in the given elements collection.

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

Retains only elements of this MutableCollection that are contained in the given elements array.

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

Retains only elements of this MutableCollection that are contained in the given elements sequence.

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

Retains only elements of this MutableIterable that match the given predicate.

Link copied to clipboard
fun <T> Iterable<T>.reversed(): List<T>
fun <T> Iterable<T>.reversed(): List<T>
fun <T> Iterable<T>.reversed(): List<T>
fun <T> Iterable<T>.reversed(): List<T>

Returns a list with elements in reversed order.

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

Returns a list containing successive accumulation values generated by applying operation from left to right to each element and current accumulator value that starts with initial value.

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

Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original collection and current accumulator value that starts with initial value.

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

Returns a list containing successive accumulation values generated by applying operation from left to right to each element and current accumulator value that starts with the first element of this collection.

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

Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original collection and current accumulator value that starts with the first element of this collection.

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

Returns a list containing successive accumulation values generated by applying operation from left to right to each element and current accumulator value that starts with initial value.

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

Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original collection and current accumulator value that starts with initial value.

Link copied to clipboard
fun <T> Iterable<T>.shuffled(random: Random): List<T>
fun <T> Iterable<T>.shuffled(random: Random): List<T>
fun <T> Iterable<T>.shuffled(random: Random): List<T>
fun <T> Iterable<T>.shuffled(random: Random): List<T>

Returns a new list with the elements of this list randomly shuffled using the specified random instance as the source of randomness.

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

Returns a new list with the elements of this list randomly shuffled using the specified random instance as the source of randomness.

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

Returns a new list with the elements of this list randomly shuffled.

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

Returns a new list with the elements of this list randomly shuffled.

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

Returns a new list with the elements of this list randomly shuffled.

Link copied to clipboard
fun <T> Iterable<T>.single(): T
fun <T> Iterable<T>.single(): T
fun <T> Iterable<T>.single(): T
fun <T> Iterable<T>.single(): T

Returns the single element, or throws an exception if the collection is empty or has more than one element.

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

Returns the single element matching the given predicate, or throws exception if there is no or more than one matching element.

Link copied to clipboard
fun <T> Iterable<T>.singleOrNull(): T?
fun <T> Iterable<T>.singleOrNull(): T?
fun <T> Iterable<T>.singleOrNull(): T?
fun <T> Iterable<T>.singleOrNull(): T?

Returns single element, or null if the collection is empty or has more than one element.

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

Returns the single element matching the given predicate, or null if element was not found or more than one element was found.

Link copied to clipboard
fun <T : Comparable<T>> Iterable<T>.sorted(): List<T>
fun <T : Comparable<T>> Iterable<T>.sorted(): List<T>
fun <T : Comparable<T>> Iterable<T>.sorted(): List<T>
fun <T : Comparable<T>> Iterable<T>.sorted(): List<T>

Returns a list of all elements sorted according to their natural sort order.

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

Returns a list of all elements sorted according to natural sort order of the value returned by specified selector function.

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

Returns a list of all elements sorted descending according to natural sort order of the value returned by specified selector function.

Link copied to clipboard
fun <T : Comparable<T>> Iterable<T>.sortedDescending(): List<T>
fun <T : Comparable<T>> Iterable<T>.sortedDescending(): List<T>
fun <T : Comparable<T>> Iterable<T>.sortedDescending(): List<T>
fun <T : Comparable<T>> Iterable<T>.sortedDescending(): List<T>

Returns a list of all elements sorted descending according to their natural sort order.

Link copied to clipboard
fun <T> Iterable<T>.sortedWith(comparator: Comparator<in T>): List<T>
fun <T> Iterable<T>.sortedWith(comparator: Comparator<in T>): List<T>
fun <T> Iterable<T>.sortedWith(comparator: Comparator<in T>): List<T>
fun <T> Iterable<T>.sortedWith(comparator: Comparator<in T>): List<T>

Returns a list of all elements sorted according to the specified comparator.

Link copied to clipboard
infix fun <T> Iterable<T>.subtract(other: Iterable<T>): Set<T>
infix fun <T> Iterable<T>.subtract(other: Iterable<T>): Set<T>
infix fun <T> Iterable<T>.subtract(other: Iterable<T>): Set<T>
infix fun <T> Iterable<T>.subtract(other: Iterable<T>): Set<T>

Returns a set containing all elements that are contained by this collection and not contained by the specified collection.

Link copied to clipboard
@JvmName(name = "sumOfByte")
fun Iterable<Byte>.sum(): Int
@JvmName(name = "sumOfShort")
fun Iterable<Short>.sum(): Int
@JvmName(name = "sumOfInt")
fun Iterable<Int>.sum(): Int
@JvmName(name = "sumOfLong")
fun Iterable<Long>.sum(): Long
@JvmName(name = "sumOfFloat")
fun Iterable<Float>.sum(): Float
@JvmName(name = "sumOfDouble")
fun Iterable<Double>.sum(): Double
@JvmName(name = "sumOfUInt")
fun Iterable<UInt>.sum(): UInt
@JvmName(name = "sumOfULong")
fun Iterable<ULong>.sum(): ULong
@JvmName(name = "sumOfUByte")
fun Iterable<UByte>.sum(): UInt
@JvmName(name = "sumOfUShort")
fun Iterable<UShort>.sum(): UInt
@JvmName(name = "sumOfByte")
fun Iterable<Byte>.sum(): Int
@JvmName(name = "sumOfShort")
fun Iterable<Short>.sum(): Int
@JvmName(name = "sumOfInt")
fun Iterable<Int>.sum(): Int
@JvmName(name = "sumOfLong")
fun Iterable<Long>.sum(): Long
@JvmName(name = "sumOfFloat")
fun Iterable<Float>.sum(): Float
@JvmName(name = "sumOfDouble")
fun Iterable<Double>.sum(): Double
@JvmName(name = "sumOfUInt")
fun Iterable<UInt>.sum(): UInt
@JvmName(name = "sumOfULong")
fun Iterable<ULong>.sum(): ULong
@JvmName(name = "sumOfUByte")
fun Iterable<UByte>.sum(): UInt
@JvmName(name = "sumOfUShort")
fun Iterable<UShort>.sum(): UInt
@JvmName(name = "sumOfByte")
fun Iterable<Byte>.sum(): Int
@JvmName(name = "sumOfShort")
fun Iterable<Short>.sum(): Int
@JvmName(name = "sumOfInt")
fun Iterable<Int>.sum(): Int
@JvmName(name = "sumOfLong")
fun Iterable<Long>.sum(): Long
@JvmName(name = "sumOfFloat")
fun Iterable<Float>.sum(): Float
@JvmName(name = "sumOfDouble")
fun Iterable<Double>.sum(): Double
@JvmName(name = "sumOfUInt")
fun Iterable<UInt>.sum(): UInt
@JvmName(name = "sumOfULong")
fun Iterable<ULong>.sum(): ULong
@JvmName(name = "sumOfUByte")
fun Iterable<UByte>.sum(): UInt
@JvmName(name = "sumOfUShort")
fun Iterable<UShort>.sum(): UInt
@JvmName(name = "sumOfByte")
fun Iterable<Byte>.sum(): Int
@JvmName(name = "sumOfShort")
fun Iterable<Short>.sum(): Int
@JvmName(name = "sumOfInt")
fun Iterable<Int>.sum(): Int
@JvmName(name = "sumOfLong")
fun Iterable<Long>.sum(): Long
@JvmName(name = "sumOfFloat")
fun Iterable<Float>.sum(): Float
@JvmName(name = "sumOfDouble")
fun Iterable<Double>.sum(): Double
@JvmName(name = "sumOfUInt")
fun Iterable<UInt>.sum(): UInt
@JvmName(name = "sumOfULong")
fun Iterable<ULong>.sum(): ULong
@JvmName(name = "sumOfUByte")
fun Iterable<UByte>.sum(): UInt
@JvmName(name = "sumOfUShort")
fun Iterable<UShort>.sum(): UInt

Returns the sum of all elements in the collection.

Link copied to clipboard
inline fun <T> Iterable<T>.sumBy(selector: (T) -> Int): Int
inline fun <T> Iterable<T>.sumBy(selector: (T) -> Int): Int
inline fun <T> Iterable<T>.sumBy(selector: (T) -> Int): Int
inline fun <T> Iterable<T>.sumBy(selector: (T) -> Int): Int

Returns the sum of all values produced by selector function applied to each element in the collection.

Link copied to clipboard
inline fun <T> Iterable<T>.sumByDouble(selector: (T) -> Double): Double
inline fun <T> Iterable<T>.sumByDouble(selector: (T) -> Double): Double
inline fun <T> Iterable<T>.sumByDouble(selector: (T) -> Double): Double
inline fun <T> Iterable<T>.sumByDouble(selector: (T) -> Double): Double

Returns the sum of all values produced by selector function applied to each element in the collection.

Link copied to clipboard
@JvmName(name = "sumOfDouble")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Double): Double
@JvmName(name = "sumOfInt")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Int): Int
@JvmName(name = "sumOfLong")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Long): Long
@JvmName(name = "sumOfUInt")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> UInt): UInt
@JvmName(name = "sumOfULong")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> ULong): ULong
@JvmName(name = "sumOfDouble")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Double): Double
@JvmName(name = "sumOfInt")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Int): Int
@JvmName(name = "sumOfLong")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Long): Long
@JvmName(name = "sumOfUInt")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> UInt): UInt
@JvmName(name = "sumOfULong")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> ULong): ULong
@JvmName(name = "sumOfDouble")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Double): Double
@JvmName(name = "sumOfInt")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Int): Int
@JvmName(name = "sumOfLong")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Long): Long
@JvmName(name = "sumOfUInt")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> UInt): UInt
@JvmName(name = "sumOfULong")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> ULong): ULong
@JvmName(name = "sumOfDouble")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Double): Double
@JvmName(name = "sumOfInt")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Int): Int
@JvmName(name = "sumOfLong")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Long): Long
@JvmName(name = "sumOfUInt")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> UInt): UInt
@JvmName(name = "sumOfULong")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> ULong): ULong

Returns the sum of all values produced by selector function applied to each element in the collection.

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

Returns the sum of all values produced by selector function applied to each element in the collection.

Link copied to clipboard
fun <T> Iterable<T>.take(n: Int): List<T>
fun <T> Iterable<T>.take(n: Int): List<T>
fun <T> Iterable<T>.take(n: Int): List<T>
fun <T> Iterable<T>.take(n: Int): List<T>

Returns a list containing first n elements.

Link copied to clipboard
inline fun <T> Iterable<T>.takeWhile(predicate: (T) -> Boolean): List<T>
inline fun <T> Iterable<T>.takeWhile(predicate: (T) -> Boolean): List<T>
inline fun <T> Iterable<T>.takeWhile(predicate: (T) -> Boolean): List<T>
inline fun <T> Iterable<T>.takeWhile(predicate: (T) -> Boolean): List<T>

Returns a list containing first elements satisfying the given predicate.

Link copied to clipboard
fun Collection<Boolean>.toBooleanArray(): BooleanArray
fun Collection<Boolean>.toBooleanArray(): BooleanArray
fun Collection<Boolean>.toBooleanArray(): BooleanArray
fun Collection<Boolean>.toBooleanArray(): BooleanArray

Returns an array of Boolean containing all of the elements of this collection.

Link copied to clipboard
fun Collection<Byte>.toByteArray(): ByteArray
fun Collection<Byte>.toByteArray(): ByteArray
fun Collection<Byte>.toByteArray(): ByteArray
fun Collection<Byte>.toByteArray(): ByteArray

Returns an array of Byte containing all of the elements of this collection.

Link copied to clipboard
fun Collection<Char>.toCharArray(): CharArray
fun Collection<Char>.toCharArray(): CharArray
fun Collection<Char>.toCharArray(): CharArray
fun Collection<Char>.toCharArray(): CharArray

Returns an array of Char containing all of the elements of this collection.

Link copied to clipboard
fun <T, C : MutableCollection<in T>> Iterable<T>.toCollection(destination: C): C
fun <T, C : MutableCollection<in T>> Iterable<T>.toCollection(destination: C): C
fun <T, C : MutableCollection<in T>> Iterable<T>.toCollection(destination: C): C
fun <T, C : MutableCollection<in T>> Iterable<T>.toCollection(destination: C): C

Appends all elements to the given destination collection.

Link copied to clipboard
fun Collection<Double>.toDoubleArray(): DoubleArray
fun Collection<Double>.toDoubleArray(): DoubleArray
fun Collection<Double>.toDoubleArray(): DoubleArray
fun Collection<Double>.toDoubleArray(): DoubleArray

Returns an array of Double containing all of the elements of this collection.

Link copied to clipboard
fun Collection<Float>.toFloatArray(): FloatArray
fun Collection<Float>.toFloatArray(): FloatArray
fun Collection<Float>.toFloatArray(): FloatArray
fun Collection<Float>.toFloatArray(): FloatArray

Returns an array of Float containing all of the elements of this collection.

Link copied to clipboard
fun <T> Iterable<T>.toHashSet(): HashSet<T>
fun <T> Iterable<T>.toHashSet(): HashSet<T>
fun <T> Iterable<T>.toHashSet(): HashSet<T>
fun <T> Iterable<T>.toHashSet(): HashSet<T>

Returns a new HashSet of all elements.

Link copied to clipboard
fun Collection<Int>.toIntArray(): IntArray
fun Collection<Int>.toIntArray(): IntArray
fun Collection<Int>.toIntArray(): IntArray
fun Collection<Int>.toIntArray(): IntArray

Returns an array of Int containing all of the elements of this collection.

Link copied to clipboard
fun <T> Iterable<T>.toList(): List<T>
fun <T> Iterable<T>.toList(): List<T>
fun <T> Iterable<T>.toList(): List<T>
fun <T> Iterable<T>.toList(): List<T>

Returns a List containing all elements.

Link copied to clipboard
fun Collection<Long>.toLongArray(): LongArray
fun Collection<Long>.toLongArray(): LongArray
fun Collection<Long>.toLongArray(): LongArray
fun Collection<Long>.toLongArray(): LongArray

Returns an array of Long containing all of the elements of this collection.

Link copied to clipboard
fun <K, V> Iterable<Pair<K, V>>.toMap(): Map<K, V>
fun <K, V> Iterable<Pair<K, V>>.toMap(): Map<K, V>
fun <K, V> Iterable<Pair<K, V>>.toMap(): Map<K, V>
fun <K, V> Iterable<Pair<K, V>>.toMap(): Map<K, V>

Returns a new map containing all key-value pairs from the given collection of pairs.

fun <K, V, M : MutableMap<in K, in V>> Iterable<Pair<K, V>>.toMap(destination: M): M
fun <K, V, M : MutableMap<in K, in V>> Iterable<Pair<K, V>>.toMap(destination: M): M
fun <K, V, M : MutableMap<in K, in V>> Iterable<Pair<K, V>>.toMap(destination: M): M
fun <K, V, M : MutableMap<in K, in V>> Iterable<Pair<K, V>>.toMap(destination: M): M

Populates and returns the destination mutable map with key-value pairs from the given collection of pairs.

Link copied to clipboard
Link copied to clipboard
fun <T> Iterable<T>.toMutableSet(): MutableSet<T>
fun <T> Iterable<T>.toMutableSet(): MutableSet<T>
fun <T> Iterable<T>.toMutableSet(): MutableSet<T>
fun <T> Iterable<T>.toMutableSet(): MutableSet<T>

Returns a new MutableSet containing all distinct elements from the given collection.

Link copied to clipboard
fun <T> Iterable<T>.toSet(): Set<T>
fun <T> Iterable<T>.toSet(): Set<T>
fun <T> Iterable<T>.toSet(): Set<T>
fun <T> Iterable<T>.toSet(): Set<T>

Returns a Set of all elements.

Link copied to clipboard
fun Collection<Short>.toShortArray(): ShortArray
fun Collection<Short>.toShortArray(): ShortArray
fun Collection<Short>.toShortArray(): ShortArray
fun Collection<Short>.toShortArray(): ShortArray

Returns an array of Short containing all of the elements of this collection.

Link copied to clipboard
fun <T : Comparable<T>> Iterable<T>.toSortedSet(): SortedSet<T>
fun <T> Iterable<T>.toSortedSet(comparator: Comparator<in T>): SortedSet<T>
fun <T : Comparable<T>> Iterable<T>.toSortedSet(): SortedSet<T>
fun <T> Iterable<T>.toSortedSet(comparator: Comparator<in T>): SortedSet<T>
fun <T : Comparable<T>> Iterable<T>.toSortedSet(): SortedSet<T>
fun <T> Iterable<T>.toSortedSet(comparator: Comparator<in T>): SortedSet<T>
fun <T : Comparable<T>> Iterable<T>.toSortedSet(): SortedSet<T>
fun <T> Iterable<T>.toSortedSet(comparator: Comparator<in T>): SortedSet<T>

Returns a new SortedSet of all elements.

Link copied to clipboard
expect inline fun <T> Collection<T>.toTypedArray(): Array<T>
expect inline fun <T> Collection<T>.toTypedArray(): Array<T>
expect inline fun <T> Collection<T>.toTypedArray(): Array<T>
expect inline fun <T> Collection<T>.toTypedArray(): Array<T>
actual inline fun <T> Collection<T>.toTypedArray(): Array<T>
actual inline fun <T> Collection<T>.toTypedArray(): Array<T>
actual inline fun <T> Collection<T>.toTypedArray(): Array<T>
actual inline fun <T> Collection<T>.toTypedArray(): Array<T>

Returns a typed array containing all of the elements of this collection.

actual inline fun <T> Collection<T>.toTypedArray(): Array<T>
actual inline fun <T> Collection<T>.toTypedArray(): Array<T>
actual inline fun <T> Collection<T>.toTypedArray(): Array<T>
actual inline fun <T> Collection<T>.toTypedArray(): Array<T>
actual inline fun <T> Collection<T>.toTypedArray(): Array<T>
actual inline fun <T> Collection<T>.toTypedArray(): Array<T>
actual inline fun <T> Collection<T>.toTypedArray(): Array<T>
actual inline fun <T> Collection<T>.toTypedArray(): Array<T>

Returns a typed array containing all of the elements of this collection.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
infix fun <T> Iterable<T>.union(other: Iterable<T>): Set<T>
infix fun <T> Iterable<T>.union(other: Iterable<T>): Set<T>
infix fun <T> Iterable<T>.union(other: Iterable<T>): Set<T>
infix fun <T> Iterable<T>.union(other: Iterable<T>): Set<T>

Returns a set containing all distinct elements from both collections.

Link copied to clipboard
fun <T, R> Iterable<Pair<T, R>>.unzip(): Pair<List<T>, List<R>>
fun <T, R> Iterable<Pair<T, R>>.unzip(): Pair<List<T>, List<R>>
fun <T, R> Iterable<Pair<T, R>>.unzip(): Pair<List<T>, List<R>>
fun <T, R> Iterable<Pair<T, R>>.unzip(): Pair<List<T>, List<R>>

Returns a pair of lists, where first list is built from the first values of each pair from this collection, second list is built from the second values of each pair from this collection.

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

Returns a list of snapshots of the window of the given size sliding along this collection with the given step, where each snapshot is a list.

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

Returns a list of results of applying the given transform function to an each list representing a view over the window of the given size sliding along this collection with the given step.

Link copied to clipboard
fun <T> Iterable<T>.withIndex(): Iterable<IndexedValue<T>>
fun <T> Iterable<T>.withIndex(): Iterable<IndexedValue<T>>
fun <T> Iterable<T>.withIndex(): Iterable<IndexedValue<T>>
fun <T> Iterable<T>.withIndex(): Iterable<IndexedValue<T>>

Returns a lazy Iterable that wraps each element of the original collection into an IndexedValue containing the index of that element and the element itself.

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

Returns a list of pairs built from the elements of this collection and the other array with the same index. The returned list has length of the shortest collection.

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

Returns a list of values built from the elements of this collection and the other array with the same index using the provided transform function applied to each pair of elements. The returned list has length of the shortest collection.

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

Returns a list of pairs built from the elements of this collection and other collection with the same index. The returned list has length of the shortest collection.

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

Returns a list of values built from the elements of this collection and the other collection with the same index using the provided transform function applied to each pair of elements. The returned list has length of the shortest collection.

Link copied to clipboard
fun <T> Iterable<T>.zipWithNext(): List<Pair<T, T>>
fun <T> Iterable<T>.zipWithNext(): List<Pair<T, T>>
fun <T> Iterable<T>.zipWithNext(): List<Pair<T, T>>
fun <T> Iterable<T>.zipWithNext(): List<Pair<T, T>>

Returns a list of pairs of each two adjacent elements in this collection.

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

Returns a list containing the results of applying the given transform function to an each pair of two adjacent elements in this collection.