kotlin-stdlib/kotlin/CharArray

CharArray

class CharArray(size: Int)

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

class CharArray(size: Int)

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

class CharArray

An array of chars.

Constructors

CharArray

fun CharArray(size: Int, init: (Int) -> Char)

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

fun CharArray(size: Int, init: (Int) -> Char)

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

fun CharArray(size: Int, init: (Int) -> Char)

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

CharArray

fun CharArray(size: Int)

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

fun CharArray(size: Int)

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

fun CharArray(size: Int)

Functions

get

operator fun get(index: Int): Char

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

operator fun get(index: Int): Char

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

operator external fun get(index: Int): Char

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

iterator

operator fun iterator(): CharIterator

Creates an iterator over the elements of the array.

operator fun iterator(): CharIterator

Creates an iterator over the elements of the array.

operator fun iterator(): CharIterator

Creates an iterator over the elements of the array.

set

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.

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.

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.

Properties

size

val size: Int

Returns the number of elements in the array.

val size: Int

Returns the number of elements in the array.

val size: Int

Returns the number of elements in the array.

Extensions

all

inline fun CharArray.all(predicate: (Char) -> Boolean): Boolean

Returns true if all elements match the given predicate.

any

fun CharArray.any(): Boolean

Returns true if array has at least one element.

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

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

asIterable

fun CharArray.asIterable(): Iterable<Char>

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

asList

expect fun CharArray.asList(): List<Char>

Returns a List that wraps the original array.

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

Returns a List that wraps the original array.

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

Returns a List that wraps the original array.

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

Returns a List that wraps the original array.

asSequence

fun CharArray.asSequence(): Sequence<Char>

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

associate

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.

associateBy

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.

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.

associateByTo

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.

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.

associateTo

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.

associateWith

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.

associateWithTo

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.

binarySearch

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.

component1

inline operator fun CharArray.component1(): Char

Returns 1st element from the array.

component2

inline operator fun CharArray.component2(): Char

Returns 2nd element from the array.

component3

inline operator fun CharArray.component3(): Char

Returns 3rd element from the array.

component4

inline operator fun CharArray.component4(): Char

Returns 4th element from the array.

component5

inline operator fun CharArray.component5(): Char

Returns 5th element from the array.

concatToString

expect fun CharArray.concatToString(): String

Concatenates characters in this CharArray into a String.

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

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

actual fun CharArray.concatToString(): String

Concatenates characters in this CharArray into a String.

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

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

actual fun CharArray.concatToString(): String

Concatenates characters in this CharArray into a String.

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

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

actual fun CharArray.concatToString(): String

Concatenates characters in this CharArray into a String.

actual fun CharArray.concatToString(startIndex: Int, endIndex: Int): String

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

contains

operator fun CharArray.contains(element: Char): Boolean

Returns true if element is found in the array.

contentEquals

expect infix fun CharArray.~~contentEquals~~(other: CharArray): Boolean

expect infix fun CharArray?.contentEquals(other: CharArray?): Boolean

expect infix fun CharArray.~~contentEquals~~(other: CharArray): Boolean

expect infix fun CharArray?.contentEquals(other: CharArray?): Boolean

expect infix fun CharArray.~~contentEquals~~(other: CharArray): Boolean

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.

actual infix inline fun CharArray.~~contentEquals~~(other: CharArray): Boolean

@JvmName(name = "contentEqualsNullable")

actual infix inline fun CharArray?.contentEquals(other: CharArray?): Boolean

actual infix inline fun CharArray.~~contentEquals~~(other: CharArray): Boolean

@JvmName(name = "contentEqualsNullable")

actual infix inline fun CharArray?.contentEquals(other: CharArray?): Boolean

actual infix inline fun CharArray.~~contentEquals~~(other: CharArray): Boolean

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

actual infix fun CharArray.~~contentEquals~~(other: CharArray): Boolean

actual infix fun CharArray?.contentEquals(other: CharArray?): Boolean

