Returns an array of type ByteArray, which is a view of this array where each element is a signed reinterpretation of the corresponding element of this array.

asIterable

inline fun <T> Iterable<T>.asIterable(): Iterable<T>

Returns this collection as an Iterable.

asList

@ExperimentalUnsignedTypes

expect fun UByteArray.asList(): List<UByte>

Returns a List that wraps the original array.

@ExperimentalUnsignedTypes

actual fun UByteArray.asList(): List<UByte>

Returns a List that wraps the original array.

@ExperimentalUnsignedTypes

actual fun UByteArray.asList(): List<UByte>

Returns a List that wraps the original array.

@ExperimentalUnsignedTypes

actual fun UByteArray.asList(): List<UByte>

Returns a List that wraps the original array.

asSequence

fun <T> Iterable<T>.asSequence(): Sequence<T>

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

associate

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.

associateBy

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>

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

associateByTo

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

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.

associateTo

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.

associateWith

@ExperimentalUnsignedTypes

inline fun <V> UByteArray.associateWith(valueSelector: (UByte) -> V): Map<UByte, V>

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

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.

associateWithTo

@ExperimentalUnsignedTypes

inline fun <V, M : MutableMap<in UByte, in V>> UByteArray.associateWithTo(destination: M, valueSelector: (UByte) -> V): M

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

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.

average

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

binarySearch

@ExperimentalUnsignedTypes

fun UByteArray.binarySearch( element: UByte, fromIndex: Int = 0, toIndex: Int = size): Int

Searches the array or the range of the array for the provided element using the binary search algorithm. The array is expected to be sorted, otherwise the result is undefined.

chunked

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>

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

component1

@ExperimentalUnsignedTypes

inline operator fun UByteArray.component1(): UByte

Returns 1st element from the array.

component2

@ExperimentalUnsignedTypes

inline operator fun UByteArray.component2(): UByte

Returns 2nd element from the array.

component3

@ExperimentalUnsignedTypes

inline operator fun UByteArray.component3(): UByte

Returns 3rd element from the array.

component4

@ExperimentalUnsignedTypes

inline operator fun UByteArray.component4(): UByte

Returns 4th element from the array.

component5

@ExperimentalUnsignedTypes

inline operator fun UByteArray.component5(): UByte

Returns 5th element from the array.

contains

operator fun <T> Iterable<T>.contains(element: T): Boolean

Returns true if element is found in the collection.

containsAll

inline fun <T> Collection<T>.containsAll(elements: Collection<T>): Boolean

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

contentEquals

@ExperimentalUnsignedTypes

infix fun UByteArray.~~contentEquals~~(other: UByteArray): Boolean

@ExperimentalUnsignedTypes

infix fun UByteArray?.contentEquals(other: UByteArray?): Boolean

Returns true if the two specified arrays are structurally equal to one another, i.e. contain the same number of the same elements in the same order.

contentHashCode

@ExperimentalUnsignedTypes

fun UByteArray.~~contentHashCode~~(): Int

@ExperimentalUnsignedTypes

fun UByteArray?.contentHashCode(): Int

Returns a hash code based on the contents of this array as if it is List.

contentToString

@ExperimentalUnsignedTypes

fun UByteArray.~~contentToString~~(): String

@ExperimentalUnsignedTypes

fun UByteArray?.contentToString(): String

Returns a string representation of the contents of the specified array as if it is List.

copyInto

@ExperimentalUnsignedTypes

inline fun UByteArray.copyInto( destination: UByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = size): UByteArray

Copies this array or its subrange into the destination array and returns that array.

copyOf

@ExperimentalUnsignedTypes

inline fun UByteArray.copyOf(): UByteArray

Returns new array which is a copy of the original array.

@ExperimentalUnsignedTypes

inline fun UByteArray.copyOf(newSize: Int): UByteArray

Returns new array which is a copy of the original array, resized to the given newSize. The copy is either truncated or padded at the end with zero values if necessary.

copyOfRange

@ExperimentalUnsignedTypes

inline fun UByteArray.copyOfRange(fromIndex: Int, toIndex: Int): UByteArray

