CharArray

class CharArray(size: Int)(source)

An array of chars. When targeting the JVM, instances of this class are represented as char[].

Since Kotlin

1.0

An array of chars.

Since Kotlin

1.3

Constructors

Link copied to clipboard
constructor(size: Int, init: (Int) -> Char)

Creates a new array of the specified size, where each element is calculated by calling the specified init function.

constructor(size: Int)

Creates a new array of the specified size, with all elements initialized to null char (`\u0000').

constructor(size: Int)
constructor(size: Int, init: (Int) -> Char)

Creates a new array of the specified size, where each element is calculated by calling the specified init function.

Properties

Link copied to clipboard

Returns the range of valid indices for the array.

Since Kotlin 1.0
Link copied to clipboard

Returns the last valid index for the array.

Since Kotlin 1.0
Link copied to clipboard
val size: Int

Returns the number of elements in the array.

Since Kotlin 1.0
val size: Int

Returns the number of elements in the array.

Since Kotlin 1.3

Functions

Link copied to clipboard
inline fun CharArray.all(predicate: (Char) -> Boolean): Boolean

Returns true if all elements match the given predicate.

Since Kotlin 1.0
Link copied to clipboard

Returns true if array has at least one element.

Since Kotlin 1.0
inline fun CharArray.any(predicate: (Char) -> Boolean): Boolean

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

Since Kotlin 1.0
Link copied to clipboard

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

Since Kotlin 1.0
Link copied to clipboard
expect fun CharArray.asList(): List<Char>

Returns a List that wraps the original array.

Since Kotlin 1.0
actual fun CharArray.asList(): List<Char>

Returns a List that wraps the original array.

Since Kotlin 1.1
actual fun CharArray.asList(): List<Char>

Returns a List that wraps the original array.

Since Kotlin 1.0
actual fun CharArray.asList(): List<Char>

Returns a List that wraps the original array.

Since Kotlin 1.3
Link copied to clipboard

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <K, V> CharArray.associate(transform: (Char) -> Pair<K, V>): Map<K, V>

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <K> CharArray.associateBy(keySelector: (Char) -> K): Map<K, Char>

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

Since Kotlin 1.0
inline fun <K, V> CharArray.associateBy(keySelector: (Char) -> K, valueTransform: (Char) -> 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.

Since Kotlin 1.0
Link copied to clipboard
inline fun <K, M : MutableMap<in K, in Char>> CharArray.associateByTo(destination: M, keySelector: (Char) -> 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.

Since Kotlin 1.0
inline fun <K, V, M : MutableMap<in K, in V>> CharArray.associateByTo(destination: M, keySelector: (Char) -> K, valueTransform: (Char) -> 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.

Since Kotlin 1.0
Link copied to clipboard
inline fun <K, V, M : MutableMap<in K, in V>> CharArray.associateTo(destination: M, transform: (Char) -> 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.

Since Kotlin 1.0
Link copied to clipboard
inline fun <V> CharArray.associateWith(valueSelector: (Char) -> V): Map<Char, V>

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

Since Kotlin 1.4
Link copied to clipboard
inline fun <V, M : MutableMap<in Char, in V>> CharArray.associateWithTo(destination: M, valueSelector: (Char) -> V): M

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

Since Kotlin 1.4
Link copied to clipboard
fun CharArray.binarySearch(element: Char, 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.

Since Kotlin 1.0
Link copied to clipboard
inline operator fun CharArray.component1(): Char

Returns 1st element from the array.

Since Kotlin 1.0
Link copied to clipboard
inline operator fun CharArray.component2(): Char

Returns 2nd element from the array.

Since Kotlin 1.0
Link copied to clipboard
inline operator fun CharArray.component3(): Char

Returns 3rd element from the array.

Since Kotlin 1.0
Link copied to clipboard
inline operator fun CharArray.component4(): Char

Returns 4th element from the array.

Since Kotlin 1.0
Link copied to clipboard
inline operator fun CharArray.component5(): Char

Returns 5th element from the array.

Since Kotlin 1.0
Link copied to clipboard

Concatenates characters in this CharArray into a String.

Since Kotlin 1.4
expect fun CharArray.concatToString(startIndex: Int = 0, endIndex: Int = this.size): String

Concatenates characters in this CharArray or its subrange into a String.

Since Kotlin 1.4

Concatenates characters in this CharArray into a String.

Since Kotlin 1.4
actual fun CharArray.concatToString(startIndex: Int = 0, endIndex: Int = this.size): String

Concatenates characters in this CharArray or its subrange into a String.

Since Kotlin 1.4

Concatenates characters in this CharArray into a String.

Since Kotlin 1.4
actual fun CharArray.concatToString(startIndex: Int = 0, endIndex: Int = this.size): String

Concatenates characters in this CharArray or its subrange into a String.

Since Kotlin 1.4

Concatenates characters in this CharArray into a String.

Since Kotlin 1.3
actual fun CharArray.concatToString(startIndex: Int = 0, endIndex: Int = this.size): String

Concatenates characters in this CharArray or its subrange into a String.

Since Kotlin 1.3
Link copied to clipboard
operator fun CharArray.contains(element: Char): Boolean

Returns true if element is found in the array.

Since Kotlin 1.0
Link copied to clipboard
expect infix fun CharArray.contentEquals(other: CharArray): 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.

Since Kotlin 1.1
expect infix fun CharArray?.contentEquals(other: CharArray?): 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.

Since Kotlin 1.4
actual infix fun CharArray.contentEquals(other: CharArray): 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.

Since Kotlin 1.1
actual infix fun CharArray?.contentEquals(other: CharArray?): 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.

Since Kotlin 1.4
actual infix inline fun CharArray.contentEquals(other: CharArray): 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.

Since Kotlin 1.1
@JvmName(name = "contentEqualsNullable")
actual infix inline fun CharArray?.contentEquals(other: CharArray?): 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.

Since Kotlin 1.4
actual infix fun CharArray.contentEquals(other: CharArray): 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.

Since Kotlin 1.3
actual infix fun CharArray?.contentEquals(other: CharArray?): 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.

Since Kotlin 1.4
Link copied to clipboard

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

Since Kotlin 1.1

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

Since Kotlin 1.4

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

Since Kotlin 1.1

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

Since Kotlin 1.4
actual inline fun CharArray.contentHashCode(): Int

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

Since Kotlin 1.1
@JvmName(name = "contentHashCodeNullable")
actual inline fun CharArray?.contentHashCode(): Int

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

Since Kotlin 1.4

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

Since Kotlin 1.3

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

Since Kotlin 1.4
Link copied to clipboard

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

Since Kotlin 1.1

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

Since Kotlin 1.4

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

Since Kotlin 1.1

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

Since Kotlin 1.4
actual inline fun CharArray.contentToString(): String

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

Since Kotlin 1.1
@JvmName(name = "contentToStringNullable")
actual inline fun CharArray?.contentToString(): String

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

Since Kotlin 1.4

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

Since Kotlin 1.3

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

Since Kotlin 1.4
Link copied to clipboard
expect fun CharArray.copyInto(destination: CharArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = size): CharArray

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

Since Kotlin 1.3
actual inline fun CharArray.copyInto(destination: CharArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = size): CharArray

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

Since Kotlin 1.3
actual fun CharArray.copyInto(destination: CharArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = size): CharArray

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

Since Kotlin 1.3
actual fun CharArray.copyInto(destination: CharArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = size): CharArray

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

Since Kotlin 1.3
Link copied to clipboard
expect fun CharArray.copyOf(): CharArray

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

Since Kotlin 1.0
expect fun CharArray.copyOf(newSize: Int): CharArray

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 char (\u0000) values if necessary.

Since Kotlin 1.0
actual fun CharArray.copyOf(): CharArray

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

Since Kotlin 1.1
actual fun CharArray.copyOf(newSize: Int): CharArray

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 char (\u0000) values if necessary.

Since Kotlin 1.1
actual inline fun CharArray.copyOf(): CharArray

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

Since Kotlin 1.0
actual inline fun CharArray.copyOf(newSize: Int): CharArray

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 char (\u0000) values if necessary.

Since Kotlin 1.0
actual fun CharArray.copyOf(): CharArray

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

Since Kotlin 1.3
actual fun CharArray.copyOf(newSize: Int): CharArray

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 char (\u0000) values if necessary.

Since Kotlin 1.3
Link copied to clipboard
expect fun CharArray.copyOfRange(fromIndex: Int, toIndex: Int): CharArray

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

Since Kotlin 1.0
actual fun CharArray.copyOfRange(fromIndex: Int, toIndex: Int): CharArray

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

Since Kotlin 1.1
@JvmName(name = "copyOfRangeInline")
actual inline fun CharArray.copyOfRange(fromIndex: Int, toIndex: Int): CharArray

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

Since Kotlin 1.0
actual fun CharArray.copyOfRange(fromIndex: Int, toIndex: Int): CharArray

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

Since Kotlin 1.3
Link copied to clipboard
inline fun CharArray.count(): Int

Returns the number of elements in this array.

Since Kotlin 1.0
inline fun CharArray.count(predicate: (Char) -> Boolean): Int

Returns the number of elements matching the given predicate.

Since Kotlin 1.0
Link copied to clipboard

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <K> CharArray.distinctBy(selector: (Char) -> K): List<Char>

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

Since Kotlin 1.0
Link copied to clipboard

Returns a list containing all elements except first n elements.

Since Kotlin 1.0
Link copied to clipboard

Returns a list containing all elements except last n elements.

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.dropLastWhile(predicate: (Char) -> Boolean): List<Char>

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

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.dropWhile(predicate: (Char) -> Boolean): List<Char>

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

Since Kotlin 1.0
Link copied to clipboard
expect fun CharArray.elementAt(index: Int): Char

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

Since Kotlin 1.0
actual fun CharArray.elementAt(index: Int): Char

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

Since Kotlin 1.1
actual inline fun CharArray.elementAt(index: Int): Char

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

Since Kotlin 1.0
actual inline fun CharArray.elementAt(index: Int): Char

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

Since Kotlin 1.3
Link copied to clipboard
inline fun CharArray.elementAtOrElse(index: Int, defaultValue: (Int) -> Char): Char

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.

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.elementAtOrNull(index: Int): Char?

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

Since Kotlin 1.0
Link copied to clipboard
expect fun CharArray.fill(element: Char, fromIndex: Int = 0, toIndex: Int = size)

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

Since Kotlin 1.3
actual fun CharArray.fill(element: Char, fromIndex: Int = 0, toIndex: Int = size)

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

Since Kotlin 1.3
actual fun CharArray.fill(element: Char, fromIndex: Int = 0, toIndex: Int = size)

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

Since Kotlin 1.0
actual fun CharArray.fill(element: Char, fromIndex: Int = 0, toIndex: Int = size)

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

Since Kotlin 1.3
Link copied to clipboard
inline fun CharArray.filter(predicate: (Char) -> Boolean): List<Char>

Returns a list containing only elements matching the given predicate.

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.filterIndexed(predicate: (index: Int, Char) -> Boolean): List<Char>

Returns a list containing only elements matching the given predicate.

Since Kotlin 1.0
Link copied to clipboard
inline fun <C : MutableCollection<in Char>> CharArray.filterIndexedTo(destination: C, predicate: (index: Int, Char) -> Boolean): C

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

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.filterNot(predicate: (Char) -> Boolean): List<Char>

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <C : MutableCollection<in Char>> CharArray.filterNotTo(destination: C, predicate: (Char) -> Boolean): C

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <C : MutableCollection<in Char>> CharArray.filterTo(destination: C, predicate: (Char) -> Boolean): C

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

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.find(predicate: (Char) -> Boolean): Char?

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

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.findLast(predicate: (Char) -> Boolean): Char?

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

Since Kotlin 1.0
Link copied to clipboard

Returns the first element.

Since Kotlin 1.0
inline fun CharArray.first(predicate: (Char) -> Boolean): Char

Returns the first element matching the given predicate.

Since Kotlin 1.0
Link copied to clipboard

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

Since Kotlin 1.0
inline fun CharArray.firstOrNull(predicate: (Char) -> Boolean): Char?

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <R> CharArray.flatMap(transform: (Char) -> 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.

Since Kotlin 1.0
Link copied to clipboard
@JvmName(name = "flatMapIndexedIterable")
inline fun <R> CharArray.flatMapIndexed(transform: (index: Int, Char) -> Iterable<R>): List<R>

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

Since Kotlin 1.4
Link copied to clipboard
@JvmName(name = "flatMapIndexedIterableTo")
inline fun <R, C : MutableCollection<in R>> CharArray.flatMapIndexedTo(destination: C, transform: (index: Int, Char) -> Iterable<R>): C

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

Since Kotlin 1.4
Link copied to clipboard
inline fun <R, C : MutableCollection<in R>> CharArray.flatMapTo(destination: C, transform: (Char) -> Iterable<R>): C

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <R> CharArray.fold(initial: R, operation: (acc: R, Char) -> R): R

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <R> CharArray.foldIndexed(initial: R, operation: (index: Int, acc: R, Char) -> 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.

Since Kotlin 1.0
Link copied to clipboard
inline fun <R> CharArray.foldRight(initial: R, operation: (Char, acc: R) -> R): R

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <R> CharArray.foldRightIndexed(initial: R, operation: (index: Int, Char, 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.

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.forEach(action: (Char) -> Unit)

Performs the given action on each element.

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.forEachIndexed(action: (index: Int, Char) -> Unit)

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

Since Kotlin 1.0
Link copied to clipboard
operator fun get(index: Int): Char

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

Since Kotlin 1.0
operator external fun get(index: Int): Char

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

Since Kotlin 1.3
Link copied to clipboard
inline fun CharArray.getOrElse(index: Int, defaultValue: (Int) -> Char): Char

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.

Since Kotlin 1.0
Link copied to clipboard
fun CharArray.getOrNull(index: Int): Char?

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <K> CharArray.groupBy(keySelector: (Char) -> K): Map<K, List<Char>>

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.

Since Kotlin 1.0
inline fun <K, V> CharArray.groupBy(keySelector: (Char) -> K, valueTransform: (Char) -> 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.

Since Kotlin 1.0
Link copied to clipboard
inline fun <K, M : MutableMap<in K, MutableList<Char>>> CharArray.groupByTo(destination: M, keySelector: (Char) -> 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.

Since Kotlin 1.0
inline fun <K, V, M : MutableMap<in K, MutableList<V>>> CharArray.groupByTo(destination: M, keySelector: (Char) -> K, valueTransform: (Char) -> 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.

Since Kotlin 1.0
Link copied to clipboard
fun CharArray.indexOf(element: Char): Int

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

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.indexOfFirst(predicate: (Char) -> Boolean): Int

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

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.indexOfLast(predicate: (Char) -> Boolean): Int

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

Since Kotlin 1.0
Link copied to clipboard
infix fun CharArray.intersect(other: Iterable<Char>): Set<Char>

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

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.isEmpty(): Boolean

Returns true if the array is empty.

Since Kotlin 1.0
Link copied to clipboard

Returns true if the array is not empty.

Since Kotlin 1.0
Link copied to clipboard
operator fun iterator(): CharIterator

Creates an iterator over the elements of the array.

Since Kotlin 1.0
operator fun iterator(): CharIterator

Creates an iterator over the elements of the array.

Since Kotlin 1.3
Link copied to clipboard
fun <A : Appendable> CharArray.joinTo(buffer: A, separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: (Char) -> CharSequence? = null): A

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

Since Kotlin 1.0
Link copied to clipboard
fun CharArray.joinToString(separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: (Char) -> CharSequence? = null): String

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

Since Kotlin 1.0
Link copied to clipboard

Returns the last element.

Since Kotlin 1.0
inline fun CharArray.last(predicate: (Char) -> Boolean): Char

Returns the last element matching the given predicate.

Since Kotlin 1.0
Link copied to clipboard
fun CharArray.lastIndexOf(element: Char): Int

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

Since Kotlin 1.0
Link copied to clipboard

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

Since Kotlin 1.0
inline fun CharArray.lastOrNull(predicate: (Char) -> Boolean): Char?

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <R> CharArray.map(transform: (Char) -> R): List<R>

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <R> CharArray.mapIndexed(transform: (index: Int, Char) -> 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.

Since Kotlin 1.0
Link copied to clipboard
inline fun <R, C : MutableCollection<in R>> CharArray.mapIndexedTo(destination: C, transform: (index: Int, Char) -> 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.

Since Kotlin 1.0
Link copied to clipboard
inline fun <R, C : MutableCollection<in R>> CharArray.mapTo(destination: C, transform: (Char) -> R): C

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

Since Kotlin 1.0
Link copied to clipboard
@JvmName(name = "maxOrThrow")
fun CharArray.max(): Char

Returns the largest element.

Since Kotlin 1.7
Since Kotlin 1.0
Link copied to clipboard
@JvmName(name = "maxByOrThrow")
inline fun <R : Comparable<R>> CharArray.maxBy(selector: (Char) -> R): Char

Returns the first element yielding the largest value of the given function.

Since Kotlin 1.7
inline fun <R : Comparable<R>> CharArray.maxBy(selector: (Char) -> R): Char?
Since Kotlin 1.0
Link copied to clipboard
inline fun <R : Comparable<R>> CharArray.maxByOrNull(selector: (Char) -> R): Char?

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

Since Kotlin 1.4
Link copied to clipboard
inline fun <R : Comparable<R>> CharArray.maxOf(selector: (Char) -> R): R
inline fun CharArray.maxOf(selector: (Char) -> Double): Double
inline fun CharArray.maxOf(selector: (Char) -> Float): Float

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

Since Kotlin 1.4
Link copied to clipboard
inline fun <R : Comparable<R>> CharArray.maxOfOrNull(selector: (Char) -> R): R?
inline fun CharArray.maxOfOrNull(selector: (Char) -> Double): Double?
inline fun CharArray.maxOfOrNull(selector: (Char) -> Float): Float?

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

Since Kotlin 1.4
Link copied to clipboard
inline fun <R> CharArray.maxOfWith(comparator: Comparator<in R>, selector: (Char) -> R): R

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

Since Kotlin 1.4
Link copied to clipboard
inline fun <R> CharArray.maxOfWithOrNull(comparator: Comparator<in R>, selector: (Char) -> R): R?

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

Since Kotlin 1.4
Link copied to clipboard

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

Since Kotlin 1.4
Link copied to clipboard
@JvmName(name = "maxWithOrThrow")
fun CharArray.maxWith(comparator: Comparator<in Char>): Char

Returns the first element having the largest value according to the provided comparator.

Since Kotlin 1.7
fun CharArray.maxWith(comparator: Comparator<in Char>): Char?
Since Kotlin 1.0
Link copied to clipboard
fun CharArray.maxWithOrNull(comparator: Comparator<in Char>): Char?

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

Since Kotlin 1.4
Link copied to clipboard
@JvmName(name = "minOrThrow")
fun CharArray.min(): Char

Returns the smallest element.

Since Kotlin 1.7
Since Kotlin 1.0
Link copied to clipboard
@JvmName(name = "minByOrThrow")
inline fun <R : Comparable<R>> CharArray.minBy(selector: (Char) -> R): Char

Returns the first element yielding the smallest value of the given function.

Since Kotlin 1.7
inline fun <R : Comparable<R>> CharArray.minBy(selector: (Char) -> R): Char?
Since Kotlin 1.0
Link copied to clipboard
inline fun <R : Comparable<R>> CharArray.minByOrNull(selector: (Char) -> R): Char?

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

Since Kotlin 1.4
Link copied to clipboard
inline fun <R : Comparable<R>> CharArray.minOf(selector: (Char) -> R): R
inline fun CharArray.minOf(selector: (Char) -> Double): Double
inline fun CharArray.minOf(selector: (Char) -> Float): Float

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

Since Kotlin 1.4
Link copied to clipboard
inline fun <R : Comparable<R>> CharArray.minOfOrNull(selector: (Char) -> R): R?
inline fun CharArray.minOfOrNull(selector: (Char) -> Double): Double?
inline fun CharArray.minOfOrNull(selector: (Char) -> Float): Float?

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

Since Kotlin 1.4
Link copied to clipboard
inline fun <R> CharArray.minOfWith(comparator: Comparator<in R>, selector: (Char) -> R): R

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

Since Kotlin 1.4
Link copied to clipboard
inline fun <R> CharArray.minOfWithOrNull(comparator: Comparator<in R>, selector: (Char) -> R): R?

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

Since Kotlin 1.4
Link copied to clipboard

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

Since Kotlin 1.4
Link copied to clipboard
@JvmName(name = "minWithOrThrow")
fun CharArray.minWith(comparator: Comparator<in Char>): Char

Returns the first element having the smallest value according to the provided comparator.

Since Kotlin 1.7
fun CharArray.minWith(comparator: Comparator<in Char>): Char?
Since Kotlin 1.0
Link copied to clipboard
fun CharArray.minWithOrNull(comparator: Comparator<in Char>): Char?

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

Since Kotlin 1.4
Link copied to clipboard

Returns true if the array has no elements.

Since Kotlin 1.0
inline fun CharArray.none(predicate: (Char) -> Boolean): Boolean

Returns true if no elements match the given predicate.

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.onEach(action: (Char) -> Unit): CharArray

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

Since Kotlin 1.4
Link copied to clipboard
inline fun CharArray.onEachIndexed(action: (index: Int, Char) -> Unit): CharArray

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

Since Kotlin 1.4
Link copied to clipboard
inline fun CharArray.partition(predicate: (Char) -> Boolean): Pair<List<Char>, List<Char>>

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.

Since Kotlin 1.0
Link copied to clipboard
expect operator fun CharArray.plus(element: Char): CharArray

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

Since Kotlin 1.0
expect operator fun CharArray.plus(elements: CharArray): CharArray

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

Since Kotlin 1.0
expect operator fun CharArray.plus(elements: Collection<Char>): CharArray

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

Since Kotlin 1.0
actual inline operator fun CharArray.plus(element: Char): CharArray

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

Since Kotlin 1.1
actual inline operator fun CharArray.plus(elements: CharArray): CharArray

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

Since Kotlin 1.1
actual operator fun CharArray.plus(elements: Collection<Char>): CharArray

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

Since Kotlin 1.1
actual operator fun CharArray.plus(element: Char): CharArray

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

Since Kotlin 1.0
actual operator fun CharArray.plus(elements: CharArray): CharArray

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

Since Kotlin 1.0
actual operator fun CharArray.plus(elements: Collection<Char>): CharArray

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

Since Kotlin 1.0
actual operator fun CharArray.plus(element: Char): CharArray

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

Since Kotlin 1.3
actual operator fun CharArray.plus(elements: CharArray): CharArray

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

Since Kotlin 1.3
actual operator fun CharArray.plus(elements: Collection<Char>): CharArray

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

Since Kotlin 1.3
Link copied to clipboard
inline fun CharArray.random(): Char

Returns a random element from this array.

Since Kotlin 1.3
fun CharArray.random(random: Random): Char

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

Since Kotlin 1.3
Link copied to clipboard
inline fun CharArray.randomOrNull(): Char?

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

Since Kotlin 1.4

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

Since Kotlin 1.4
Link copied to clipboard
inline fun CharArray.reduce(operation: (acc: Char, Char) -> Char): Char

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

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.reduceIndexed(operation: (index: Int, acc: Char, Char) -> Char): Char

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.

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.reduceIndexedOrNull(operation: (index: Int, acc: Char, Char) -> Char): Char?

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.

Since Kotlin 1.4
Link copied to clipboard
inline fun CharArray.reduceOrNull(operation: (acc: Char, Char) -> Char): Char?

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

Since Kotlin 1.4
Link copied to clipboard
inline fun CharArray.reduceRight(operation: (Char, acc: Char) -> Char): Char

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

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.reduceRightIndexed(operation: (index: Int, Char, acc: Char) -> Char): Char

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

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.reduceRightIndexedOrNull(operation: (index: Int, Char, acc: Char) -> Char): Char?

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

Since Kotlin 1.4
Link copied to clipboard
inline fun CharArray.reduceRightOrNull(operation: (Char, acc: Char) -> Char): Char?

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

Since Kotlin 1.4
Link copied to clipboard
Since Kotlin 1.3
Link copied to clipboard

Reverses elements in the array in-place.

Since Kotlin 1.0
fun CharArray.reverse(fromIndex: Int, toIndex: Int)

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

Since Kotlin 1.4
Link copied to clipboard

Returns a list with elements in reversed order.

Since Kotlin 1.0
Link copied to clipboard

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <R> CharArray.runningFold(initial: R, operation: (acc: R, Char) -> R): List<R>

Returns a list containing successive accumulation values generated by applying operation from left to right to each element and current accumulator value that starts with initial value.

Since Kotlin 1.4
Link copied to clipboard
inline fun <R> CharArray.runningFoldIndexed(initial: R, operation: (index: Int, acc: R, Char) -> R): List<R>

Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original array and current accumulator value that starts with initial value.

Since Kotlin 1.4
Link copied to clipboard
inline fun CharArray.runningReduce(operation: (acc: Char, Char) -> Char): List<Char>

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.

Since Kotlin 1.4
Link copied to clipboard
inline fun CharArray.runningReduceIndexed(operation: (index: Int, acc: Char, Char) -> Char): List<Char>

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.

Since Kotlin 1.4
Link copied to clipboard
inline fun <R> CharArray.scan(initial: R, operation: (acc: R, Char) -> R): List<R>

Returns a list containing successive accumulation values generated by applying operation from left to right to each element and current accumulator value that starts with initial value.

Since Kotlin 1.4
Link copied to clipboard
inline fun <R> CharArray.scanIndexed(initial: R, operation: (index: Int, acc: R, Char) -> R): List<R>

Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original array and current accumulator value that starts with initial value.

Since Kotlin 1.4
Link copied to clipboard
operator fun set(index: Int, value: Char)

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

Since Kotlin 1.0
operator external fun set(index: Int, value: Char)

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

Since Kotlin 1.3
Link copied to clipboard

Randomly shuffles elements in this array in-place.

Since Kotlin 1.4
fun CharArray.shuffle(random: Random)

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

Since Kotlin 1.4
Link copied to clipboard

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

Since Kotlin 1.0
inline fun CharArray.single(predicate: (Char) -> Boolean): Char

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

Since Kotlin 1.0
Link copied to clipboard

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

Since Kotlin 1.0
inline fun CharArray.singleOrNull(predicate: (Char) -> Boolean): Char?

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

Since Kotlin 1.0
Link copied to clipboard
fun CharArray.slice(indices: Iterable<Int>): List<Char>

Returns a list containing elements at specified indices.

Since Kotlin 1.0
fun CharArray.slice(indices: IntRange): List<Char>

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

Since Kotlin 1.0
Link copied to clipboard

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

Since Kotlin 1.0

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

Since Kotlin 1.0
Link copied to clipboard
expect fun CharArray.sort()

Sorts the array in-place.

Since Kotlin 1.0
expect fun CharArray.sort(fromIndex: Int = 0, toIndex: Int = size)

Sorts a range in the array in-place.

Since Kotlin 1.4
actual fun CharArray.sort()

Sorts the array in-place.

Since Kotlin 1.1
inline fun CharArray.sort(noinline comparison: (a: Char, b: Char) -> Int)

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

Since Kotlin 1.1
actual fun CharArray.sort(fromIndex: Int = 0, toIndex: Int = size)

Sorts a range in the array in-place.

Since Kotlin 1.4
actual fun CharArray.sort()

Sorts the array in-place.

Since Kotlin 1.0
actual fun CharArray.sort(fromIndex: Int = 0, toIndex: Int = size)

Sorts a range in the array in-place.

Since Kotlin 1.0
actual fun CharArray.sort()

Sorts the array in-place.

Since Kotlin 1.3
actual fun CharArray.sort(fromIndex: Int = 0, toIndex: Int = size)

Sorts a range in the array in-place.

Since Kotlin 1.4
Link copied to clipboard

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

Since Kotlin 1.0
fun CharArray.sortDescending(fromIndex: Int, toIndex: Int)

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

Since Kotlin 1.4
Link copied to clipboard

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

Since Kotlin 1.0
Link copied to clipboard

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

Since Kotlin 1.0
Link copied to clipboard

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <R : Comparable<R>> CharArray.sortedBy(crossinline selector: (Char) -> R?): List<Char>

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

Since Kotlin 1.0
Link copied to clipboard
inline fun <R : Comparable<R>> CharArray.sortedByDescending(crossinline selector: (Char) -> R?): List<Char>

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

Since Kotlin 1.0
Link copied to clipboard

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

Since Kotlin 1.0
Link copied to clipboard
fun CharArray.sortedWith(comparator: Comparator<in Char>): List<Char>

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

Since Kotlin 1.0
Link copied to clipboard
infix fun CharArray.subtract(other: Iterable<Char>): Set<Char>

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

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.sumBy(selector: (Char) -> Int): Int

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

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.sumByDouble(selector: (Char) -> Double): Double

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

Since Kotlin 1.0
Link copied to clipboard
@JvmName(name = "sumOfDouble")
inline fun CharArray.sumOf(selector: (Char) -> Double): Double
@JvmName(name = "sumOfInt")
inline fun CharArray.sumOf(selector: (Char) -> Int): Int
@JvmName(name = "sumOfLong")
inline fun CharArray.sumOf(selector: (Char) -> Long): Long

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

Since Kotlin 1.4
@JvmName(name = "sumOfUInt")
inline fun CharArray.sumOf(selector: (Char) -> UInt): UInt
@JvmName(name = "sumOfULong")
inline fun CharArray.sumOf(selector: (Char) -> ULong): ULong

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

Since Kotlin 1.5
@JvmName(name = "sumOfBigDecimal")
inline fun CharArray.sumOf(selector: (Char) -> BigDecimal): BigDecimal
@JvmName(name = "sumOfBigInteger")
inline fun CharArray.sumOf(selector: (Char) -> BigInteger): BigInteger

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

Since Kotlin 1.4
Link copied to clipboard

Returns a list containing first n elements.

Since Kotlin 1.0
Link copied to clipboard

Returns a list containing last n elements.

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.takeLastWhile(predicate: (Char) -> Boolean): List<Char>

Returns a list containing last elements satisfying the given predicate.

Since Kotlin 1.0
Link copied to clipboard
inline fun CharArray.takeWhile(predicate: (Char) -> Boolean): List<Char>

Returns a list containing first elements satisfying the given predicate.

Since Kotlin 1.0
Link copied to clipboard
fun <C : MutableCollection<in Char>> CharArray.toCollection(destination: C): C

Appends all elements to the given destination collection.

Since Kotlin 1.0
Link copied to clipboard

Returns a new HashSet of all elements.

Since Kotlin 1.0
Link copied to clipboard

Returns a List containing all elements.

Since Kotlin 1.0
Link copied to clipboard

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

Since Kotlin 1.0
Link copied to clipboard

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

Since Kotlin 1.0
Link copied to clipboard

Returns a Set of all elements.

Since Kotlin 1.0
Link copied to clipboard

Returns a new SortedSet of all elements.

Since Kotlin 1.0
Link copied to clipboard

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

Since Kotlin 1.0

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

Since Kotlin 1.1

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

Since Kotlin 1.0

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

Since Kotlin 1.3
Link copied to clipboard
infix fun CharArray.union(other: Iterable<Char>): Set<Char>

Returns a set containing all distinct elements from both collections.

Since Kotlin 1.0
Link copied to clipboard

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.

Since Kotlin 1.0
Link copied to clipboard
infix fun <R> CharArray.zip(other: Array<out R>): List<Pair<Char, R>>
infix fun CharArray.zip(other: CharArray): List<Pair<Char, Char>>

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.

Since Kotlin 1.0
infix fun <R> CharArray.zip(other: Iterable<R>): List<Pair<Char, 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.

Since Kotlin 1.0
inline fun <R, V> CharArray.zip(other: Array<out R>, transform: (a: Char, 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.

Since Kotlin 1.0
inline fun <V> CharArray.zip(other: CharArray, transform: (a: Char, b: Char) -> 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.

Since Kotlin 1.0
inline fun <R, V> CharArray.zip(other: Iterable<R>, transform: (a: Char, 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.

Since Kotlin 1.0