actual infix fun CharArray.~~contentEquals~~(other: CharArray): Boolean

actual infix fun CharArray?.contentEquals(other: CharArray?): Boolean

actual infix fun CharArray.~~contentEquals~~(other: CharArray): Boolean

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.

actual infix fun CharArray.~~contentEquals~~(other: CharArray): Boolean

actual infix fun CharArray?.contentEquals(other: CharArray?): Boolean

actual infix fun CharArray.~~contentEquals~~(other: CharArray): Boolean

actual infix fun CharArray?.contentEquals(other: CharArray?): Boolean

actual infix fun CharArray.~~contentEquals~~(other: CharArray): Boolean

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.

contentHashCode

expect fun CharArray.~~contentHashCode~~(): Int

expect fun CharArray?.contentHashCode(): Int

expect fun CharArray.~~contentHashCode~~(): Int

expect fun CharArray?.contentHashCode(): Int

expect fun CharArray.~~contentHashCode~~(): Int

expect fun CharArray?.contentHashCode(): Int

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

actual inline fun CharArray.~~contentHashCode~~(): Int

@JvmName(name = "contentHashCodeNullable")

actual inline fun CharArray?.contentHashCode(): Int

actual inline fun CharArray.~~contentHashCode~~(): Int

@JvmName(name = "contentHashCodeNullable")

actual inline fun CharArray?.contentHashCode(): Int

actual inline fun CharArray.~~contentHashCode~~(): Int

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

actual fun CharArray.~~contentHashCode~~(): Int

actual fun CharArray?.contentHashCode(): Int

actual fun CharArray.~~contentHashCode~~(): Int

actual fun CharArray?.contentHashCode(): Int

actual fun CharArray.~~contentHashCode~~(): Int

actual fun CharArray?.contentHashCode(): Int

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

actual fun CharArray.~~contentHashCode~~(): Int

actual fun CharArray?.contentHashCode(): Int

actual fun CharArray.~~contentHashCode~~(): Int

actual fun CharArray?.contentHashCode(): Int

actual fun CharArray.~~contentHashCode~~(): Int

actual fun CharArray?.contentHashCode(): Int

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

contentToString

expect fun CharArray.~~contentToString~~(): String

expect fun CharArray?.contentToString(): String

expect fun CharArray.~~contentToString~~(): String

expect fun CharArray?.contentToString(): String

expect fun CharArray.~~contentToString~~(): String

expect fun CharArray?.contentToString(): String

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

actual inline fun CharArray.~~contentToString~~(): String

@JvmName(name = "contentToStringNullable")

actual inline fun CharArray?.contentToString(): String

actual inline fun CharArray.~~contentToString~~(): String

@JvmName(name = "contentToStringNullable")

actual inline fun CharArray?.contentToString(): String

actual inline fun CharArray.~~contentToString~~(): String

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

actual fun CharArray.~~contentToString~~(): String

actual fun CharArray?.contentToString(): String

actual fun CharArray.~~contentToString~~(): String

actual fun CharArray?.contentToString(): String

actual fun CharArray.~~contentToString~~(): String

actual fun CharArray?.contentToString(): String

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

actual fun CharArray.~~contentToString~~(): String

actual fun CharArray?.contentToString(): String

actual fun CharArray.~~contentToString~~(): String

actual fun CharArray?.contentToString(): String

actual fun CharArray.~~contentToString~~(): String

actual fun CharArray?.contentToString(): String

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

copyInto

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.

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.

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.

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.

copyOf

expect fun CharArray.copyOf(): CharArray

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

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.

actual inline fun CharArray.copyOf(): CharArray

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

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.

actual fun CharArray.copyOf(): CharArray

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

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.

actual fun CharArray.copyOf(): CharArray

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

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.

copyOfRange

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.

@JvmName(name = "copyOfRangeInline")

actual inline fun CharArray.copyOfRange(fromIndex: Int, toIndex: Int): CharArray

