UByteArray

Common
JVM
JS
Native
1.3
inline class UByteArray : Collection<UByte>

Constructors

Common
JVM
JS
Native
1.0

<init>

Creates a new array of the specified size, with all elements initialized to zero.

UByteArray(size: Int)

Properties

Common
JVM
JS
Native
1.0

size

Returns the number of elements in the array.

val size: Int

Functions

Common
JVM
JS
Native
1.0

contains

Checks if the specified element is contained in this collection.

fun contains(element: UByte): Boolean
Common
JVM
JS
Native
1.0

containsAll

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

fun containsAll(elements: Collection<UByte>): Boolean
Common
JVM
JS
Native
1.0

get

Returns the array element at the given index. This method can be called using the index operator.

operator fun get(index: Int): UByte
Common
JVM
JS
Native
1.0

isEmpty

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

fun isEmpty(): Boolean
Common
JVM
JS
Native
1.0

iterator

Creates an iterator over the elements of the array.

operator fun iterator(): UByteIterator
Common
JVM
JS
Native
1.0

set

Sets the element at the given index to the given value. This method can be called using the index operator.

operator fun set(index: Int, value: UByte)

Extension Properties

Common
JVM
JS
Native
1.3

indices

Returns the range of valid indices for the array.

val UByteArray.indices: IntRange
Common
JVM
JS
Native
1.3

lastIndex

Returns the last valid index for the array.

val UByteArray.lastIndex: Int

Extension Functions

Common
JVM
JS
Native
1.0

all

Returns true if all elements match the given predicate.

fun UByteArray.all(predicate: (UByte) -> Boolean): Boolean
fun <T> Iterable<T>.all(predicate: (T) -> Boolean): Boolean
Common
JVM
JS
Native
1.0

any

Returns true if array has at least one element.

fun UByteArray.any(): Boolean

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

fun UByteArray.any(predicate: (UByte) -> Boolean): Boolean
fun <T> Iterable<T>.any(predicate: (T) -> Boolean): Boolean
Common
JVM
JS
Native
1.3

asByteArray

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.

fun UByteArray.asByteArray(): ByteArray
Common
JVM
JS
Native
1.0

asIterable

Returns this collection as an Iterable.

fun <T> Iterable<T>.asIterable(): Iterable<T>
Common
JVM
JS
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>
Common
JVM
JS
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>
Common
JVM
JS
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>
Common
JVM
JS
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
Common
JVM
JS
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
Common
JVM
JS
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>
Common
JVM
JS
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
JVM
1.3

binarySearch

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.

fun UByteArray.binarySearch(
    element: UByte,
    fromIndex: Int = 0,
    toIndex: Int = size
): Int
Common
JVM
JS
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>
Common
JVM
JS
Native
1.3

component1

Returns 1st element from the collection.

operator fun UByteArray.component1(): UByte
Common
JVM
JS
Native
1.3

component2

Returns 2nd element from the collection.

operator fun UByteArray.component2(): UByte
Common
JVM
JS
Native
1.3

component3

Returns 3rd element from the collection.

operator fun UByteArray.component3(): UByte
Common
JVM
JS
Native
1.3

component4

Returns 4th element from the collection.

operator fun UByteArray.component4(): UByte
Common
JVM
JS
Native
1.3

component5

Returns 5th element from the collection.

operator fun UByteArray.component5(): UByte
Common
JVM
JS
Native
1.0

contains

Returns true if element is found in the collection.

operator fun <T> Iterable<T>.contains(element: T): Boolean
Common
JVM
JS
Native
1.0

containsAll

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

fun <T> Collection<T>.containsAll(
    elements: Collection<T>
): Boolean
Common
JVM
JS
Native
1.3

contentEquals

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.

infix fun UByteArray.contentEquals(
    other: UByteArray
): Boolean
Common
JVM
JS
Native
1.3

contentHashCode

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

fun UByteArray.contentHashCode(): Int
Common
JVM
JS
Native
1.3

contentToString

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

fun UByteArray.contentToString(): String
Common
JVM
JS
Native
1.3

copyInto

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

fun UByteArray.copyInto(
    destination: UByteArray,
    destinationOffset: Int = 0,
    startIndex: Int = 0,
    endIndex: Int = size
): UByteArray
Common
JVM
JS
Native
1.3

copyOf

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

fun UByteArray.copyOf(): 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.

