UIntArray
@ExperimentalUnsignedTypes inline class UIntArray :
Collection<UInt>
Constructors
Properties
size
Returns the number of elements in the array.
val size: Int
Functions
containsAll
fun containsAll(elements: Collection<UInt>): Boolean
isEmpty
fun isEmpty(): Boolean
iterator
Creates an iterator over the elements of the array.
operator fun iterator(): UIntIterator
Extension Properties
Extension Functions
associateBy
Returns a Map containing the elements from the given collection indexed by the key returned from keySelector function applied to each element.
Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to elements of the given collection.
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
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
associateWith
Returns a Map where keys are elements from the given collection and values are produced by the valueSelector function applied to each element.
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
containsAll
Checks if all elements in the specified collection are contained in this collection.
fun <T> Collection<T>.containsAll(
elements: Collection<T>
): Boolean
copyInto
Copies this array or its subrange into the destination array and returns that array.
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.
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
filterIndexedTo
Appends all elements matching the given predicate to the given destination.
fun <C : MutableCollection<in UInt>> UIntArray.filterIndexedTo(
destination: C,
predicate: (index: Int, UInt) -> Boolean
): C
fun <T, C : MutableCollection<in T>> Iterable<T>.filterIndexedTo(
destination: C,
predicate: (index: Int, T) -> Boolean
): C
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
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
filterNotTo
Appends all elements not matching the given predicate to the given destination.
fun <C : MutableCollection<in UInt>> UIntArray.filterNotTo(
destination: C,
predicate: (UInt) -> Boolean
): C
fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo(
destination: C,
predicate: (T) -> Boolean
): C
filterTo
Appends all elements matching the given predicate to the given destination.
fun <C : MutableCollection<in UInt>> UIntArray.filterTo(
destination: C,
predicate: (UInt) -> Boolean
): C
fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(
destination: C,
predicate: (T) -> Boolean
): C
flatMap
Returns a single list of all elements yielded from results of transform function being invoked on each element of original array.
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>> UIntArray.flatMapTo(
destination: C,
transform: (UInt) -> 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
foldIndexed
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.
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.
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.
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
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<UInt>>> UIntArray.groupByTo(
destination: M,
keySelector: (UInt) -> 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>>> UIntArray.groupByTo(
destination: M,
keySelector: (UInt) -> K,
valueTransform: (UInt) -> 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
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.
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
indexOfFirst
Returns index of the first element matching the given predicate, or -1 if the array does not contain such element.
indexOfLast
Returns index of the last element matching the given predicate, or -1 if the array does not contain such element.
isNotEmpty
Returns true
if the collection is not empty.
fun <T> Collection<T>.isNotEmpty(): Boolean
isNullOrEmpty
Returns true
if this nullable collection is either null or empty.
fun <T> Collection<T>?.isNullOrEmpty(): Boolean
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
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
lastIndexOf
Returns last index of element, or -1 if the array does not contain element.
map
Returns a list containing the results of applying the given transform function to each element in the original array.
mapIndexed
Returns a list containing the results of applying the given transform function to each element and its index in the original array.
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
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>> UIntArray.mapIndexedTo(
destination: C,
transform: (index: Int, UInt) -> 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
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
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>> UIntArray.mapTo(
destination: C,
transform: (UInt) -> 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
maxBy
Returns the first element yielding the largest value of the given function or null
if there are no elements.
fun <R : Comparable<R>> UIntArray.maxBy(
selector: (UInt) -> R
): UInt?
fun <T, R : Comparable<R>> Iterable<T>.maxBy(
selector: (T) -> R
): T?
maxWith
Returns the first element having the largest value according to the provided comparator or null
if there are no elements.
fun UIntArray.maxWith(comparator: Comparator<in UInt>): UInt?
fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): T?
minBy
Returns the first element yielding the smallest value of the given function or null
if there are no elements.
fun <R : Comparable<R>> UIntArray.minBy(
selector: (UInt) -> R
): UInt?
fun <T, R : Comparable<R>> Iterable<T>.minBy(
selector: (T) -> R
): T?
minus
Returns a list containing all elements of the original collection without the first occurrence of the given element.
Returns a list containing all elements of the original collection except the elements contained in the given elements array.
Returns a list containing all elements of the original collection except the elements contained in the given elements collection.
minWith
Returns the first element having the smallest value according to the provided comparator or null
if there are no elements.
fun UIntArray.minWith(comparator: Comparator<in UInt>): UInt?
fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): T?
orEmpty
Returns this Collection if it's not null
and the empty list otherwise.
fun <T> Collection<T>?.orEmpty(): Collection<T>
plus
Returns an array containing all elements of the original array and then the given element.
Returns an array containing all elements of the original array and then all elements of the given elements collection.
operator fun UIntArray.plus(
elements: Collection<UInt>
): UIntArray
Returns an array containing all elements of the original array and then all elements of the given elements array.
Returns a list containing all elements of the original collection and then the given element.
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> 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> Collection<T>.plus(
elements: Iterable<T>
): List<T>
plusElement
Returns a list containing all elements of the original collection and then the given element.
fun <T> Collection<T>.plusElement(element: T): List<T>
randomOrNull
Returns a random element from this array, or null
if this array is empty.
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.
reduceOrNull
Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element. Returns null if the array is empty.
refTo
fun UIntArray.refTo(index: Int): CValuesRef<UIntVar>
requireNoNulls
Returns an original collection containing all the non-null
elements, throwing an IllegalArgumentException if there are any null
elements.
scan
scanIndexed
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.
scanReduce
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.
scanReduceIndexed
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 the first element of this array.
Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original collection and current accumulator value that starts with the first element of this collection.
single
Returns the single element, or throws an exception if the array is empty or has more than one element.
singleOrNull
Returns single element, or null
if the array is empty or has more than one element.
sliceArray
Returns an array containing elements of this array at specified indices.
fun UIntArray.sliceArray(indices: Collection<Int>): UIntArray
sortDescending
Sorts elements in the array in-place descending according to their natural sort order.
fun UIntArray.sortDescending()
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>
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>
sortedWith
Returns a list of all elements sorted according to the specified comparator.
fun <T> Iterable<T>.sortedWith(
comparator: Comparator<in T>
): List<T>
sumBy
Returns the sum of all values produced by selector function applied to each element in the array.
sumByDouble
Returns the sum of all values produced by selector function applied to each element in the array.
toCollection
Appends all elements to the given destination collection.
fun <T, C : MutableCollection<in T>> Iterable<T>.toCollection(
destination: C
): C
toMutableSet
Returns a mutable set containing all distinct elements from the given collection.
fun <T> Iterable<T>.toMutableSet(): MutableSet<T>
toUIntArray
Returns an array of UInt containing all of the elements of this collection.
fun Collection<UInt>.toUIntArray(): UIntArray
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.
withIndex
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 UIntArray.withIndex(): Iterable<IndexedValue<UInt>>
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.
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.
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.
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.
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.
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.
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.
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.
zipWithNext
Returns a list of pairs of each two adjacent elements in this collection.