W3cubDocs

/Kotlin

ULongRange

Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)
@ExperimentalUnsignedTypes class ULongRange : 
    ULongProgression, 
    ClosedRange<ULong>

A range of values of type ULong.

Constructors

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

<init>

A range of values of type ULong.

ULongRange(start: ULong, endInclusive: ULong)

Properties

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

endInclusive

The maximum value in the range (inclusive).

val endInclusive: ULong
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

start

The minimum value in the range.

val start: ULong

Functions

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

contains

Checks whether the specified value belongs to the range.

fun contains(value: ULong): Boolean
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

equals

Indicates whether some other object is "equal to" this one. Implementations must fulfil the following requirements:

fun equals(other: Any?): Boolean
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

hashCode

Returns a hash code value for the object. The general contract of hashCode is:

fun hashCode(): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

isEmpty

Checks if the progression is empty.

fun isEmpty(): Boolean
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toString

Returns a string representation of the object.

fun toString(): String

Companion Object Properties

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

EMPTY

An empty range of values of type ULong.

val EMPTY: ULongRange

Extension Functions

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

all

Returns true if all elements match the given predicate.

fun <T> Iterable<T>.all(predicate: (T) -> Boolean): Boolean
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

any

Returns true if collection has at least one element.

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

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

fun <T> Iterable<T>.any(predicate: (T) -> Boolean): Boolean
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

asIterable

Returns this collection as an Iterable.

fun <T> Iterable<T>.asIterable(): Iterable<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

asSequence

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

fun <T> Iterable<T>.asSequence(): Sequence<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

associate

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

fun <T, K, V> Iterable<T>.associate(
    transform: (T) -> Pair<K, V>
): Map<K, V>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

associateBy

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

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

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

fun <T, K, V> Iterable<T>.associateBy(
    keySelector: (T) -> K, 
    valueTransform: (T) -> V
): Map<K, V>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

associateByTo

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.

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 and and value is provided by the valueTransform function applied to elements of the given collection.

fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateByTo(
    destination: M, 
    keySelector: (T) -> K, 
    valueTransform: (T) -> V
): M
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

associateTo

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

fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateTo(
    destination: M, 
    transform: (T) -> Pair<K, V>
): M
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

associateWith

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

fun <K, V> Iterable<K>.associateWith(
    valueSelector: (K) -> V
): Map<K, V>
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

associateWithTo

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.

fun <K, V, M : MutableMap<in K, in V>> Iterable<K>.associateWithTo(
    destination: M, 
    valueSelector: (K) -> V
): M
Platform and version requirements: JVM (1.2), JS (1.2), Native (1.2)

chunked

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

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

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

fun <T, R> Iterable<T>.chunked(
    size: Int, 
    transform: (List<T>) -> R
): List<R>
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

contains

Returns true if this range contains the specified element.

operator fun ULongRange.contains(element: ULong?): Boolean

Checks if the specified value belongs to this range.

operator fun ULongRange.contains(value: UByte): Boolean
operator fun ULongRange.contains(value: UInt): Boolean
operator fun ULongRange.contains(value: UShort): Boolean
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

contains

Returns true if element is found in the collection.

operator fun <T> Iterable<T>.contains(element: T): Boolean
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

count

Returns the number of elements in this collection.

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

Returns the number of elements matching the given predicate.

fun <T> Iterable<T>.count(predicate: (T) -> Boolean): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

distinct

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

fun <T> Iterable<T>.distinct(): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

distinctBy

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

fun <T, K> Iterable<T>.distinctBy(
    selector: (T) -> K
): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

drop

Returns a list containing all elements except first n elements.

fun <T> Iterable<T>.drop(n: Int): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

dropWhile

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

fun <T> Iterable<T>.dropWhile(
    predicate: (T) -> Boolean
): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

elementAt

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

fun <T> Iterable<T>.elementAt(index: Int): T
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

elementAtOrElse

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.

fun <T> Iterable<T>.elementAtOrElse(
    index: Int, 
    defaultValue: (Int) -> T
): T
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

elementAtOrNull

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

fun <T> Iterable<T>.elementAtOrNull(index: Int): T?
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

filter

Returns a list containing only elements matching the given predicate.

fun <T> Iterable<T>.filter(
    predicate: (T) -> Boolean
): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

filterIndexed

Returns a list containing only elements matching the given predicate.

fun <T> Iterable<T>.filterIndexed(
    predicate: (index: Int, T) -> Boolean
): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

filterIndexedTo

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

fun <T, C : MutableCollection<in T>> Iterable<T>.filterIndexedTo(
    destination: C, 
    predicate: (index: Int, T) -> Boolean
): C
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

filterIsInstance

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

fun <R> Iterable<*>.filterIsInstance(): List<R>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

filterIsInstanceTo

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

fun <R, C : MutableCollection<in R>> Iterable<*>.filterIsInstanceTo(
    destination: C
): C
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

filterNot

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

fun <T> Iterable<T>.filterNot(
    predicate: (T) -> Boolean
): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

filterNotNull

Returns a list containing all elements that are not null.

fun <T : Any> Iterable<T?>.filterNotNull(): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