fun UByteArray.copyOf(newSize: Int): UByteArray
Common
JVM
JS
Native
1.3

copyOfRange

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

fun UByteArray.copyOfRange(
    fromIndex: Int,
    toIndex: Int
): UByteArray
Common
JVM
JS
Native
1.0

count

Returns the number of elements matching the given predicate.

fun UByteArray.count(predicate: (UByte) -> Boolean): Int
fun <T> Iterable<T>.count(predicate: (T) -> Boolean): Int
Common
JVM
JS
Native
1.0

distinct

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

fun <T> Iterable<T>.distinct(): List<T>
Common
JVM
JS
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>
Common
JVM
JS
Native
1.3

drop

Returns a list containing all elements except first n elements.

fun UByteArray.drop(n: Int): List<UByte>
Common
JVM
JS
Native
1.3

dropLast

Returns a list containing all elements except last n elements.

fun UByteArray.dropLast(n: Int): List<UByte>
Common
JVM
JS
Native
1.3

dropLastWhile

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

fun UByteArray.dropLastWhile(
    predicate: (UByte) -> Boolean
): List<UByte>
Common
JVM
JS
Native
1.0

dropWhile

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

fun UByteArray.dropWhile(
    predicate: (UByte) -> Boolean
): List<UByte>
fun <T> Iterable<T>.dropWhile(
    predicate: (T) -> Boolean
): List<T>
Common
JVM
JS
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 array.

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

fun <T> Iterable<T>.elementAtOrElse(
    index: Int,
    defaultValue: (Int) -> T
): T
Common
JVM
JS
Native
1.3

elementAtOrNull

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

fun UByteArray.elementAtOrNull(index: Int): UByte?
JVM
1.3

fill

Fills original array with the provided value.

fun UByteArray.fill(
    element: UByte,
    fromIndex: Int = 0,
    toIndex: Int = size)
Common
JVM
JS
Native
1.0

filter

Returns a list containing only elements matching the given predicate.

fun UByteArray.filter(
    predicate: (UByte) -> Boolean
): List<UByte>
fun <T> Iterable<T>.filter(
    predicate: (T) -> Boolean
): List<T>
Common
JVM
JS
Native
1.0

filterIndexed

Returns a list containing only elements matching the given predicate.

fun UByteArray.filterIndexed(
    predicate: (index: Int, UByte) -> Boolean
): List<UByte>
fun <T> Iterable<T>.filterIndexed(
    predicate: (index: Int, T) -> Boolean
): List<T>
Common
JVM
JS
Native
1.0

filterIndexedTo

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

fun <C : MutableCollection<in UByte>> UByteArray.filterIndexedTo(
    destination: C,
    predicate: (index: Int, UByte) -> Boolean
): C
fun <T, C : MutableCollection<in T>> Iterable<T>.filterIndexedTo(
    destination: C,
    predicate: (index: Int, T) -> Boolean
): C
Common
JVM
JS
Native
1.0

filterIsInstance

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

fun <R> Iterable<*>.filterIsInstance(): List<R>
Common
JVM
JS
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
Common
JVM
JS
Native
1.0

filterNot

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

fun UByteArray.filterNot(
    predicate: (UByte) -> Boolean
): List<UByte>
fun <T> Iterable<T>.filterNot(
    predicate: (T) -> Boolean
): List<T>
Common
JVM
JS
Native
1.0

filterNotNull

Returns a list containing all elements that are not null.

fun <T : Any> Iterable<T?>.filterNotNull(): List<T>
Common
JVM
JS
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
Common
JVM
JS
Native
1.0

filterNotTo

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

fun <C : MutableCollection<in UByte>> UByteArray.filterNotTo(
    destination: C,
    predicate: (UByte) -> Boolean
): C
fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo(
    destination: C,
    predicate: (T) -> Boolean
): C
Common
JVM
JS
Native
1.0

filterTo

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

fun <C : MutableCollection<in UByte>> UByteArray.filterTo(
    destination: C,
    predicate: (UByte) -> Boolean
): C
fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(
    destination: C,
    predicate: (T) -> Boolean
): C
Common
JVM
JS
Native
1.0

find

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

fun UByteArray.find(predicate: (UByte) -> Boolean): UByte?
fun <T> Iterable<T>.find(predicate: (T) -> Boolean): T?
Common
JVM
JS
Native
1.0

findLast

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

