Array

class Array<T> (source)

Represents an array (specifically, a Java array when targeting the JVM platform). Array instances can be created using the arrayOf, arrayOfNulls and emptyArray standard library functions. See Kotlin language documentation for more information on arrays.

Constructors

<init>

Array(size: Int, init: (Int) -> T)

Creates a new array with the specified size, where each element is calculated by calling the specified init function. The init function returns an array element given its index.

Properties

size

val size: Int

Returns the number of elements in the array.

Functions

get

operator fun get(index: Int): T

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

iterator

operator fun iterator(): Iterator<T>

Creates an iterator for iterating over the elements of the array.

set

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

Sets the array element at the specified index to the specified value. This method can be called using the index operator:

Inherited Functions

equals

open operator fun equals(other: Any?): Boolean

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

hashCode

open fun hashCode(): Int

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

toString

open fun toString(): String

Returns a string representation of the object.

Extension Properties

indices

val <T> Array<out T>.indices: IntRange

Returns the range of valid indices for the array.

lastIndex

val <T> Array<out T>.lastIndex: Int

Returns the last valid index for the array.

Extension Functions

all

fun <T> Array<out T>.all(predicate: (T) -> Boolean): Boolean

Returns true if all elements match the given predicate.

any

fun <T> Array<out T>.any(): Boolean

Returns true if array has at least one element.

fun <T> Array<out T>.any(predicate: (T) -> Boolean): Boolean

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

asIterable

fun <T> Array<out T>.asIterable(): Iterable<T>

Creates an Iterable instance that wraps the original array returning its elements when being iterated.

asList

actual fun <T> Array<out T>.asList(): List<T>

Returns a List that wraps the original array.

asSequence

fun <T> Array<out T>.asSequence(): Sequence<T>

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

associate

fun <T, K, V> Array<out 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 array.

associateBy

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

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

fun <T, K, V> Array<out 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 array.

associateByTo

fun <T, K, M : MutableMap<in K, in T>> Array<out 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 array and value is the element itself.

fun <T, K, V, M : MutableMap<in K, in V>> Array<out 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 array.

associateTo

fun <T, K, V, M : MutableMap<in K, in V>> Array<out 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 array.

average

fun Array<out Byte>.average(): Double
fun Array<out Short>.average(): Double
fun Array<out Int>.average(): Double
fun Array<out Long>.average(): Double
fun Array<out Float>.average(): Double
fun Array<out Double>.average(): Double

Returns an average value of elements in the array.

binarySearch