filterNotNullTo

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

fun <C : MutableCollection<in T>, T : Any> Iterable<T?>.filterNotNullTo(
    destination: C
): C
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

filterNotTo

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

fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo(
    destination: C, 
    predicate: (T) -> Boolean
): C
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

filterTo

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

fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(
    destination: C, 
    predicate: (T) -> Boolean
): C
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

find

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

fun <T> Iterable<T>.find(predicate: (T) -> Boolean): T?
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

findLast

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

fun <T> Iterable<T>.findLast(predicate: (T) -> Boolean): T?
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

first

Returns first element.

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

Returns the first element matching the given predicate.

fun <T> Iterable<T>.first(predicate: (T) -> Boolean): T
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

firstOrNull

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

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

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

fun <T> Iterable<T>.firstOrNull(
    predicate: (T) -> Boolean
): T?
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

flatMap

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

fun <T, R> Iterable<T>.flatMap(
    transform: (T) -> Iterable<R>
): List<R>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

flatMapTo

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

fun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapTo(
    destination: C, 
    transform: (T) -> Iterable<R>
): C
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

fold

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

fun <T, R> Iterable<T>.fold(
    initial: R, 
    operation: (acc: R, T) -> R
): R
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

foldIndexed

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.

fun <T, R> Iterable<T>.foldIndexed(
    initial: R, 
    operation: (index: Int, acc: R, T) -> R
): R
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

forEach

Performs the given action on each element.

fun <T> Iterable<T>.forEach(action: (T) -> Unit)
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

forEachIndexed

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

fun <T> Iterable<T>.forEachIndexed(
    action: (index: Int, T) -> Unit)
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

groupBy

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.

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

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.

fun <T, K, V> Iterable<T>.groupBy(
    keySelector: (T) -> K, 
    valueTransform: (T) -> V
): Map<K, List<V>>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

groupByTo

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.

fun <T, K, M : MutableMap<in K, MutableList<T>>> Iterable<T>.groupByTo(
    destination: M, 
    keySelector: (T) -> K
): 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.

fun <T, K, V, M : MutableMap<in K, MutableList<V>>> Iterable<T>.groupByTo(
    destination: M, 
    keySelector: (T) -> K, 
    valueTransform: (T) -> V
): M
Platform and version requirements: JVM (1.1), JS (1.1), Native (1.1)

groupingBy

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.

fun <T, K> Iterable<T>.groupingBy(
    keySelector: (T) -> K
): Grouping<T, K>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

indexOf

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

fun <T> Iterable<T>.indexOf(element: T): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

indexOfFirst

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

fun <T> Iterable<T>.indexOfFirst(
    predicate: (T) -> Boolean
): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

indexOfLast

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

fun <T> Iterable<T>.indexOfLast(
    predicate: (T) -> Boolean
): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

intersect

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

infix fun <T> Iterable<T>.intersect(
    other: Iterable<T>
): Set<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

joinTo

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

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
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

joinToString

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

fun <T> Iterable<T>.joinToString(
    separator: CharSequence = ", ", 
    prefix: CharSequence = "", 
    postfix: CharSequence = "", 
    limit: Int = -1, 
    truncated: CharSequence = "...", 
    transform: (T) -> CharSequence = null
): String
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

last

Returns the last element.

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

Returns the last element matching the given predicate.

fun <T> Iterable<T>.last(predicate: (T) -> Boolean): T
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

lastIndexOf

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

fun <T> Iterable<T>.lastIndexOf(element: T): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

lastOrNull

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

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

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

fun <T> Iterable<T>.lastOrNull(predicate: (T) -> Boolean): T?
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

map

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

fun <T, R> Iterable<T>.map(transform: (T) -> R): List<R>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

mapIndexed

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

fun <T, R> Iterable<T>.mapIndexed(
    transform: (index: Int, T) -> R
): List<R>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

mapIndexedNotNull

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.

fun <T, R : Any> Iterable<T>.mapIndexedNotNull(
    transform: (index: Int, T) -> R?
): List<R>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

mapIndexedNotNullTo

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.

fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapIndexedNotNullTo(
    destination: C, 
    transform: (index: Int, T) -> R?
): C
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

mapIndexedTo

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

fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapIndexedTo(
    destination: C, 
    transform: (index: Int, T) -> R
): C
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

mapNotNull

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

fun <T, R : Any> Iterable<T>.mapNotNull(
    transform: (T) -> R?
): List<R>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

mapNotNullTo

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

fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapNotNullTo(
    destination: C, 
    transform: (T) -> R?
): C
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

mapTo

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

fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapTo(
    destination: C, 
    transform: (T) -> R
): C
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

max

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

fun <T : Comparable<T>> Iterable<T>.max(): T?
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

maxBy

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

fun <T, R : Comparable<R>> Iterable<T>.maxBy(
    selector: (T) -> R
): T?
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

maxWith

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

fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): T?
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

min

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

fun <T : Comparable<T>> Iterable<T>.min(): T?
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

minBy

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

fun <T, R : Comparable<R>> Iterable<T>.minBy(
    selector: (T) -> R
): T?
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

minus

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

