CharArray

class CharArray (source)

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

Constructors

<init>

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. The init function returns an array element given its index.

CharArray(size: Int)

Creates a new array of the specified size, with all elements initialized to zero.

Properties

size

val size: Int

Returns the number of elements in the array.

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.

iterator

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.

Inherited Functions

equals

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

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

hashCode

open fun hashCode(): Int

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

toString

open fun toString(): String

Returns a string representation of the object.

Extension Properties

indices

val CharArray.indices: IntRange

Returns the range of valid indices for the array.

lastIndex

val CharArray.lastIndex: Int

Returns the last valid index for the array.

Extension Functions

all

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.

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

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

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

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.

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

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.

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

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.

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

operator fun CharArray.component1(): Char

Returns 1st element from the collection.

component2

operator fun CharArray.component2(): Char

Returns 2nd element from the collection.

component3

operator fun CharArray.component3(): Char

Returns 3rd element from the collection.

component4

operator fun CharArray.component4(): Char

Returns 4th element from the collection.

component5

operator fun CharArray.component5(): Char

Returns 5th element from the collection.

contains

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

Returns true if element is found in the array.

contentEquals

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

fun CharArray.contentHashCode(): Int

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

contentToString

fun CharArray.contentToString(): String

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

copyOf

fun CharArray.copyOf(): CharArray

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

fun CharArray.copyOf(newSize: Int): CharArray

Returns new array which is a copy of the original array, resized to the given newSize.

copyOfRange

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

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

count

fun CharArray.count(): Int

Returns the number of elements in this array.

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

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

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

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

dropWhile

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

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

elementAt

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

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

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

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

Fills original array with the provided value.

filter

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

Returns a list containing only elements matching the given predicate.

filterIndexed

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

Returns a list containing only elements matching the given predicate.

filterIndexedTo

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

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

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

filterNotTo

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

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

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

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

findLast

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.

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.

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

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

flatMap

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.

flatMapTo

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

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

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

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

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

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

Performs the given action on each element.

forEachIndexed

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

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

getOrElse

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

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.

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

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.

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

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

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.

intersect

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

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

isEmpty

fun CharArray.isEmpty(): Boolean

Returns true if the array is empty.

isNotEmpty

fun CharArray.isNotEmpty(): Boolean

Returns true if the array is not empty.

joinTo

fun <A> 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.

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

Returns the last element matching the given predicate.

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.

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

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

map

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

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

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

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?

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

maxBy

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.

maxWith

fun CharArray.maxWith(comparator: Comparator<in Char>): 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.

min

fun CharArray.min(): Char?

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

minBy

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.

minWith

fun CharArray.minWith(comparator: Comparator<in Char>): 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.

none

fun CharArray.none(): Boolean

Returns true if the array has no elements.

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

Returns true if no elements match the given predicate.

partition

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

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

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

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.

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.

reduce

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

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.

reduceRight

fun CharArray.reduceRight(
    operation: (Char, acc: Char) -> Char
): Char

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

reduceRightIndexed

fun CharArray.reduceRightIndexed(
    operation: (index: Int, Char, acc: Char) -> Char
): Char

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

reverse

fun CharArray.reverse()

Reverses elements in the array 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.

single

fun CharArray.single(): Char

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

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.

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 a list containing elements at indices in the specified indices range.

sort

fun CharArray.sort()

Sorts the array in-place.

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

Sorts a range in the array in-place.

fun CharArray.sort(comparison: (a: Char, b: Char) -> Int)

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

sortDescending

fun CharArray.sortDescending()

Sorts elements in the array in-place 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

fun <R : Comparable<R>> CharArray.sortedBy(
    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

fun <R : Comparable<R>> CharArray.sortedByDescending(
    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>
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

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

fun CharArray.sumByDouble(selector: (Char) -> Double): Double

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

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

Returns a list containing last elements satisfying the given predicate.

takeWhile

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 HashSet of all elements.

toList

fun CharArray.toList(): List<Char>

Returns a List containing all elements.

toMutableList

fun CharArray.toMutableList(): MutableList<Char>

Returns a MutableList filled with all elements of this array.

toMutableSet

fun CharArray.toMutableSet(): MutableSet<Char>

Returns a mutable set 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 SortedSet of all elements.

toTypedArray

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 of IndexedValue for each element of the original array.

zip

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

Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.

fun <R, V> any_array<R>.zip(
    other: Array<out R>,
    transform: (a: Char, b: R) -> V
): List<V>

Returns a list of values built from elements of both collections with same indexes using provided transform. List has length of shortest collection.