Returns a new array which is a copy of the specified range of the original array.

count

@ExperimentalUnsignedTypes

inline fun UByteArray.count(predicate: (UByte) -> Boolean): Int

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

Returns the number of elements matching the given predicate.

inline fun <T> Collection<T>.count(): Int

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

Returns the number of elements in this collection.

distinct

fun <T> Iterable<T>.distinct(): List<T>

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

distinctBy

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.

drop

@ExperimentalUnsignedTypes

fun UByteArray.drop(n: Int): List<UByte>

fun <T> Iterable<T>.drop(n: Int): List<T>

Returns a list containing all elements except first n elements.

dropLast

@ExperimentalUnsignedTypes

fun UByteArray.dropLast(n: Int): List<UByte>

Returns a list containing all elements except last n elements.

dropLastWhile

@ExperimentalUnsignedTypes

inline fun UByteArray.dropLastWhile(predicate: (UByte) -> Boolean): List<UByte>

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

dropWhile

@ExperimentalUnsignedTypes

inline fun UByteArray.dropWhile(predicate: (UByte) -> Boolean): List<UByte>

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.

elementAt

@ExperimentalUnsignedTypes

expect fun UByteArray.elementAt(index: Int): UByte

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

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.

@ExperimentalUnsignedTypes

actual inline fun UByteArray.elementAt(index: Int): UByte

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

@ExperimentalUnsignedTypes

actual fun UByteArray.elementAt(index: Int): UByte

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

@ExperimentalUnsignedTypes

actual inline fun UByteArray.elementAt(index: Int): UByte

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

elementAtOrElse

@ExperimentalUnsignedTypes

inline fun UByteArray.elementAtOrElse(index: Int, defaultValue: (Int) -> UByte): UByte

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

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.

elementAtOrNull

@ExperimentalUnsignedTypes

inline fun UByteArray.elementAtOrNull(index: Int): UByte?

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

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.

fill

@ExperimentalUnsignedTypes

fun UByteArray.fill( element: UByte, fromIndex: Int = 0, toIndex: Int = size)

Fills this array or its subrange with the specified element value.

filter

@ExperimentalUnsignedTypes

inline fun UByteArray.filter(predicate: (UByte) -> Boolean): List<UByte>

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

Returns a list containing only elements matching the given predicate.

filterIndexed

@ExperimentalUnsignedTypes

inline fun UByteArray.filterIndexed(predicate: (index: Int, UByte) -> Boolean): List<UByte>

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

Returns a list containing only elements matching the given predicate.

filterIndexedTo

@ExperimentalUnsignedTypes