operator fun <T> Iterable<T>.minus(element: 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: Array<out 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: Iterable<T>
): List<T>

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

operator fun <T> Iterable<T>.minus(
    elements: Sequence<T>
): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

minusElement

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

fun <T> Iterable<T>.minusElement(element: T): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

minWith

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

fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): T?
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

none

Returns true if the collection has no elements.

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

Returns true if no elements match the given predicate.

fun <T> Iterable<T>.none(predicate: (T) -> Boolean): Boolean
Platform and version requirements: JVM (1.1), JS (1.1), Native (1.1)

onEach

Performs the given action on each element and returns the collection itself afterwards.

fun <T, C : Iterable<T>> C.onEach(action: (T) -> Unit): C
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

partition

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.

fun <T> Iterable<T>.partition(
    predicate: (T) -> Boolean
): Pair<List<T>, List<T>>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

plus

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

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

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

operator fun <T> Iterable<T>.plus(
    elements: Sequence<T>
): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

plusElement

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

fun <T> Iterable<T>.plusElement(element: T): List<T>
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

random

Returns a random element from this range.

fun ULongRange.random(): ULong

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

fun ULongRange.random(random: Random): ULong
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

reduce

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

fun <S, T : S> Iterable<T>.reduce(
    operation: (acc: S, T) -> S
): S
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

reduceIndexed

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.

fun <S, T : S> Iterable<T>.reduceIndexed(
    operation: (index: Int, acc: S, T) -> S
): S
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

requireNoNulls

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

fun <T : Any> Iterable<T?>.requireNoNulls(): Iterable<T>
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

shuffled

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

fun <T> Iterable<T>.shuffled(random: Random): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

single

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

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

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

fun <T> Iterable<T>.single(predicate: (T) -> Boolean): T
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

singleOrNull

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

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

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

fun <T> Iterable<T>.singleOrNull(
    predicate: (T) -> Boolean
): T?
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

sorted

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

fun <T : Comparable<T>> Iterable<T>.sorted(): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

sortedBy

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

fun <T, R : Comparable<R>> Iterable<T>.sortedBy(
    selector: (T) -> R?
): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

sortedByDescending

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

fun <T, R : Comparable<R>> Iterable<T>.sortedByDescending(
    selector: (T) -> R?
): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

sortedDescending

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

fun <T : Comparable<T>> Iterable<T>.sortedDescending(): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

sortedWith

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

fun <T> Iterable<T>.sortedWith(
    comparator: Comparator<in T>
): List<T>
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

step

Returns a progression that goes over the same range with the given step.

infix fun ULongProgression.step(step: Long): ULongProgression
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

subtract

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

infix fun <T> Iterable<T>.subtract(
    other: Iterable<T>
): Set<T>
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

sum

Returns the sum of all elements in the collection.

fun Iterable<ULong>.sum(): ULong
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

sumBy

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

fun <T> Iterable<T>.sumBy(selector: (T) -> Int): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

sumByDouble

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

fun <T> Iterable<T>.sumByDouble(
    selector: (T) -> Double
): Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

take

Returns a list containing first n elements.

fun <T> Iterable<T>.take(n: Int): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

takeWhile

Returns a list containing first elements satisfying the given predicate.

fun <T> Iterable<T>.takeWhile(
    predicate: (T) -> Boolean
): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toCollection

Appends all elements to the given destination collection.

fun <T, C : MutableCollection<in T>> Iterable<T>.toCollection(
    destination: C
): C
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toHashSet

Returns a HashSet of all elements.

fun <T> Iterable<T>.toHashSet(): HashSet<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toList

Returns a List containing all elements.

fun <T> Iterable<T>.toList(): List<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toMutableList

Returns a MutableList filled with all elements of this collection.

fun <T> Iterable<T>.toMutableList(): MutableList<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toMutableSet

Returns a mutable set containing all distinct elements from the given collection.

fun <T> Iterable<T>.toMutableSet(): MutableSet<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toSet

Returns a Set of all elements.

fun <T> Iterable<T>.toSet(): Set<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

union

Returns a set containing all distinct elements from both collections.

infix fun <T> Iterable<T>.union(other: Iterable<T>): Set<T>
Platform and version requirements: JVM (1.2), JS (1.2), Native (1.2)

windowed

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> Iterable<T>.windowed(
    size: Int, 
    step: Int = 1, 
    partialWindows: Boolean = false
): List<List<T>>

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.

fun <T, R> Iterable<T>.windowed(
    size: Int, 
    step: Int = 1, 
    partialWindows: Boolean = false, 
    transform: (List<T>) -> R
): List<R>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

withIndex

Returns a lazy Iterable of IndexedValue for each element of the original collection.

fun <T> Iterable<T>.withIndex(): Iterable<IndexedValue<T>>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

zip

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.

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

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.

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

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.

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

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.

fun <T, R, V> Iterable<T>.zip(
    other: Iterable<R>, 
    transform: (a: T, b: R) -> V
): List<V>
Platform and version requirements: JVM (1.2), JS (1.2), Native (1.2)

zipWithNext

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

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

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

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

© 2010–2019 JetBrains s.r.o.
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-u-long-range/index.html