fun UByteArray.findLast(
    predicate: (UByte) -> Boolean
): UByte?
fun <T> Iterable<T>.findLast(predicate: (T) -> Boolean): T?
Common
JVM
JS
Native
1.0

first

Returns first element.

fun UByteArray.first(): UByte

Returns the first element matching the given predicate.

fun UByteArray.first(predicate: (UByte) -> Boolean): UByte
fun <T> Iterable<T>.first(predicate: (T) -> Boolean): T
Common
JVM
JS
Native
1.0

firstOrNull

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

fun UByteArray.firstOrNull(): UByte?

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

fun UByteArray.firstOrNull(
    predicate: (UByte) -> Boolean
): UByte?
fun <T> Iterable<T>.firstOrNull(
    predicate: (T) -> Boolean
): T?
Common
JVM
JS
Native
1.0

flatMap

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

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

fun <T, R> Iterable<T>.flatMap(
    transform: (T) -> Iterable<R>
): List<R>
Common
JVM
JS
Native
1.0

flatMapTo

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

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 collection, to the given destination.

fun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapTo(
    destination: C,
    transform: (T) -> Iterable<R>
): C
Common
JVM
JS
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 <R> UByteArray.fold(
    initial: R,
    operation: (acc: R, UByte) -> R
): R
fun <T, R> Iterable<T>.fold(
    initial: R,
    operation: (acc: R, T) -> R
): R
Common
JVM
JS
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 array.

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

fun <T, R> Iterable<T>.foldIndexed(
    initial: R,
    operation: (index: Int, acc: R, T) -> R
): R
Common
JVM
JS
Native
1.3

foldRight

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

fun <R> UByteArray.foldRight(
    initial: R,
    operation: (UByte, acc: R) -> R
): R
Common
JVM
JS
Native
1.3

foldRightIndexed

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.

fun <R> UByteArray.foldRightIndexed(
    initial: R,
    operation: (index: Int, UByte, acc: R) -> R
): R
Common
JVM
JS
Native
1.0

forEach

Performs the given action on each element.

fun UByteArray.forEach(action: (UByte) -> Unit)
fun <T> Iterable<T>.forEach(action: (T) -> Unit)
Common
JVM
JS
Native
1.0

forEachIndexed

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

fun UByteArray.forEachIndexed(
    action: (index: Int, UByte) -> Unit)
fun <T> Iterable<T>.forEachIndexed(
    action: (index: Int, T) -> Unit)
Common
JVM
JS
Native
1.3

getOrElse

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 UByteArray.getOrElse(
    index: Int,
    defaultValue: (Int) -> UByte
): UByte
Common
JVM
JS
Native
1.3

getOrNull

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

fun UByteArray.getOrNull(index: Int): UByte?
Common
JVM
JS
Native
1.0

groupBy

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.

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

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.

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

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>>
Common
JVM
JS
Native
1.0

groupByTo

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.

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

fun <K, V, M : MutableMap<in K, MutableList<V>>> UByteArray.groupByTo(
    destination: M,
    keySelector: (UByte) -> K,
    valueTransform: (UByte) -> V
): 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.

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
Common
JVM
JS
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>
Common
JVM
JS
Native
1.3

ifEmpty

Returns this array if it's not empty or the result of calling defaultValue function if the array is empty.

fun <C, R> C.ifEmpty(
    defaultValue: () -> R
): R where C : Array<*>, C : R
Common
JVM
JS
Native
1.0

indexOf

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

fun UByteArray.indexOf(element: UByte): Int

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

fun <T> Iterable<T>.indexOf(element: T): Int
Common
JVM
JS
Native
1.0

indexOfFirst

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

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

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
Common
JVM
JS
Native
1.0

indexOfLast

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

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

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
Common
JVM
JS
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>
Common
JVM
JS
Native
1.0

isNotEmpty

Returns true if the collection is not empty.

fun <T> Collection<T>.isNotEmpty(): Boolean
Common
JVM
JS
Native
1.3

isNullOrEmpty

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

fun <T> Collection<T>?.isNullOrEmpty(): Boolean
Common
JVM
JS
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
Common
JVM
JS
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
Common
JVM
JS
Native
1.0

last

Returns the last element.

fun UByteArray.last(): UByte

Returns the last element matching the given predicate.

fun UByteArray.last(predicate: (UByte) -> Boolean): UByte
fun <T> Iterable<T>.last(predicate: (T) -> Boolean): T
Common
JVM
JS
Native
1.0