inline fun <C : MutableCollection<in UByte>> UByteArray.filterIndexedTo(destination: C, predicate: (index: Int, UByte) -> 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.

filterIsInstance

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>

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

filterIsInstanceTo

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

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

filterNot

@ExperimentalUnsignedTypes

inline fun UByteArray.filterNot(predicate: (UByte) -> Boolean): List<UByte>

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

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

filterNotNull

fun <T : Any> Iterable<T?>.filterNotNull(): List<T>

Returns a list containing all elements that are not null.

filterNotNullTo

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

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

filterNotTo

@ExperimentalUnsignedTypes

inline fun <C : MutableCollection<in UByte>> UByteArray.filterNotTo(destination: C, predicate: (UByte) -> 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.

filterTo

@ExperimentalUnsignedTypes

inline fun <C : MutableCollection<in UByte>> UByteArray.filterTo(destination: C, predicate: (UByte) -> 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.

find

@ExperimentalUnsignedTypes

inline fun UByteArray.find(predicate: (UByte) -> Boolean): UByte?

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.

findLast

@ExperimentalUnsignedTypes

inline fun UByteArray.findLast(predicate: (UByte) -> Boolean): UByte?

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.

first

@ExperimentalUnsignedTypes

inline fun UByteArray.first(): UByte

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

Returns first element.

@ExperimentalUnsignedTypes

inline fun UByteArray.first(predicate: (UByte) -> Boolean): UByte

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

Returns the first element matching the given predicate.

firstNotNullOf

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.

firstNotNullOfOrNull

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.

firstOrNull

@ExperimentalUnsignedTypes

fun UByteArray.firstOrNull(): UByte?

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

@ExperimentalUnsignedTypes

inline fun UByteArray.firstOrNull(predicate: (UByte) -> Boolean): UByte?

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.

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

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

flatMap

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.flatMap(transform: (UByte) -> Iterable<R>): List<R>

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

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.

flatMapIndexed

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.flatMapIndexed(transform: (index: Int, UByte) -> Iterable<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 array.

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

flatMapIndexedTo

@ExperimentalUnsignedTypes

inline fun <R, C : MutableCollection<in R>> UByteArray.flatMapIndexedTo(destination: C, transform: (index: Int, UByte) -> Iterable<R>): C

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

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

flatMapTo

@ExperimentalUnsignedTypes

inline fun <R, C : MutableCollection<in R>> UByteArray.flatMapTo(destination: C, transform: (UByte) -> Iterable<R>): C

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

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.

flatten

fun <T> Iterable<Iterable<T>>.flatten(): List<T>

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

fold

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.fold(initial: R, operation: (acc: R, UByte) -> 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.

foldIndexed

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.foldIndexed(initial: R, operation: (index: Int, acc: R, UByte) -> 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 array.

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.

foldRight

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.foldRight(initial: R, operation: (UByte, acc: R) -> R): R

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

foldRightIndexed

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.foldRightIndexed(initial: R, operation: (index: Int, UByte, acc: R) -> R): R

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

forEach

@ExperimentalUnsignedTypes

inline fun UByteArray.forEach(action: (UByte) -> Unit)

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

Performs the given action on each element.

forEachIndexed

@ExperimentalUnsignedTypes

inline fun UByteArray.forEachIndexed(action: (index: Int, UByte) -> 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.

getOrElse

@ExperimentalUnsignedTypes

inline fun UByteArray.getOrElse(index: Int, defaultValue: (Int) -> UByte): UByte

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

getOrNull

@ExperimentalUnsignedTypes

fun UByteArray.getOrNull(index: Int): UByte?

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

groupBy

@ExperimentalUnsignedTypes

inline fun <K> UByteArray.groupBy(keySelector: (UByte) -> K): Map<K, List<UByte>>

Groups elements of the original array 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.

@ExperimentalUnsignedTypes

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

Groups values returned by the valueTransform function applied to each element of the original array 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.

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

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.

groupByTo

@ExperimentalUnsignedTypes

inline fun <K, M : MutableMap<in K, MutableList<UByte>>> UByteArray.groupByTo(destination: M, keySelector: (UByte) -> K): M

Groups elements of the original array 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.

@ExperimentalUnsignedTypes

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

Groups values returned by the valueTransform function applied to each element of the original array 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.

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

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.

groupingBy

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.

indexOf

@ExperimentalUnsignedTypes

inline fun UByteArray.indexOf(element: UByte): Int

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

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

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

indexOfFirst

@ExperimentalUnsignedTypes

inline fun UByteArray.indexOfFirst(predicate: (UByte) -> Boolean): Int

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

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.

indexOfLast

@ExperimentalUnsignedTypes

inline fun UByteArray.indexOfLast(predicate: (UByte) -> Boolean): Int

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

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.

indices

@ExperimentalUnsignedTypes

val UByteArray.indices: IntRange

Returns the range of valid indices for the array.

val Collection<*>.indices: IntRange

Returns an IntRange of the valid indices for this collection.

intersect

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.

isNotEmpty

inline fun <T> Collection<T>.isNotEmpty(): Boolean

Returns true if the collection is not empty.

isNullOrEmpty

inline fun <T> Collection<T>?.isNullOrEmpty(): Boolean

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

joinTo

fun <T, A : Appendable> Iterable<T>.joinTo( buffer: A, separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: (T) -> CharSequence? = null): A

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

joinToString

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.

last

@ExperimentalUnsignedTypes

inline fun UByteArray.last(): UByte

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

Returns the last element.

@ExperimentalUnsignedTypes

inline fun UByteArray.last(predicate: (UByte) -> Boolean): UByte

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

Returns the last element matching the given predicate.

lastIndex

@ExperimentalUnsignedTypes

val UByteArray.lastIndex: Int

Returns the last valid index for the array.

lastIndexOf

@ExperimentalUnsignedTypes

inline fun UByteArray.lastIndexOf(element: UByte): Int

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

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

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

lastOrNull

@ExperimentalUnsignedTypes

fun UByteArray.lastOrNull(): UByte?

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

@ExperimentalUnsignedTypes

inline fun UByteArray.lastOrNull(predicate: (UByte) -> Boolean): UByte?

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.

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

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

map

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.map(transform: (UByte) -> R): List<R>

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

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.

mapIndexed

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.mapIndexed(transform: (index: Int, UByte) -> R): List<R>

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

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.

mapIndexedNotNull

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.

mapIndexedNotNullTo

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.

mapIndexedTo

@ExperimentalUnsignedTypes

inline fun <R, C : MutableCollection<in R>> UByteArray.mapIndexedTo(destination: C, transform: (index: Int, UByte) -> R): C

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

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.

mapNotNull

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.

mapNotNullTo

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.

mapTo

@ExperimentalUnsignedTypes

inline fun <R, C : MutableCollection<in R>> UByteArray.mapTo(destination: C, transform: (UByte) -> R): C

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

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.

max

@ExperimentalUnsignedTypes

fun UByteArray.~~max~~(): UByte?

fun Iterable<Double>.~~max~~(): Double?

fun Iterable<Float>.~~max~~(): Float?

fun <T : Comparable<T>> Iterable<T>.~~max~~(): T?

maxBy

@ExperimentalUnsignedTypes

inline fun <R : Comparable<R>> UByteArray.~~maxBy~~(selector: (UByte) -> R): UByte?

inline fun <T, R : Comparable<R>> Iterable<T>.~~maxBy~~(selector: (T) -> R): T?

maxByOrNull

@ExperimentalUnsignedTypes

inline fun <R : Comparable<R>> UByteArray.maxByOrNull(selector: (UByte) -> R): UByte?

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.

maxOf

@ExperimentalUnsignedTypes

inline fun UByteArray.maxOf(selector: (UByte) -> Double): Double

@ExperimentalUnsignedTypes

inline fun UByteArray.maxOf(selector: (UByte) -> Float): Float

@ExperimentalUnsignedTypes

inline fun <R : Comparable<R>> UByteArray.maxOf(selector: (UByte) -> R): R

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

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.

maxOfOrNull

@ExperimentalUnsignedTypes

inline fun UByteArray.maxOfOrNull(selector: (UByte) -> Double): Double?

@ExperimentalUnsignedTypes

inline fun UByteArray.maxOfOrNull(selector: (UByte) -> Float): Float?

@ExperimentalUnsignedTypes

inline fun <R : Comparable<R>> UByteArray.maxOfOrNull(selector: (UByte) -> R): R?

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

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.

maxOfWith

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.maxOfWith(comparator: Comparator<in R>, selector: (UByte) -> R): R

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

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.

maxOfWithOrNull

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.maxOfWithOrNull(comparator: Comparator<in R>, selector: (UByte) -> R): R?

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

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.

maxOrNull

@ExperimentalUnsignedTypes

fun UByteArray.maxOrNull(): UByte?

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.

maxWith

@ExperimentalUnsignedTypes

fun UByteArray.~~maxWith~~(comparator: Comparator<in UByte>): UByte?

fun <T> Iterable<T>.~~maxWith~~(comparator: Comparator<in T>): T?

maxWithOrNull

@ExperimentalUnsignedTypes

fun UByteArray.maxWithOrNull(comparator: Comparator<in UByte>): UByte?

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.

min

@ExperimentalUnsignedTypes

fun UByteArray.~~min~~(): UByte?

fun Iterable<Double>.~~min~~(): Double?

fun Iterable<Float>.~~min~~(): Float?

fun <T : Comparable<T>> Iterable<T>.~~min~~(): T?

minBy

@ExperimentalUnsignedTypes

inline fun <R : Comparable<R>> UByteArray.~~minBy~~(selector: (UByte) -> R): UByte?

inline fun <T, R : Comparable<R>> Iterable<T>.~~minBy~~(selector: (T) -> R): T?

minByOrNull

@ExperimentalUnsignedTypes

inline fun <R : Comparable<R>> UByteArray.minByOrNull(selector: (UByte) -> R): UByte?

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.

minOf

@ExperimentalUnsignedTypes

inline fun UByteArray.minOf(selector: (UByte) -> Double): Double

@ExperimentalUnsignedTypes

inline fun UByteArray.minOf(selector: (UByte) -> Float): Float

@ExperimentalUnsignedTypes

inline fun <R : Comparable<R>> UByteArray.minOf(selector: (UByte) -> R): R

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

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.

minOfOrNull

@ExperimentalUnsignedTypes

inline fun UByteArray.minOfOrNull(selector: (UByte) -> Double): Double?

@ExperimentalUnsignedTypes

inline fun UByteArray.minOfOrNull(selector: (UByte) -> Float): Float?

@ExperimentalUnsignedTypes

inline fun <R : Comparable<R>> UByteArray.minOfOrNull(selector: (UByte) -> R): R?

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

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.

minOfWith

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.minOfWith(comparator: Comparator<in R>, selector: (UByte) -> R): R

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

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.

minOfWithOrNull

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.minOfWithOrNull(comparator: Comparator<in R>, selector: (UByte) -> R): R?

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

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.

minOrNull

@ExperimentalUnsignedTypes

fun UByteArray.minOrNull(): UByte?

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.

minus

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>

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>

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>

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

minusElement

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.

minWith

@ExperimentalUnsignedTypes

fun UByteArray.~~minWith~~(comparator: Comparator<in UByte>): UByte?

fun <T> Iterable<T>.~~minWith~~(comparator: Comparator<in T>): T?

minWithOrNull

@ExperimentalUnsignedTypes

fun UByteArray.minWithOrNull(comparator: Comparator<in UByte>): UByte?

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.

none

@ExperimentalUnsignedTypes

inline fun UByteArray.none(): Boolean

Returns true if the array has no elements.

@ExperimentalUnsignedTypes

inline fun UByteArray.none(predicate: (UByte) -> Boolean): Boolean

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

Returns true if no elements match the given predicate.

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

Returns true if the collection has no elements.

onEach

@ExperimentalUnsignedTypes

inline fun UByteArray.onEach(action: (UByte) -> Unit): UByteArray

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

onEachIndexed

@ExperimentalUnsignedTypes

inline fun UByteArray.onEachIndexed(action: (index: Int, UByte) -> Unit): UByteArray

Performs the given action on each element, providing sequential index with the element, and returns the array itself afterwards.

orEmpty

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

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

partition

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.

plus

@ExperimentalUnsignedTypes

inline operator fun UByteArray.plus(element: UByte): UByteArray

Returns an array containing all elements of the original array and then the given element.

@ExperimentalUnsignedTypes

operator fun UByteArray.plus(elements: Collection<UByte>): UByteArray

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

@ExperimentalUnsignedTypes

inline operator fun UByteArray.plus(elements: UByteArray): UByteArray

Returns an array containing all elements of the original array and then all elements of the given elements array.

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>

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>

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>

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

plusElement

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.

random

@ExperimentalUnsignedTypes

inline fun UByteArray.random(): UByte

Returns a random element from this array.

@ExperimentalUnsignedTypes

fun UByteArray.random(random: Random): UByte

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

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

Returns a random element from this collection.

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

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

randomOrNull

@ExperimentalUnsignedTypes

inline fun UByteArray.randomOrNull(): UByte?

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

@ExperimentalUnsignedTypes

fun UByteArray.randomOrNull(random: Random): UByte?

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

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?

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

reduce

@ExperimentalUnsignedTypes

inline fun UByteArray.reduce(operation: (acc: UByte, UByte) -> UByte): UByte

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.

reduceIndexed

@ExperimentalUnsignedTypes

inline fun UByteArray.reduceIndexed(operation: (index: Int, acc: UByte, UByte) -> UByte): UByte

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

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.

reduceIndexedOrNull

@ExperimentalUnsignedTypes

inline fun UByteArray.reduceIndexedOrNull(operation: (index: Int, acc: UByte, UByte) -> UByte): UByte?

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

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.

reduceOrNull

@ExperimentalUnsignedTypes

inline fun UByteArray.reduceOrNull(operation: (acc: UByte, UByte) -> UByte): UByte?

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.

reduceRight

@ExperimentalUnsignedTypes

inline fun UByteArray.reduceRight(operation: (UByte, acc: UByte) -> UByte): UByte

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

reduceRightIndexed

@ExperimentalUnsignedTypes

inline fun UByteArray.reduceRightIndexed(operation: (index: Int, UByte, acc: UByte) -> UByte): UByte

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

reduceRightIndexedOrNull

@ExperimentalUnsignedTypes

inline fun UByteArray.reduceRightIndexedOrNull(operation: (index: Int, UByte, acc: UByte) -> UByte): UByte?

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

reduceRightOrNull

@ExperimentalUnsignedTypes

inline fun UByteArray.reduceRightOrNull(operation: (UByte, acc: UByte) -> UByte): UByte?

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

refTo

fun UByteArray.refTo(index: Int): CValuesRef<UByteVar>

requireNoNulls

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.

reverse

@ExperimentalUnsignedTypes

inline fun UByteArray.reverse()

Reverses elements in the array in-place.

@ExperimentalUnsignedTypes

inline fun UByteArray.reverse(fromIndex: Int, toIndex: Int)

Reverses elements of the array in the specified range in-place.

reversed

@ExperimentalUnsignedTypes

fun UByteArray.reversed(): List<UByte>

fun <T> Iterable<T>.reversed(): List<T>

Returns a list with elements in reversed order.

reversedArray

@ExperimentalUnsignedTypes

inline fun UByteArray.reversedArray(): UByteArray

Returns an array with elements of this array in reversed order.

runningFold

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.runningFold(initial: R, operation: (acc: R, UByte) -> 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.

runningFoldIndexed

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.runningFoldIndexed(initial: R, operation: (index: Int, acc: R, UByte) -> 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 array and current accumulator value that starts with initial value.

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.

runningReduce

@ExperimentalUnsignedTypes

inline fun UByteArray.runningReduce(operation: (acc: UByte, UByte) -> UByte): List<UByte>

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

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

runningReduceIndexed

@ExperimentalUnsignedTypes

inline fun UByteArray.runningReduceIndexed(operation: (index: Int, acc: UByte, UByte) -> UByte): List<UByte>

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

scan

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.scan(initial: R, operation: (acc: R, UByte) -> 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.

scanIndexed

@ExperimentalUnsignedTypes

inline fun <R> UByteArray.scanIndexed(initial: R, operation: (index: Int, acc: R, UByte) -> R): List<R>

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

shuffle

@ExperimentalUnsignedTypes

fun UByteArray.shuffle()

Randomly shuffles elements in this array in-place.

@ExperimentalUnsignedTypes

fun UByteArray.shuffle(random: Random)

Randomly shuffles elements in this array in-place using the specified random instance as the source of randomness.

shuffled

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>

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>

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

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>

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

single

@ExperimentalUnsignedTypes

inline fun UByteArray.single(): UByte

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

@ExperimentalUnsignedTypes

inline fun UByteArray.single(predicate: (UByte) -> Boolean): UByte

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.

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.

singleOrNull

@ExperimentalUnsignedTypes

fun UByteArray.singleOrNull(): UByte?

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

@ExperimentalUnsignedTypes

inline fun UByteArray.singleOrNull(predicate: (UByte) -> Boolean): UByte?

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.

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

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

slice

@ExperimentalUnsignedTypes

fun UByteArray.slice(indices: IntRange): List<UByte>

Returns a list containing elements at indices in the specified indices range.

@ExperimentalUnsignedTypes

fun UByteArray.slice(indices: Iterable<Int>): List<UByte>

Returns a list containing elements at specified indices.

sliceArray

@ExperimentalUnsignedTypes

fun UByteArray.sliceArray(indices: Collection<Int>): UByteArray

Returns an array containing elements of this array at specified indices.

@ExperimentalUnsignedTypes

fun UByteArray.sliceArray(indices: IntRange): UByteArray

Returns an array containing elements at indices in the specified indices range.

sort

@ExperimentalUnsignedTypes

fun UByteArray.sort()

Sorts the array in-place.

@ExperimentalUnsignedTypes

fun UByteArray.sort(fromIndex: Int = 0, toIndex: Int = size)

Sorts a range in the array in-place.

sortDescending

@ExperimentalUnsignedTypes

fun UByteArray.sortDescending()

Sorts elements in the array in-place descending according to their natural sort order.

@ExperimentalUnsignedTypes

fun UByteArray.sortDescending(fromIndex: Int, toIndex: Int)

Sorts elements of the array in the specified range in-place. The elements are sorted descending according to their natural sort order.

sorted

@ExperimentalUnsignedTypes

fun UByteArray.sorted(): List<UByte>

fun <T : Comparable<T>> Iterable<T>.sorted(): List<T>

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

sortedArray

@ExperimentalUnsignedTypes

fun UByteArray.sortedArray(): UByteArray

Returns an array with all elements of this array sorted according to their natural sort order.

sortedArrayDescending

@ExperimentalUnsignedTypes

fun UByteArray.sortedArrayDescending(): UByteArray

Returns an array with all elements of this array sorted descending according to their natural sort order.

sortedBy

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.

sortedByDescending

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.

sortedDescending

@ExperimentalUnsignedTypes

fun UByteArray.sortedDescending(): List<UByte>

fun <T : Comparable<T>> Iterable<T>.sortedDescending(): List<T>

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

sortedWith

fun <T> Iterable<T>.sortedWith(comparator: Comparator<in T>): List<T>

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

subtract

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.

sum

@ExperimentalUnsignedTypes

inline fun UByteArray.sum(): UInt

Returns the sum of all elements in the array.

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

sumBy

@ExperimentalUnsignedTypes

inline fun UByteArray.~~sumBy~~(selector: (UByte) -> UInt): UInt

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

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.

sumByDouble

@ExperimentalUnsignedTypes

inline fun UByteArray.~~sumByDouble~~(selector: (UByte) -> Double): Double

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

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.

sumOf

@JvmName(name = "sumOfDouble")

@ExperimentalUnsignedTypes

inline fun UByteArray.sumOf(selector: (UByte) -> Double): Double

@JvmName(name = "sumOfInt")

@ExperimentalUnsignedTypes

inline fun UByteArray.sumOf(selector: (UByte) -> Int): Int

@JvmName(name = "sumOfLong")

@ExperimentalUnsignedTypes

inline fun UByteArray.sumOf(selector: (UByte) -> Long): Long

@JvmName(name = "sumOfUInt")

@ExperimentalUnsignedTypes

inline fun UByteArray.sumOf(selector: (UByte) -> UInt): UInt

@JvmName(name = "sumOfULong")

@ExperimentalUnsignedTypes

inline fun UByteArray.sumOf(selector: (UByte) -> ULong): ULong

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

@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")

@ExperimentalUnsignedTypes

inline fun UByteArray.sumOf(selector: (UByte) -> BigDecimal): BigDecimal

@JvmName(name = "sumOfBigInteger")

@ExperimentalUnsignedTypes

inline fun UByteArray.sumOf(selector: (UByte) -> BigInteger): BigInteger

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

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

take

@ExperimentalUnsignedTypes

fun UByteArray.take(n: Int): List<UByte>

fun <T> Iterable<T>.take(n: Int): List<T>

Returns a list containing first n elements.

takeLast

@ExperimentalUnsignedTypes

fun UByteArray.takeLast(n: Int): List<UByte>

Returns a list containing last n elements.

takeLastWhile

@ExperimentalUnsignedTypes

inline fun UByteArray.takeLastWhile(predicate: (UByte) -> Boolean): List<UByte>

Returns a list containing last elements satisfying the given predicate.

takeWhile

@ExperimentalUnsignedTypes

inline fun UByteArray.takeWhile(predicate: (UByte) -> Boolean): List<UByte>

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

Returns a list containing first elements satisfying the given predicate.

toBooleanArray

fun Collection<Boolean>.toBooleanArray(): BooleanArray

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

toByteArray

@ExperimentalUnsignedTypes

inline fun UByteArray.toByteArray(): ByteArray

Returns an array of type ByteArray, which is a copy of this array where each element is a signed reinterpretation of the corresponding element of this array.

fun Collection<Byte>.toByteArray(): ByteArray

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

toCharArray

fun Collection<Char>.toCharArray(): CharArray

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

toCollection

fun <T, C : MutableCollection<in T>> Iterable<T>.toCollection(destination: C): C

Appends all elements to the given destination collection.

toCValues

fun UByteArray.toCValues(): CValues<UByteVar>

toDoubleArray

fun Collection<Double>.toDoubleArray(): DoubleArray

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

toFloatArray

fun Collection<Float>.toFloatArray(): FloatArray

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

toHashSet

fun <T> Iterable<T>.toHashSet(): HashSet<T>

Returns a new HashSet of all elements.

toIntArray

fun Collection<Int>.toIntArray(): IntArray

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

toList

fun <T> Iterable<T>.toList(): List<T>

Returns a List containing all elements.

toLongArray

fun Collection<Long>.toLongArray(): LongArray

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

toMap

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

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

toMutableList

fun <T> Collection<T>.toMutableList(): MutableList<T>

fun <T> Iterable<T>.toMutableList(): MutableList<T>

Returns a new MutableList filled with all elements of this collection.

toMutableSet

fun <T> Iterable<T>.toMutableSet(): MutableSet<T>

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

toSet

fun <T> Iterable<T>.toSet(): Set<T>

Returns a Set of all elements.

toShortArray

fun Collection<Short>.toShortArray(): ShortArray

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

toSortedSet

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.

toTypedArray

@ExperimentalUnsignedTypes

fun UByteArray.toTypedArray(): Array<UByte>

Returns a typed object array containing all of the elements of this primitive array.

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

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

toUByteArray

@ExperimentalUnsignedTypes

fun Collection<UByte>.toUByteArray(): UByteArray

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

toUIntArray

@ExperimentalUnsignedTypes

fun Collection<UInt>.toUIntArray(): UIntArray

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

toULongArray

@ExperimentalUnsignedTypes

fun Collection<ULong>.toULongArray(): ULongArray

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

toUShortArray

@ExperimentalUnsignedTypes

fun Collection<UShort>.toUShortArray(): UShortArray

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

union

infix fun <T> Iterable<T>.union(other: Iterable<T>): Set<T>

Returns a set containing all distinct elements from both collections.

unzip

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.

waitForMultipleFutures

fun <T> Collection<Future<T>>.~~waitForMultipleFutures~~(millis: Int): Set<Future<T>>

windowed

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>

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.

withIndex

@ExperimentalUnsignedTypes

fun UByteArray.withIndex(): Iterable<IndexedValue<UByte>>

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

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.

zip

@ExperimentalUnsignedTypes

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

@ExperimentalUnsignedTypes

infix fun UByteArray.zip(other: UByteArray): List<Pair<UByte, UByte>>

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

@ExperimentalUnsignedTypes

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

Returns a list of values built from the elements of this array 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.

@ExperimentalUnsignedTypes

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

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

@ExperimentalUnsignedTypes

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

Returns a list of values built from the elements of this array 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.

@ExperimentalUnsignedTypes

inline fun <V> UByteArray.zip(other: UByteArray, transform: (a: UByte, b: UByte) -> V): List<V>

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>

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

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>

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.

zipWithNext

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>

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