@JvmName(name = "copyOfRangeInline")

actual inline fun CharArray.copyOfRange(fromIndex: Int, toIndex: Int): CharArray

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

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.

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.

count

inline fun CharArray.count(): Int

Returns the number of elements in this array.

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

Returns the number of elements matching the given predicate.

distinct

fun CharArray.distinct(): List<Char>

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

distinctBy

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.

drop

fun CharArray.drop(n: Int): List<Char>

Returns a list containing all elements except first n elements.

dropLast

fun CharArray.dropLast(n: Int): List<Char>

Returns a list containing all elements except last n elements.

dropLastWhile

inline fun CharArray.dropLastWhile(predicate: (Char) -> Boolean): List<Char>

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

dropWhile

inline fun CharArray.dropWhile(predicate: (Char) -> Boolean): List<Char>

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

elementAt

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.

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.

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.

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.

elementAtOrElse

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.

elementAtOrNull

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.

fill

expect fun CharArray.fill( element: Char, fromIndex: Int = 0, toIndex: Int = size)

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

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

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

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

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

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

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

filter

inline fun CharArray.filter(predicate: (Char) -> Boolean): List<Char>

Returns a list containing only elements matching the given predicate.

filterIndexed

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

Returns a list containing only elements matching the given predicate.

filterIndexedTo

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.

filterNot

inline fun CharArray.filterNot(predicate: (Char) -> Boolean): List<Char>

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

filterNotTo

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.

filterTo

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.

find

inline fun CharArray.find(predicate: (Char) -> Boolean): Char?

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

findLast

inline fun CharArray.findLast(predicate: (Char) -> Boolean): Char?

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

first

fun CharArray.first(): Char

Returns first element.

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

Returns the first element matching the given predicate.

firstOrNull

fun CharArray.firstOrNull(): Char?

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

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

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

flatMap

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.

flatMapIndexed

@JvmName(name = "flatMapIndexedIterable")

inline fun <R> CharArray.flatMapIndexed(transform: (index: Int, Char) -> Iterable<R>): List<R>

@JvmName(name = "flatMapIndexedIterable")

inline fun <R> CharArray.flatMapIndexed(transform: (index: Int, Char) -> Iterable<R>): List<R>

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

flatMapIndexedTo

@JvmName(name = "flatMapIndexedIterableTo")

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

@JvmName(name = "flatMapIndexedIterableTo")

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

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

flatMapTo

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.

fold

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.

foldIndexed

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.

foldRight

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.

foldRightIndexed

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.

forEach

inline fun CharArray.forEach(action: (Char) -> Unit)

Performs the given action on each element.

forEachIndexed

inline fun CharArray.forEachIndexed(action: (index: Int, Char) -> Unit)

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

getOrElse

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.

getOrNull

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.

groupBy

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.

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.

groupByTo

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.

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.

indexOf

fun CharArray.indexOf(element: Char): Int

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

indexOfFirst

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.

indexOfLast

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.

indices

val CharArray.indices: IntRange

Returns the range of valid indices for the array.

intersect

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.

isEmpty

inline fun CharArray.isEmpty(): Boolean

Returns true if the array is empty.

isNotEmpty

inline fun CharArray.isNotEmpty(): Boolean

Returns true if the array is not empty.

joinTo

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.

joinToString

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.

last

fun CharArray.last(): Char

Returns the last element.

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

Returns the last element matching the given predicate.

lastIndex

val CharArray.lastIndex: Int

Returns the last valid index for the array.

lastIndexOf

fun CharArray.lastIndexOf(element: Char): Int

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

lastOrNull

fun CharArray.lastOrNull(): Char?

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

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

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

map

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.

mapIndexed

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.

mapIndexedTo

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.

mapTo

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.

max

fun CharArray.~~max~~(): Char?

maxBy

inline fun <R : Comparable<R>> CharArray.~~maxBy~~(selector: (Char) -> R): Char?

maxByOrNull

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.

maxOf