lastIndexOf

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

fun UByteArray.lastIndexOf(element: UByte): Int

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

fun <T> Iterable<T>.lastIndexOf(element: T): Int
Common
JVM
JS
Native
1.0

lastOrNull

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

fun UByteArray.lastOrNull(): UByte?

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

fun UByteArray.lastOrNull(
    predicate: (UByte) -> Boolean
): UByte?
fun <T> Iterable<T>.lastOrNull(predicate: (T) -> Boolean): T?
Common
JVM
JS
Native
1.0

map

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

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

fun <T, R> Iterable<T>.map(transform: (T) -> R): List<R>
Common
JVM
JS
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 array.

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

fun <T, R> Iterable<T>.mapIndexed(
    transform: (index: Int, T) -> R
): List<R>
Common
JVM
JS
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>
Common
JVM
JS
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
Common
JVM
JS
Native
1.0

mapIndexedTo

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

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 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
Common
JVM
JS
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>
Common
JVM
JS
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
Common
JVM
JS
Native
1.0

mapTo

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

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 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
Common
JVM
JS
Native
1.3

max

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

fun UByteArray.max(): UByte?
Common
JVM
JS
Native
1.0

maxBy

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

fun <R : Comparable<R>> UByteArray.maxBy(
    selector: (UByte) -> R
): UByte?
fun <T, R : Comparable<R>> Iterable<T>.maxBy(
    selector: (T) -> R
): T?
Common
JVM
JS
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 UByteArray.maxWith(
    comparator: Comparator<in UByte>
): UByte?
fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): T?
Common
JVM
JS
Native
1.3

min

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

fun UByteArray.min(): UByte?
Common
JVM
JS
Native
1.0

minBy

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

fun <R : Comparable<R>> UByteArray.minBy(
    selector: (UByte) -> R
): UByte?
fun <T, R : Comparable<R>> Iterable<T>.minBy(
    selector: (T) -> R
): T?
Common
JVM
JS
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>
Common
JVM
JS
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>
Common
JVM
JS
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 UByteArray.minWith(
    comparator: Comparator<in UByte>
): UByte?
fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): T?
Common
JVM
JS
Native
1.0

none

Returns true if the array has no elements.

fun UByteArray.none(): Boolean

Returns true if no elements match the given predicate.

fun UByteArray.none(predicate: (UByte) -> Boolean): Boolean
fun <T> Iterable<T>.none(predicate: (T) -> Boolean): Boolean
Common
JVM
JS
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
Common
JVM
JS
Native
1.0

orEmpty

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

fun <T> Collection<T>?.orEmpty(): Collection<T>
Common
JVM
JS
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>>
Common
JVM
JS
Native
1.0

plus

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

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

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

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

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

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>
operator fun <T> Collection<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>
operator fun <T> Collection<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>
operator fun <T> Collection<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>
operator fun <T> Collection<T>.plus(
    elements: Sequence<T>
): List<T>
Common
JVM
JS
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>
fun <T> Collection<T>.plusElement(element: T): List<T>
Common
JVM
JS
Native
1.3

random

Returns a random element from this array.

fun UByteArray.random(): UByte

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

fun UByteArray.random(random: Random): UByte
Common
JVM
JS
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 UByteArray.reduce(
    operation: (acc: UByte, UByte) -> UByte
): UByte
fun <S, T : S> Iterable<T>.reduce(
    operation: (acc: S, T) -> S
): S
Common
JVM
JS
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 array.

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

fun <S, T : S> Iterable<T>.reduceIndexed(
    operation: (index: Int, acc: S, T) -> S
): S
Common
JVM
JS
Native
1.3

reduceRight

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

fun UByteArray.reduceRight(
    operation: (UByte, acc: UByte) -> UByte
): UByte
Common
JVM
JS
Native
1.3

reduceRightIndexed

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

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

refTo

fun UByteArray.refTo(index: Int): CValuesRef<UByteVar>
Common
JVM
JS
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>
Common
JVM
JS
Native
1.3

reverse

Reverses elements in the array in-place.

fun UByteArray.reverse()
Common
JVM
JS
Native
1.3

reversed

Returns a list with elements in reversed order.

fun UByteArray.reversed(): List<UByte>
Common
JVM
JS
Native
1.3

reversedArray

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

