class CharArray
An array of chars. When targeting the JVM, instances of this class are represented as char[]
.
An array of chars.
Creates a new array of the specified size, where each element is calculated by calling the specified init function.
<init>(size: Int, init: (Int) -> Char)
Creates a new array of the specified size, with all elements initialized to null char (`\u0000').
<init>(size: Int)
Returns the number of elements in the array.
val size: Int
Returns the array element at the given index. This method can be called using the index operator.
operator fun get(index: Int): Char
Creates an iterator over the elements of the array.
operator fun iterator(): CharIterator
Returns the range of valid indices for the array.
val CharArray.indices: IntRange
Returns the last valid index for the array.
val CharArray.lastIndex: Int
Returns true
if all elements match the given predicate.
fun CharArray.all(predicate: (Char) -> Boolean): Boolean
Returns true
if array has at least one element.
fun CharArray.any(): Boolean
Returns true
if at least one element matches the given predicate.
fun CharArray.any(predicate: (Char) -> Boolean): Boolean
Creates an Iterable instance that wraps the original array returning its elements when being iterated.
fun CharArray.asIterable(): Iterable<Char>
Creates a Sequence instance that wraps the original array returning its elements when being iterated.
fun CharArray.asSequence(): Sequence<Char>
Returns a Map containing the elements from the given array indexed by the key returned from keySelector function applied to each element.
fun <K> CharArray.associateBy( keySelector: (Char) -> K ): Map<K, Char>
Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to elements of the given array.
fun <K, V> CharArray.associateBy( keySelector: (Char) -> K, valueTransform: (Char) -> V ): Map<K, V>
Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function applied to each element of the given array and value is the element itself.
fun <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 and and value is provided by the valueTransform function applied to elements of the given array.
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 provided by transform function applied to each element of the given array.
fun <K, V, M : MutableMap<in K, in V>> CharArray.associateTo( destination: M, transform: (Char) -> Pair<K, V> ): M
Returns a Map where keys are elements from the given array and values are produced by the valueSelector function applied to each element.
fun <V> CharArray.associateWith( valueSelector: (Char) -> V ): Map<Char, V>
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.
fun <V, M : MutableMap<in Char, in V>> CharArray.associateWithTo( destination: M, valueSelector: (Char) -> V ): M
Searches the array or the range of the array for the provided element using the binary search algorithm. The array is expected to be sorted, otherwise the result is undefined.
fun CharArray.binarySearch( element: Char, fromIndex: Int = 0, toIndex: Int = size ): Int
Returns 1st element from the array.
operator fun CharArray.component1(): Char
Returns 2nd element from the array.
operator fun CharArray.component2(): Char
Returns 3rd element from the array.
operator fun CharArray.component3(): Char
Returns 4th element from the array.
operator fun CharArray.component4(): Char
Returns 5th element from the array.
operator fun CharArray.component5(): Char
Returns true
if element is found in the array.
operator fun CharArray.contains(element: Char): Boolean
Returns the number of elements in this array.
fun CharArray.count(): Int
Returns the number of elements matching the given predicate.
fun CharArray.count(predicate: (Char) -> Boolean): Int
Returns a list containing only distinct elements from the given array.
fun CharArray.distinct(): List<Char>
Returns a list containing only elements from the given array having distinct keys returned by the given selector function.
fun <K> CharArray.distinctBy( selector: (Char) -> K ): List<Char>
Returns a list containing all elements except first n elements.
fun CharArray.drop(n: Int): List<Char>
Returns a list containing all elements except last n elements.
fun CharArray.dropLast(n: Int): List<Char>
Returns a list containing all elements except last elements that satisfy the given predicate.
fun CharArray.dropLastWhile( predicate: (Char) -> Boolean ): List<Char>
Returns a list containing all elements except first elements that satisfy the given predicate.
fun CharArray.dropWhile( predicate: (Char) -> Boolean ): List<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.
fun CharArray.elementAtOrElse( index: Int, defaultValue: (Int) -> Char ): Char
Returns a list containing only elements matching the given predicate.
fun CharArray.filter( predicate: (Char) -> Boolean ): List<Char>
Returns a list containing only elements matching the given predicate.
fun CharArray.filterIndexed( predicate: (index: Int, Char) -> Boolean ): List<Char>
Appends all elements matching the given predicate to the given destination.
fun <C : MutableCollection<in Char>> CharArray.filterIndexedTo( destination: C, predicate: (index: Int, Char) -> Boolean ): C
Returns a list containing all elements not matching the given predicate.
fun CharArray.filterNot( predicate: (Char) -> Boolean ): List<Char>
Appends all elements not matching the given predicate to the given destination.
fun <C : MutableCollection<in Char>> CharArray.filterNotTo( destination: C, predicate: (Char) -> Boolean ): C
Appends all elements matching the given predicate to the given destination.
fun <C : MutableCollection<in Char>> CharArray.filterTo( destination: C, predicate: (Char) -> Boolean ): C
Returns the first element matching the given predicate, or null
if no such element was found.
fun CharArray.find(predicate: (Char) -> Boolean): Char?
Returns the last element matching the given predicate, or null
if no such element was found.
fun CharArray.findLast(predicate: (Char) -> Boolean): Char?
Returns first element.
fun CharArray.first(): Char
Returns the first element matching the given predicate.
fun CharArray.first(predicate: (Char) -> Boolean): Char
Returns the first element, or null
if the array is empty.
fun CharArray.firstOrNull(): Char?
Returns the first element matching the given predicate, or null
if element was not found.
fun CharArray.firstOrNull( predicate: (Char) -> Boolean ): Char?
Returns a single list of all elements yielded from results of transform function being invoked on each element of original array.
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 and its index in the original array.
fun <R> CharArray.flatMapIndexed( transform: (index: Int, Char) -> Iterable<R> ): List<R>
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.
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 of original array, to the given destination.
fun <R, C : MutableCollection<in R>> CharArray.flatMapTo( destination: C, transform: (Char) -> Iterable<R> ): C
Performs the given action on each element.
fun CharArray.forEach(action: (Char) -> Unit)
Performs the given action on each element, providing sequential index with the element.
fun CharArray.forEachIndexed( action: (index: Int, Char) -> Unit)
Returns an element at the given index or the result of calling the defaultValue function if the index is out of bounds of this array.
fun CharArray.getOrElse( index: Int, defaultValue: (Int) -> Char ): 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.
fun <K> CharArray.groupBy( keySelector: (Char) -> K ): Map<K, List<Char>>
Groups values returned by the valueTransform function applied to each element of the original array by the key returned by the given keySelector function applied to the element and returns a map where each group key is associated with a list of corresponding values.
fun <K, V> CharArray.groupBy( keySelector: (Char) -> K, valueTransform: (Char) -> V ): Map<K, List<V>>
Groups elements of the original array by the key returned by the given keySelector function applied to each element and puts to the destination map each group key associated with a list of corresponding elements.
fun <K, M : MutableMap<in K, MutableList<Char>>> CharArray.groupByTo( destination: M, keySelector: (Char) -> K ): M
Groups values returned by the valueTransform function applied to each element of the original array by the key returned by the given keySelector function applied to the element and puts to the destination map each group key associated with a list of corresponding values.
fun <K, V, M : MutableMap<in K, MutableList<V>>> CharArray.groupByTo( destination: M, keySelector: (Char) -> K, valueTransform: (Char) -> V ): M
Returns first index of element, or -1 if the array does not contain element.
fun CharArray.indexOf(element: Char): Int
Returns index of the first element matching the given predicate, or -1 if the array does not contain such element.
fun CharArray.indexOfFirst(predicate: (Char) -> Boolean): Int
Returns index of the last element matching the given predicate, or -1 if the array does not contain such element.
fun CharArray.indexOfLast(predicate: (Char) -> Boolean): Int
Returns a set containing all elements that are contained by both this array and the specified collection.
infix fun CharArray.intersect( other: Iterable<Char> ): Set<Char>
Returns true
if the array is empty.
fun CharArray.isEmpty(): Boolean
Returns true
if the array is not empty.
fun CharArray.isNotEmpty(): Boolean
Appends the string from all the elements separated using separator and using the given prefix and postfix if supplied.
fun <A : Appendable> CharArray.joinTo( buffer: A, separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: ((Char) -> CharSequence)? = null ): A
Creates a string from all the elements separated using separator and using the given prefix and postfix if supplied.
fun CharArray.joinToString( separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: ((Char) -> CharSequence)? = null ): String
Returns the last element.
fun CharArray.last(): Char
Returns the last element matching the given predicate.
fun CharArray.last(predicate: (Char) -> Boolean): Char
Returns last index of element, or -1 if the array does not contain element.
fun CharArray.lastIndexOf(element: Char): Int
Returns the last element, or null
if the array is empty.
fun CharArray.lastOrNull(): Char?
Returns the last element matching the given predicate, or null
if no such element was found.
fun CharArray.lastOrNull(predicate: (Char) -> Boolean): Char?
Returns a list containing the results of applying the given transform function to each element in the original array.
fun <R> CharArray.map(transform: (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.
fun <R> CharArray.mapIndexed( transform: (index: Int, Char) -> R ): List<R>
Applies the given transform function to each element and its index in the original array and appends the results to the given destination.
fun <R, C : MutableCollection<in R>> CharArray.mapIndexedTo( destination: C, transform: (index: Int, Char) -> R ): C
Applies the given transform function to each element of the original array and appends the results to the given destination.
fun <R, C : MutableCollection<in R>> CharArray.mapTo( destination: C, transform: (Char) -> R ): C
fun CharArray.max(): Char?
fun <R : Comparable<R>> CharArray.maxBy( selector: (Char) -> R ): Char?
Returns the first element yielding the largest value of the given function or null
if there are no elements.
fun <R : Comparable<R>> CharArray.maxByOrNull( selector: (Char) -> R ): Char?
Returns the largest value among all values produced by selector function applied to each element in the array.
fun <R : Comparable<R>> any_array<R>.maxOf( 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.
fun <R : Comparable<R>> any_array<R>.maxOfOrNull( 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.
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 or null
if there are no elements.
fun <R> CharArray.maxOfWithOrNull( comparator: Comparator<in R>, selector: (Char) -> R ): R?
Returns the largest element or null
if there are no elements.
fun CharArray.maxOrNull(): Char?
fun CharArray.maxWith(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.
fun CharArray.maxWithOrNull( comparator: Comparator<in Char> ): Char?
fun CharArray.min(): Char?
fun <R : Comparable<R>> CharArray.minBy( selector: (Char) -> R ): Char?
Returns the first element yielding the smallest value of the given function or null
if there are no elements.
fun <R : Comparable<R>> CharArray.minByOrNull( selector: (Char) -> R ): Char?
Returns the smallest value among all values produced by selector function applied to each element in the array.
fun <R : Comparable<R>> any_array<R>.minOf( 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.
fun <R : Comparable<R>> any_array<R>.minOfOrNull( 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.
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 or null
if there are no elements.
fun <R> CharArray.minOfWithOrNull( comparator: Comparator<in R>, selector: (Char) -> R ): R?
Returns the smallest element or null
if there are no elements.
fun CharArray.minOrNull(): Char?
fun CharArray.minWith(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.
fun CharArray.minWithOrNull( comparator: Comparator<in Char> ): Char?
Returns true
if the array has no elements.
fun CharArray.none(): Boolean
Returns true
if no elements match the given predicate.
fun CharArray.none(predicate: (Char) -> Boolean): Boolean
Performs the given action on each element and returns the array itself afterwards.
fun CharArray.onEach(action: (Char) -> Unit): CharArray
Performs the given action on each element, providing sequential index with the element, and returns the array itself afterwards.
fun CharArray.onEachIndexed( action: (index: Int, Char) -> Unit ): CharArray
Returns a random element from this array.
fun CharArray.random(): Char
Returns a random element from this array using the specified source of randomness.
fun CharArray.random(random: Random): Char
Returns a random element from this array, or null
if this array is empty.
fun CharArray.randomOrNull(): Char?
Returns a random element from this array using the specified source of randomness, or null
if this array is empty.
fun CharArray.randomOrNull(random: Random): Char?
Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element.
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 with its index in the original array.
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.
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.
fun CharArray.reduceOrNull( operation: (acc: Char, Char) -> Char ): Char?
Accumulates value starting with the last element and applying operation from right to left to each element and current accumulator value.
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 with its index in the original array and current accumulator value.
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.
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 and current accumulator value.
fun CharArray.reduceRightOrNull( operation: (Char, acc: Char) -> Char ): Char?
fun CharArray.refTo(index: Int): CValuesRef<COpaque>
Reverses elements in the array in-place.
fun CharArray.reverse()
Reverses elements of the array in the specified range in-place.
fun CharArray.reverse(fromIndex: Int, toIndex: Int)
Returns a list with elements in reversed order.
fun CharArray.reversed(): List<Char>
Returns an array with elements of this array in reversed order.
fun CharArray.reversedArray(): CharArray
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.
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 and current accumulator value that starts with the first element of this array.
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, its index in the original array and current accumulator value that starts with the first element of this array.
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 initial value.
fun <R> CharArray.scanIndexed( initial: R, operation: (index: Int, acc: R, Char) -> R ): List<R>
fun CharArray.scanReduce( operation: (acc: Char, Char) -> Char ): List<Char>
fun CharArray.scanReduceIndexed( operation: (index: Int, acc: Char, Char) -> Char ): List<Char>
Randomly shuffles elements in this array in-place.
fun CharArray.shuffle()
Randomly shuffles elements in this array in-place using the specified random instance as the source of randomness.
fun CharArray.shuffle(random: Random)
Returns the single element, or throws an exception if the array is empty or has more than one element.
fun CharArray.single(): Char
Returns the single element matching the given predicate, or throws exception if there is no or more than one matching element.
fun CharArray.single(predicate: (Char) -> Boolean): Char
Returns single element, or null
if the array is empty or has more than one element.
fun CharArray.singleOrNull(): Char?
Returns the single element matching the given predicate, or null
if element was not found or more than one element was found.
fun CharArray.singleOrNull( predicate: (Char) -> Boolean ): Char?
Returns a list containing elements at indices in the specified indices range.
fun CharArray.slice(indices: IntRange): List<Char>
Returns a list containing elements at specified indices.
fun CharArray.slice(indices: Iterable<Int>): List<Char>
Returns an array containing elements of this array at specified indices.
fun CharArray.sliceArray(indices: Collection<Int>): CharArray
Returns an array containing elements at indices in the specified indices range.
fun CharArray.sliceArray(indices: IntRange): CharArray
Sorts the array in-place according to the order specified by the given comparison function.
fun CharArray.sort(comparison: (a: Char, b: Char) -> Int)
Sorts elements in the array in-place descending according to their natural sort order.
fun CharArray.sortDescending()
Sorts elements of the array in the specified range in-place. The elements are sorted descending according to their natural sort order.
fun CharArray.sortDescending(fromIndex: Int, toIndex: Int)
Returns a list of all elements sorted according to their natural sort order.
fun CharArray.sorted(): List<Char>
Returns an array with all elements of this array sorted according to their natural sort order.
fun CharArray.sortedArray(): CharArray
Returns an array with all elements of this array sorted descending according to their natural sort order.
fun CharArray.sortedArrayDescending(): CharArray
Returns a list of all elements sorted according to natural sort order of the value returned by specified selector function.
fun <R : Comparable<R>> CharArray.sortedBy( 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.
fun <R : Comparable<R>> CharArray.sortedByDescending( selector: (Char) -> R? ): List<Char>
Returns a list of all elements sorted descending according to their natural sort order.
fun CharArray.sortedDescending(): List<Char>
Returns a list of all elements sorted according to the specified comparator.
fun CharArray.sortedWith( comparator: Comparator<in Char> ): List<Char>
Returns a set containing all elements that are contained by this array and not contained by the specified collection.
infix fun CharArray.subtract( other: Iterable<Char> ): Set<Char>
Returns the sum of all values produced by selector function applied to each element in the array.
fun CharArray.sumBy(selector: (Char) -> Int): Int
Returns the sum of all values produced by selector function applied to each element in the array.
fun CharArray.sumByDouble(selector: (Char) -> Double): Double
Returns the sum of all values produced by selector function applied to each element in the array.
fun CharArray.sumOf(selector: (Char) -> Double): Double
fun CharArray.sumOf(selector: (Char) -> Int): Int
fun CharArray.sumOf(selector: (Char) -> Long): Long
fun CharArray.sumOf(selector: (Char) -> UInt): UInt
fun CharArray.sumOf(selector: (Char) -> ULong): ULong
fun CharArray.sumOf( selector: (Char) -> BigDecimal ): BigDecimal
fun CharArray.sumOf( selector: (Char) -> BigInteger ): BigInteger
Returns a list containing first n elements.
fun CharArray.take(n: Int): List<Char>
Returns a list containing last n elements.
fun CharArray.takeLast(n: Int): List<Char>
Returns a list containing last elements satisfying the given predicate.
fun CharArray.takeLastWhile( predicate: (Char) -> Boolean ): List<Char>
Returns a list containing first elements satisfying the given predicate.
fun CharArray.takeWhile( predicate: (Char) -> Boolean ): List<Char>
Appends all elements to the given destination collection.
fun <C : MutableCollection<in Char>> CharArray.toCollection( destination: C ): C
Returns a new HashSet of all elements.
fun CharArray.toHashSet(): HashSet<Char>
Returns a List containing all elements.
fun CharArray.toList(): List<Char>
Returns a new MutableList filled with all elements of this array.
fun CharArray.toMutableList(): MutableList<Char>
Returns a new MutableSet containing all distinct elements from the given array.
fun CharArray.toMutableSet(): MutableSet<Char>
Returns a Set of all elements.
fun CharArray.toSet(): Set<Char>
Returns a new SortedSet of all elements.
fun CharArray.toSortedSet(): SortedSet<Char>
Returns a set containing all distinct elements from both collections.
infix fun CharArray.union(other: Iterable<Char>): Set<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.
fun CharArray.withIndex(): Iterable<IndexedValue<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.
infix fun <R> any_array<R>.zip( other: Array<out R> ): List<Pair<Char, R>>
Returns a list of values built from the elements of this
array and the other array with the same index using the provided transform function applied to each pair of elements. The returned list has length of the shortest collection.
fun <R, V> CharArray.zip( other: Array<out R>, transform: (a: Char, b: R) -> V ): List<V>
Returns a list of pairs built from the elements of this
collection and other array with the same index. The returned list has length of the shortest collection.
infix fun <R> CharArray.zip( other: Iterable<R> ): List<Pair<Char, R>>
Returns a list of values built from the elements of this
array and the other collection with the same index using the provided transform function applied to each pair of elements. The returned list has length of the shortest collection.
fun <R, V> 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 array with the same index using the provided transform function applied to each pair of elements. The returned list has length of the shortest array.
fun <V> CharArray.zip( other: CharArray, transform: (a: Char, b: Char) -> V ): List<V>
© 2010–2020 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-array/index.html