inline fun CharArray.maxOf(selector: (Char) -> Double): Double

inline fun CharArray.maxOf(selector: (Char) -> Float): Float

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

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

inline fun <R : Comparable<R>> CharArray.maxOf(selector: (Char) -> R): R

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

maxOfOrNull

inline fun CharArray.maxOfOrNull(selector: (Char) -> Double): Double?

inline fun CharArray.maxOfOrNull(selector: (Char) -> Float): Float?

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?

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?

inline fun <R : Comparable<R>> CharArray.maxOfOrNull(selector: (Char) -> R): R?

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

maxOfWith

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.

maxOfWithOrNull

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.

maxOrNull

fun CharArray.maxOrNull(): Char?

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

maxWith

fun CharArray.~~maxWith~~(comparator: Comparator<in Char>): Char?

maxWithOrNull

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.

min

fun CharArray.~~min~~(): Char?

minBy

inline fun <R : Comparable<R>> CharArray.~~minBy~~(selector: (Char) -> R): Char?

minByOrNull

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.

minOf

inline fun CharArray.minOf(selector: (Char) -> Double): Double

inline fun CharArray.minOf(selector: (Char) -> Float): Float

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

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

inline fun <R : Comparable<R>> CharArray.minOf(selector: (Char) -> R): R

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

minOfOrNull

inline fun CharArray.minOfOrNull(selector: (Char) -> Double): Double?

inline fun CharArray.minOfOrNull(selector: (Char) -> Float): Float?

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?

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?

inline fun <R : Comparable<R>> CharArray.minOfOrNull(selector: (Char) -> R): R?

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

minOfWith

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.

minOfWithOrNull

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.

minOrNull

fun CharArray.minOrNull(): Char?

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

minWith

fun CharArray.~~minWith~~(comparator: Comparator<in Char>): Char?

minWithOrNull

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.

none

fun CharArray.none(): Boolean

Returns true if the array has no elements.

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

Returns true if no elements match the given predicate.

onEach

inline fun CharArray.onEach(action: (Char) -> Unit): CharArray

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

onEachIndexed

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.

partition

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.

plus

expect operator fun CharArray.plus(element: Char): CharArray

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

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.

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.

actual operator fun CharArray.plus(element: Char): CharArray

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

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.

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.

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

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

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.

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.

actual operator fun CharArray.plus(element: Char): CharArray

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

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.

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.

random

inline fun CharArray.random(): Char

Returns a random element from this array.

fun CharArray.random(random: Random): Char

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

randomOrNull

inline fun CharArray.randomOrNull(): Char?

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

fun CharArray.randomOrNull(random: Random): Char?

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

reduce

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.

reduceIndexed

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.

reduceIndexedOrNull

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.

reduceOrNull

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.

reduceRight

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.

reduceRightIndexed

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.

reduceRightIndexedOrNull

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.

reduceRightOrNull

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.

refTo

fun CharArray.refTo(index: Int): CValuesRef<COpaque>

reverse

fun CharArray.reverse()

Reverses elements in the array in-place.

fun CharArray.reverse(fromIndex: Int, toIndex: Int)

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

reversed

fun CharArray.reversed(): List<Char>

Returns a list with elements in reversed order.

reversedArray

fun CharArray.reversedArray(): CharArray

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

runningFold

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.

runningFoldIndexed

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.

runningReduce

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.

runningReduceIndexed

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

scan

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.

scanIndexed

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

shuffle

fun CharArray.shuffle()

Randomly shuffles elements in this array in-place.

fun CharArray.shuffle(random: Random)

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

single

fun CharArray.single(): Char

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

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.

singleOrNull

fun CharArray.singleOrNull(): Char?

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

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.

slice

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

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

fun CharArray.slice(indices: Iterable<Int>): List<Char>

Returns a list containing elements at specified indices.

sliceArray

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

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

fun CharArray.sliceArray(indices: IntRange): CharArray

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

sort

expect fun CharArray.sort()