fun <T> Array<out T>.binarySearch(
    element: T,
    comparator: Comparator<in T>,
    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 according to the specified comparator, otherwise the result is undefined.

fun <T> Array<out T>.binarySearch(
    element: T,
    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.

component1

operator fun <T> Array<out T>.component1(): T

Returns 1st element from the collection.

component2

operator fun <T> Array<out T>.component2(): T

Returns 2nd element from the collection.

component3

operator fun <T> Array<out T>.component3(): T

Returns 3rd element from the collection.

component4

operator fun <T> Array<out T>.component4(): T

Returns 4th element from the collection.

component5

operator fun <T> Array<out T>.component5(): T

Returns 5th element from the collection.

contains

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

Returns true if element is found in the array.

contentDeepEquals

infix actual fun <T> Array<out T>.contentDeepEquals(
    other: Array<out T>
): Boolean

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

contentDeepHashCode

actual fun <T> Array<out T>.contentDeepHashCode(): Int

Returns a hash code based on the contents of this array as if it is List. Nested arrays are treated as lists too.

contentDeepToString

actual fun <T> Array<out T>.contentDeepToString(): String

Returns a string representation of the contents of this array as if it is a List. Nested arrays are treated as lists too.

contentEquals

infix actual fun <T> Array<out T>.contentEquals(
    other: Array<out T>
): 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

actual fun <T> Array<out T>.contentHashCode(): Int

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

contentToString

actual fun <T> Array<out T>.contentToString(): String

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

copyOf

actual fun <T> Array<T>.copyOf(): Array<T>

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

actual fun <T> Array<T>.copyOf(newSize: Int): Array<T?>

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 null values if necessary.

copyOfRange

actual fun <T> Array<T>.copyOfRange(
    fromIndex: Int,
    toIndex: Int
): Array<T>

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

count

fun <T> Array<out T>.count(): Int

Returns the number of elements in this array.

fun <T> Array<out T>.count(predicate: (T) -> Boolean): Int

Returns the number of elements matching the given predicate.

distinct

fun <T> Array<out T>.distinct(): List<T>

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

distinctBy

fun <T, K> Array<out T>.distinctBy(
    selector: (T) -> K
): List<T>

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

drop

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

Returns a list containing all elements except first n elements.

dropLast

fun <T> Array<out T>.dropLast(n: Int): List<T>

Returns a list containing all elements except last n elements.

dropLastWhile

fun <T> Array<out T>.dropLastWhile(
    predicate: (T) -> Boolean
): List<T>

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

dropWhile

fun <T> Array<out T>.dropWhile(
    predicate: (T) -> Boolean
): List<T>

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

elementAt

fun <T> Array<out 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 array.

elementAtOrElse

fun <T> Array<out 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 array.

elementAtOrNull

fun <T> Array<out T>.elementAtOrNull(index: Int): T?

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

fill

fun <T> Array<T>.fill(
    element: T,
    fromIndex: Int = 0,
    toIndex: Int = size)

Fills original array with the provided value.

filter

fun <T> Array<out T>.filter(
    predicate: (T) -> Boolean
): List<T>

Returns a list containing only elements matching the given predicate.

filterIndexed

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

Returns a list containing only elements matching the given predicate.

filterIndexedTo

fun <T, C : MutableCollection<in T>> Array<out T>.filterIndexedTo(
    destination: C,
    predicate: (index: Int, T) -> Boolean
): C

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

filterIsInstance

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

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

fun <R> Array<*>.filterIsInstance(): List<R>

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

filterIsInstanceTo

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

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

fun <R, C : MutableCollection<in R>> Array<*>.filterIsInstanceTo(
    destination: C
): C

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

filterNot

fun <T> Array<out T>.filterNot(
    predicate: (T) -> Boolean
): List<T>

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

filterNotNull

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

Returns a list containing all elements that are not null.

filterNotNullTo

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

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

filterNotTo

fun <T, C : MutableCollection<in T>> Array<out T>.filterNotTo(
    destination: C,
    predicate: (T) -> Boolean
): C

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

filterTo

fun <T, C : MutableCollection<in T>> Array<out T>.filterTo(
    destination: C,
    predicate: (T) -> Boolean
): C

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

find

fun <T> Array<out T>.find(predicate: (T) -> Boolean): T?

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

findLast

fun <T> Array<out T>.findLast(predicate: (T) -> Boolean): T?

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

first

fun <T> Array<out T>.first(): T

Returns first element.

fun <T> Array<out T>.first(predicate: (T) -> Boolean): T

Returns the first element matching the given predicate.

firstOrNull

fun <T> Array<out T>.firstOrNull(): T?

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

fun <T> Array<out T>.firstOrNull(
    predicate: (T) -> Boolean
): T?

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

flatMap

fun <T, R> Array<out T>.flatMap(
    transform: (T) -> 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.

flatMapTo

fun <T, R, C : MutableCollection<in R>> Array<out T>.flatMapTo(
    destination: C,
    transform: (T) -> Iterable<R>
): C

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

flatten

fun <T> Array<out Array<out T>>.flatten(): List<T>

Returns a single list of all elements from all arrays in the given array.

fold

fun <T, R> Array<out 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

fun <T, R> Array<out 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 array.

foldRight

fun <T, R> Array<out T>.foldRight(
    initial: R,
    operation: (T, 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

fun <T, R> Array<out T>.foldRightIndexed(
    initial: R,
    operation: (index: Int, T, 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

fun <T> Array<out T>.forEach(action: (T) -> Unit)

Performs the given action on each element.

forEachIndexed

fun <T> Array<out T>.forEachIndexed(
    action: (index: Int, T) -> Unit)

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

getOrElse

fun <T> Array<out T>.getOrElse(
    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 array.

getOrNull

fun <T> Array<out T>.getOrNull(index: Int): T?

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

groupBy

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

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 <T, K, V> Array<out 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 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.

groupByTo

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

fun <T, K, V, M : MutableMap<in K, MutableList<V>>> Array<out 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 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.

groupingBy

fun <T, K> Array<out T>.groupingBy(
    keySelector: (T) -> K
): Grouping<T, K>

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

indexOf

fun <T> Array<out T>.indexOf(element: T): Int

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

indexOfFirst

fun <T> Array<out T>.indexOfFirst(
    predicate: (T) -> Boolean
): Int

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

indexOfLast

fun <T> Array<out T>.indexOfLast(
    predicate: (T) -> Boolean
): Int

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

intersect

infix fun <T> Array<out T>.intersect(
    other: Iterable<T>
): Set<T>

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

isArrayOf

fun <T : Any> Array<*>.isArrayOf(): Boolean

Checks if array can contain element of type T.

isEmpty

fun <T> Array<out T>.isEmpty(): Boolean

Returns true if the array is empty.

isNotEmpty

fun <T> Array<out T>.isNotEmpty(): Boolean

Returns true if the array is not empty.

joinTo

fun <T, A> Array<out 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> Array<out 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

fun <T> Array<out T>.last(): T

Returns the last element.

fun <T> Array<out T>.last(predicate: (T) -> Boolean): T

Returns the last element matching the given predicate.

lastIndexOf

fun <T> Array<out T>.lastIndexOf(element: T): Int

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

lastOrNull

fun <T> Array<out T>.lastOrNull(): T?

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

fun <T> Array<out T>.lastOrNull(
    predicate: (T) -> Boolean
): T?

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

map

fun <T, R> Array<out 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 array.

mapIndexed

fun <T, R> Array<out 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 array.

mapIndexedNotNull

fun <T, R : Any> Array<out 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 array.

mapIndexedNotNullTo

fun <T, R : Any, C : MutableCollection<in R>> Array<out T>.mapIndexedNotNullTo(
    destination: C,
    transform: (index: Int, T) -> R?
): C

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

mapIndexedTo

fun <T, R, C : MutableCollection<in R>> Array<out T>.mapIndexedTo(
    destination: C,
    transform: (index: Int, T) -> 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.

mapNotNull

fun <T, R : Any> Array<out 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 array.

mapNotNullTo

fun <T, R : Any, C : MutableCollection<in R>> Array<out T>.mapNotNullTo(
    destination: C,
    transform: (T) -> R?
): C

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

mapTo

fun <T, R, C : MutableCollection<in R>> Array<out T>.mapTo(
    destination: C,
    transform: (T) -> R
): C

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

max

fun <T : Comparable<T>> any_array<T>.max(): T?

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

maxBy

fun <T, R : Comparable<R>> Array<out T>.maxBy(
    selector: (T) -> R
): T?

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

maxWith

fun <T> Array<out T>.maxWith(
    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

fun <T : Comparable<T>> any_array<T>.min(): T?

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

minBy

fun <T, R : Comparable<R>> Array<out T>.minBy(
    selector: (T) -> R
): T?

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

minWith

fun <T> Array<out T>.minWith(
    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

fun <T> Array<out T>.none(): Boolean

Returns true if the array has no elements.

fun <T> Array<out T>.none(predicate: (T) -> Boolean): Boolean

Returns true if no elements match the given predicate.

orEmpty

actual fun <T> Array<out T>?.orEmpty(): Array<out T>

Returns the array if it's not null, or an empty array otherwise.

partition

fun <T> Array<out T>.partition(
    predicate: (T) -> Boolean
): Pair<List<T>, List<T>>

Splits the original array 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

operator actual fun <T> Array<T>.plus(element: T): Array<T>

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

operator actual fun <T> Array<T>.plus(
    elements: Collection<T>
): Array<T>

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

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

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

plusElement

actual fun <T> Array<T>.plusElement(element: T): Array<T>

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

reduce

fun <S, T : S> Array<out 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

fun <S, T : S> Array<out 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 array.

reduceRight

fun <S, T : S> Array<out T>.reduceRight(
    operation: (T, acc: S) -> S
): S

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

reduceRightIndexed

fun <S, T : S> Array<out T>.reduceRightIndexed(
    operation: (index: Int, T, acc: S) -> S
): S

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.

requireNoNulls

fun <T : Any> Array<T?>.requireNoNulls(): Array<T>

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

reverse

fun <T> Array<T>.reverse()

Reverses elements in the array in-place.

reversed

fun <T> Array<out T>.reversed(): List<T>

Returns a list with elements in reversed order.

reversedArray

fun <T> Array<T>.reversedArray(): Array<T>

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

single

fun <T> Array<out T>.single(): T

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

fun <T> Array<out 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.

singleOrNull

fun <T> Array<out T>.singleOrNull(): T?

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

fun <T> Array<out 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.

slice

fun <T> Array<out T>.slice(indices: IntRange): List<T>

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

fun <T> Array<out T>.slice(indices: Iterable<Int>): List<T>

Returns a list containing elements at specified indices.

sliceArray

fun <T> Array<T>.sliceArray(
    indices: Collection<Int>
): Array<T>

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

fun <T> Array<T>.sliceArray(indices: IntRange): Array<T>

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

sort

actual fun <T : Comparable<T>> Array<out T>.sort()

Sorts the array in-place according to the natural order of its elements.

fun <T> Array<out T>.sort(
    fromIndex: Int = 0,
    toIndex: Int = size)

Sorts a range in the array in-place.

fun <T> Array<out T>.sort(comparison: (a: T, b: T) -> Int)

Sorts the array in-place according to the order specified by the given comparison function.

sortBy

fun <T, R : Comparable<R>> Array<out T>.sortBy(
    selector: (T) -> R?)

Sorts elements in the array in-place according to natural sort order of the value returned by specified selector function.

sortByDescending

fun <T, R : Comparable<R>> Array<out T>.sortByDescending(
    selector: (T) -> R?)

Sorts elements in the array in-place descending according to natural sort order of the value returned by specified selector function.

sortDescending

fun <T : Comparable<T>> Array<out T>.sortDescending()

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

sortWith

actual fun <T> any_array<T>.sortWith(
    comparator: Comparator<in T>)

Sorts the array in-place according to the order specified by the given comparator.

fun <T> Array<out T>.sortWith(
    comparator: Comparator<in T>,
    fromIndex: Int = 0,
    toIndex: Int = size)

Sorts a range in the array in-place with the given comparator.

sorted

fun <T : Comparable<T>> Array<out T>.sorted(): List<T>

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

sortedArray

fun <T : Comparable<T>> Array<T>.sortedArray(): Array<T>

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

sortedArrayDescending

fun <T : Comparable<T>> Array<T>.sortedArrayDescending(): Array<T>

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

sortedArrayWith

fun <T> Array<out T>.sortedArrayWith(
    comparator: Comparator<in T>
): Array<out T>

Returns an array with all elements of this array sorted according the specified comparator.

sortedBy

fun <T, R : Comparable<R>> Array<out T>.sortedBy(
    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

fun <T, R : Comparable<R>> Array<out T>.sortedByDescending(
    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

fun <T : Comparable<T>> Array<out T>.sortedDescending(): List<T>

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

sortedWith

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

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

subtract

infix fun <T> Array<out T>.subtract(
    other: Iterable<T>
): Set<T>

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

sum

fun Array<out Byte>.sum(): Int
fun Array<out Short>.sum(): Int
fun Array<out Int>.sum(): Int
fun Array<out Long>.sum(): Long
fun Array<out Float>.sum(): Float
fun Array<out Double>.sum(): Double

Returns the sum of all elements in the array.

sumBy

fun <T> Array<out T>.sumBy(selector: (T) -> Int): Int

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

sumByDouble

fun <T> Array<out T>.sumByDouble(
    selector: (T) -> Double
): Double

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

take

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

Returns a list containing first n elements.

takeLast

fun <T> Array<out T>.takeLast(n: Int): List<T>

Returns a list containing last n elements.

takeLastWhile

fun <T> Array<out T>.takeLastWhile(
    predicate: (T) -> Boolean
): List<T>

Returns a list containing last elements satisfying the given predicate.

takeWhile

fun <T> Array<out T>.takeWhile(
    predicate: (T) -> Boolean
): List<T>

Returns a list containing first elements satisfying the given predicate.

toBooleanArray

fun Array<out Boolean>.toBooleanArray(): BooleanArray

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

toByteArray

fun Array<out Byte>.toByteArray(): ByteArray

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

toCharArray

fun Array<out Char>.toCharArray(): CharArray

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

toCollection

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

Appends all elements to the given destination collection.

toDoubleArray

fun Array<out Double>.toDoubleArray(): DoubleArray

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

toFloatArray

fun Array<out Float>.toFloatArray(): FloatArray

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

toHashSet

fun <T> Array<out T>.toHashSet(): HashSet<T>

Returns a HashSet of all elements.

toIntArray

fun Array<out Int>.toIntArray(): IntArray

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

toList

fun <T> Array<out T>.toList(): List<T>

Returns a List containing all elements.

toLongArray

fun Array<out Long>.toLongArray(): LongArray

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

toMap

fun <K, V> Array<out Pair<K, V>>.toMap(): Map<K, V>

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

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

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

toMutableList

fun <T> Array<out T>.toMutableList(): MutableList<T>

Returns a MutableList filled with all elements of this array.

toMutableSet

fun <T> Array<out T>.toMutableSet(): MutableSet<T>

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

toSet

fun <T> Array<out T>.toSet(): Set<T>

Returns a Set of all elements.

toShortArray

fun Array<out Short>.toShortArray(): ShortArray

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

toSortedSet

fun <T : Comparable<T>> any_array<T>.toSortedSet(): SortedSet<T>

Returns a SortedSet of all elements.

union

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

Returns a set containing all distinct elements from both collections.

unzip

fun <T, R> Array<out 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 array, second list is built from the second values of each pair from this array.

withIndex

fun <T> Array<out T>.withIndex(): Iterable<IndexedValue<T>>

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

zip

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

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.

fun <T, R, V> Array<out 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 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.

infix fun <T, R> Array<out T>.zip(
    other: Iterable<R>
): List<Pair<T, 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.

fun <T, R, V> Array<out T>.zip(
    other: Iterable<R>,
    transform: (a: T, 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.