fun UByteArray.reversedArray(): UByteArray
Common
JVM
JS
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>
Common
JVM
JS
Native
1.0

single

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

fun UByteArray.single(): UByte

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

fun UByteArray.single(predicate: (UByte) -> Boolean): UByte
fun <T> Iterable<T>.single(predicate: (T) -> Boolean): T
Common
JVM
JS
Native
1.0

singleOrNull

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

fun UByteArray.singleOrNull(): UByte?

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

fun UByteArray.singleOrNull(
    predicate: (UByte) -> Boolean
): UByte?
fun <T> Iterable<T>.singleOrNull(
    predicate: (T) -> Boolean
): T?
Common
JVM
JS
Native
1.3

slice

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

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

Returns a list containing elements at specified indices.

fun UByteArray.slice(indices: Iterable<Int>): List<UByte>
Common
JVM
JS
Native
1.3

sliceArray

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

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

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

fun UByteArray.sliceArray(indices: IntRange): UByteArray
Common
JVM
JS
Native
1.3

sort

Sorts the array in-place.

fun UByteArray.sort()
Common
JVM
JS
Native
1.3

sortDescending

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

fun UByteArray.sortDescending()
Common
JVM
JS
Native
1.3

sorted

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

fun UByteArray.sorted(): List<UByte>
Common
JVM
JS
Native
1.3

sortedArray

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

fun UByteArray.sortedArray(): UByteArray
Common
JVM
JS
Native
1.3

sortedArrayDescending

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

fun UByteArray.sortedArrayDescending(): UByteArray
Common
JVM
JS
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>
Common
JVM
JS
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>
Common
JVM
JS
Native
1.3

sortedDescending

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

fun UByteArray.sortedDescending(): List<UByte>
Common
JVM
JS
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>
Common
JVM
JS
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>
Common
JVM
JS
Native
1.3

sum

Returns the sum of all elements in the array.

fun UByteArray.sum(): UInt
Common
JVM
JS
Native
1.0

sumBy

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

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

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
Common
JVM
JS
Native
1.0

sumByDouble

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

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

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
Common
JVM
JS
Native
1.3

take

Returns a list containing first n elements.

fun UByteArray.take(n: Int): List<UByte>
Common
JVM
JS
Native
1.3

takeLast

Returns a list containing last n elements.

fun UByteArray.takeLast(n: Int): List<UByte>
Common
JVM
JS
Native
1.3

takeLastWhile

Returns a list containing last elements satisfying the given predicate.

fun UByteArray.takeLastWhile(
    predicate: (UByte) -> Boolean
): List<UByte>
Common
JVM
JS
Native
1.0

takeWhile

Returns a list containing first elements satisfying the given predicate.

fun UByteArray.takeWhile(
    predicate: (UByte) -> Boolean
): List<UByte>
fun <T> Iterable<T>.takeWhile(
    predicate: (T) -> Boolean
): List<T>
Common
JVM
JS
Native
1.3

toByteArray

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 UByteArray.toByteArray(): ByteArray
Common
JVM
JS
Native
1.0

toCollection

Appends all elements to the given destination collection.

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

toCValues

fun UByteArray.toCValues(): CValues<UByteVar>
Common
JVM
JS
Native
1.0

toHashSet

Returns a HashSet of all elements.

fun <T> Iterable<T>.toHashSet(): HashSet<T>
Common
JVM
JS
Native
1.0

toList

Returns a List containing all elements.

fun <T> Iterable<T>.toList(): List<T>
Common
JVM
JS
Native
1.0

toMutableSet

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

fun <T> Iterable<T>.toMutableSet(): MutableSet<T>
Common
JVM
JS
Native
1.0

toSet

Returns a Set of all elements.

fun <T> Iterable<T>.toSet(): Set<T>
Common
JVM
JS
Native
1.3

toTypedArray

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

fun UByteArray.toTypedArray(): Array<UByte>
Common
JVM
JS
Native
1.3

toUByteArray

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

fun Collection<UByte>.toUByteArray(): UByteArray
Common
JVM
JS
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>
Common
JVM
JS
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>
Common
JVM
JS
Native
1.3

withIndex

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

Common
JVM
JS
Native
1.0

zip

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.

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

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.

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

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.

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

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.

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 array with the same index using the provided transform function applied to each pair of elements. The returned list has length of the shortest array.

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

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>
Common
JVM
JS
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>