Sorts the array in-place.

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

Sorts a range in the array in-place.

actual fun CharArray.sort()

Sorts the array in-place.

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

Sorts a range in the array in-place.

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.

actual fun CharArray.sort()

Sorts the array in-place.

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

Sorts a range in the array in-place.

actual fun CharArray.sort()

Sorts the array in-place.

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

Sorts a range in the array in-place.

sortDescending

fun CharArray.sortDescending()

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

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.

sorted

fun CharArray.sorted(): List<Char>

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

sortedArray

fun CharArray.sortedArray(): CharArray

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

sortedArrayDescending

fun CharArray.sortedArrayDescending(): CharArray

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

sortedBy

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.

sortedByDescending

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.

sortedDescending

fun CharArray.sortedDescending(): List<Char>

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

sortedWith

fun CharArray.sortedWith(comparator: Comparator<in Char>): List<Char>

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

subtract

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.

sumBy

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.

sumByDouble

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.

sumOf

@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

@JvmName(name = "sumOfUInt")

inline fun CharArray.sumOf(selector: (Char) -> UInt): UInt

@JvmName(name = "sumOfULong")

inline fun CharArray.sumOf(selector: (Char) -> ULong): ULong

@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

@JvmName(name = "sumOfUInt")

inline fun CharArray.sumOf(selector: (Char) -> UInt): UInt

@JvmName(name = "sumOfULong")

inline fun CharArray.sumOf(selector: (Char) -> ULong): ULong

@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

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

@JvmName(name = "sumOfBigDecimal")

inline fun CharArray.sumOf(selector: (Char) -> BigDecimal): BigDecimal

@JvmName(name = "sumOfBigInteger")

inline fun CharArray.sumOf(selector: (Char) -> BigInteger): BigInteger

@JvmName(name = "sumOfBigDecimal")

inline fun CharArray.sumOf(selector: (Char) -> BigDecimal): BigDecimal

@JvmName(name = "sumOfBigInteger")

inline fun CharArray.sumOf(selector: (Char) -> BigInteger): BigInteger

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

take

fun CharArray.take(n: Int): List<Char>

Returns a list containing first n elements.

takeLast

fun CharArray.takeLast(n: Int): List<Char>

Returns a list containing last n elements.

takeLastWhile

inline fun CharArray.takeLastWhile(predicate: (Char) -> Boolean): List<Char>

Returns a list containing last elements satisfying the given predicate.

takeWhile

inline fun CharArray.takeWhile(predicate: (Char) -> Boolean): List<Char>

Returns a list containing first elements satisfying the given predicate.

toCollection

fun <C : MutableCollection<in Char>> CharArray.toCollection(destination: C): C

Appends all elements to the given destination collection.

toHashSet

fun CharArray.toHashSet(): HashSet<Char>

Returns a new HashSet of all elements.

toList

fun CharArray.toList(): List<Char>

Returns a List containing all elements.

toMutableList

fun CharArray.toMutableList(): MutableList<Char>

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

toMutableSet

fun CharArray.toMutableSet(): MutableSet<Char>

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

toSet

fun CharArray.toSet(): Set<Char>

Returns a Set of all elements.

toSortedSet

fun CharArray.toSortedSet(): SortedSet<Char>

Returns a new SortedSet of all elements.

toTypedArray

expect fun CharArray.toTypedArray(): Array<Char>

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

actual fun CharArray.toTypedArray(): Array<Char>

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

actual fun CharArray.toTypedArray(): Array<Char>

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

actual fun CharArray.toTypedArray(): Array<Char>

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

union

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

Returns a set containing all distinct elements from both collections.

withIndex

fun CharArray.withIndex(): Iterable<IndexedValue<Char>>

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.

zip

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

infix fun CharArray.zip(other: CharArray): List<Pair<Char, Char>>

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

infix fun CharArray.zip(other: CharArray): List<Pair<Char, Char>>

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.

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.

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.

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.

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