stdlib/kotlin/CharArray

CharArray

class CharArray(size: Int)(source)

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

Since Kotlin

1.0

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.

CharArray

fun CharArray(size: Int)

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

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.

Since Kotlin 1.0

iterator

operator fun iterator(): CharIterator

Creates an iterator over the elements of the array.

Since Kotlin 1.0

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.

Since Kotlin 1.0

Properties

size

val size: Int

Returns the number of elements in the array.

Since Kotlin 1.0

Extensions

asList

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

Returns a List that wraps the original array.

Since Kotlin 1.0

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.

Since Kotlin 1.0

copyOf

actual inline fun CharArray.copyOf(): CharArray

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

Since Kotlin 1.0

actual inline fun CharArray.copyOf(newSize: Int): CharArray

Returns new array which is a copy of the original array, resized to the given newSize. The copy is either truncated or padded at the end with null char (\u0000) values if necessary.

Since Kotlin 1.0

copyOfRange

@JvmName(name = "copyOfRangeInline")

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

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

Since Kotlin 1.0

elementAt

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

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

Since Kotlin 1.0

fill

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

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

Since Kotlin 1.0

max

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

Since Kotlin 1.0

maxBy

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

Since Kotlin 1.0

maxWith

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

Since Kotlin 1.0

min

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

Since Kotlin 1.0

minBy

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

Since Kotlin 1.0

minWith

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

Since Kotlin 1.0

plus

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

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

Since Kotlin 1.0

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

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

Since Kotlin 1.0

actual operator fun CharArray.plus(elements: CharArray): CharArray

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

Since Kotlin 1.0

sort

actual fun CharArray.sort()

Sorts the array in-place.

Since Kotlin 1.0

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

Sorts a range in the array in-place.

Since Kotlin 1.0

toSortedSet

fun CharArray.toSortedSet(): SortedSet<Char>

Returns a new SortedSet of all elements.

Since Kotlin 1.0

toTypedArray

actual fun CharArray.toTypedArray(): CharArray

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

Since Kotlin 1.0