kotlin.BooleanArray
BooleanArray
class BooleanArray
An array of booleans. When targeting the JVM, instances of this class are represented as boolean[]
.
Constructors
BooleanArray(size: Int, init: (Int) -> Boolean) 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. BooleanArray(size: Int) Creates a new array of the specified size, with all elements initialized to false. |
Properties
val size: Int Returns the number of elements in the array. |
Functions
operator fun get(index: Int): Boolean Returns the array element at the given index. This method can be called using the index operator. | |
operator fun iterator(): BooleanIterator Creates an iterator over the elements of the array. | |
operator fun set(index: Int, value: Boolean) Sets the element at the given index to the given value. This method can be called using the index operator. |
Inherited Functions
open operator fun equals(other: Any?): Boolean Indicates whether some other object is "equal to" this one. Implementations must fulfil the following requirements: | |
open fun hashCode(): Int Returns a hash code value for the object. The general contract of hashCode is: | |
open fun toString(): String Returns a string representation of the object. |
Extension Properties
val BooleanArray.indices: IntRange Returns the range of valid indices for the array. | |
val BooleanArray.lastIndex: Int Returns the last valid index for the array. |
Extension Functions
fun BooleanArray.all( predicate: (Boolean) -> Boolean ): Boolean Returns | |
fun BooleanArray.any(): Boolean Returns fun BooleanArray.any( predicate: (Boolean) -> Boolean ): Boolean Returns | |
fun BooleanArray.asIterable(): Iterable<Boolean> Creates an Iterable instance that wraps the original array returning its elements when being iterated. | |
fun BooleanArray.asList(): List<Boolean> Returns a List that wraps the original array. | |
fun BooleanArray.asSequence(): Sequence<Boolean> Creates a Sequence instance that wraps the original array returning its elements when being iterated. | |
fun <K, V> BooleanArray.associate( transform: (Boolean) -> Pair<K, V> ): Map<K, V> Returns a Map containing key-value pairs provided by transform function applied to elements of the given array. | |
fun <K> BooleanArray.associateBy( keySelector: (Boolean) -> K ): Map<K, Boolean> 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> BooleanArray.associateBy( keySelector: (Boolean) -> K, valueTransform: (Boolean) -> 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. | |
fun <K, M : MutableMap<in K, in Boolean>> BooleanArray.associateByTo( destination: M, keySelector: (Boolean) -> 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>> BooleanArray.associateByTo( destination: M, keySelector: (Boolean) -> K, valueTransform: (Boolean) -> 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. | |
fun <K, V, M : MutableMap<in K, in V>> BooleanArray.associateTo( destination: M, transform: (Boolean) -> 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. | |
operator fun BooleanArray.component1(): Boolean Returns 1st element from the collection. | |
operator fun BooleanArray.component2(): Boolean Returns 2nd element from the collection. | |
operator fun BooleanArray.component3(): Boolean Returns 3rd element from the collection. | |
operator fun BooleanArray.component4(): Boolean Returns 4th element from the collection. | |
operator fun BooleanArray.component5(): Boolean Returns 5th element from the collection. | |
operator fun BooleanArray.contains(element: Boolean): Boolean Returns | |
infix fun BooleanArray.contentEquals( other: BooleanArray ): Boolean Returns | |
fun BooleanArray.contentHashCode(): Int Returns a hash code based on the contents of this array as if it is List. | |
fun BooleanArray.contentToString(): String Returns a string representation of the contents of the specified array as if it is List. | |
fun BooleanArray.copyOf(): BooleanArray Returns new array which is a copy of the original array. fun BooleanArray.copyOf(newSize: Int): BooleanArray Returns new array which is a copy of the original array, resized to the given newSize. | |
fun BooleanArray.copyOfRange( fromIndex: Int, toIndex: Int ): BooleanArray Returns new array which is a copy of range of original array. | |
fun BooleanArray.count(): Int Returns the number of elements in this array. fun BooleanArray.count(predicate: (Boolean) -> Boolean): Int Returns the number of elements matching the given predicate. | |
fun BooleanArray.distinct(): List<Boolean> Returns a list containing only distinct elements from the given array. | |
fun <K> BooleanArray.distinctBy( selector: (Boolean) -> K ): List<Boolean> Returns a list containing only elements from the given array having distinct keys returned by the given selector function. | |
fun BooleanArray.drop(n: Int): List<Boolean> Returns a list containing all elements except first n elements. | |
fun BooleanArray.dropLast(n: Int): List<Boolean> Returns a list containing all elements except last n elements. | |
fun BooleanArray.dropLastWhile( predicate: (Boolean) -> Boolean ): List<Boolean> Returns a list containing all elements except last elements that satisfy the given predicate. | |
fun BooleanArray.dropWhile( predicate: (Boolean) -> Boolean ): List<Boolean> Returns a list containing all elements except first elements that satisfy the given predicate. | |
fun BooleanArray.elementAt(index: Int): Boolean Returns an element at the given index or throws an IndexOutOfBoundsException if the index is out of bounds of this array. | |
fun BooleanArray.elementAtOrElse( index: Int, defaultValue: (Int) -> Boolean ): Boolean 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 BooleanArray.elementAtOrNull(index: Int): Boolean? Returns an element at the given index or | |
fun BooleanArray.fill( element: Boolean, fromIndex: Int = 0, toIndex: Int = size) Fills original array with the provided value. | |
fun BooleanArray.filter( predicate: (Boolean) -> Boolean ): List<Boolean> Returns a list containing only elements matching the given predicate. | |
fun BooleanArray.filterIndexed( predicate: (index: Int, Boolean) -> Boolean ): List<Boolean> Returns a list containing only elements matching the given predicate. | |
fun <C : MutableCollection<in Boolean>> BooleanArray.filterIndexedTo( destination: C, predicate: (index: Int, Boolean) -> Boolean ): C Appends all elements matching the given predicate to the given destination. | |
fun BooleanArray.filterNot( predicate: (Boolean) -> Boolean ): List<Boolean> Returns a list containing all elements not matching the given predicate. | |
fun <C : MutableCollection<in Boolean>> BooleanArray.filterNotTo( destination: C, predicate: (Boolean) -> Boolean ): C Appends all elements not matching the given predicate to the given destination. | |
fun <C : MutableCollection<in Boolean>> BooleanArray.filterTo( destination: C, predicate: (Boolean) -> Boolean ): C Appends all elements matching the given predicate to the given destination. | |
fun BooleanArray.find( predicate: (Boolean) -> Boolean ): Boolean? Returns the first element matching the given predicate, or | |
fun BooleanArray.findLast( predicate: (Boolean) -> Boolean ): Boolean? Returns the last element matching the given predicate, or | |
fun BooleanArray.first(): Boolean Returns first element. fun BooleanArray.first( predicate: (Boolean) -> Boolean ): Boolean Returns the first element matching the given predicate. | |
fun BooleanArray.firstOrNull(): Boolean? Returns the first element, or fun BooleanArray.firstOrNull( predicate: (Boolean) -> Boolean ): Boolean? Returns the first element matching the given predicate, or | |
fun <R> BooleanArray.flatMap( transform: (Boolean) -> 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. | |
fun <R, C : MutableCollection<in R>> BooleanArray.flatMapTo( destination: C, transform: (Boolean) -> 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> BooleanArray.fold( initial: R, operation: (acc: R, Boolean) -> R ): R Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each element. | |
fun <R> BooleanArray.foldIndexed( initial: R, operation: (index: Int, acc: R, Boolean) -> 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. | |
fun <R> BooleanArray.foldRight( initial: R, operation: (Boolean, acc: R) -> R ): R Accumulates value starting with initial value and applying operation from right to left to each element and current accumulator value. | |
fun <R> BooleanArray.foldRightIndexed( initial: R, operation: (index: Int, Boolean, 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. | |
fun BooleanArray.forEach(action: (Boolean) -> Unit) Performs the given action on each element. | |
fun BooleanArray.forEachIndexed( action: (index: Int, Boolean) -> Unit) Performs the given action on each element, providing sequential index with the element. | |
fun BooleanArray.getOrElse( index: Int, defaultValue: (Int) -> Boolean ): Boolean 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 BooleanArray.getOrNull(index: Int): Boolean? Returns an element at the given index or | |
fun <K> BooleanArray.groupBy( keySelector: (Boolean) -> K ): Map<K, List<Boolean>> 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> BooleanArray.groupBy( keySelector: (Boolean) -> K, valueTransform: (Boolean) -> 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. | |
fun <K, M : MutableMap<in K, MutableList<Boolean>>> BooleanArray.groupByTo( destination: M, keySelector: (Boolean) -> 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>>> BooleanArray.groupByTo( destination: M, keySelector: (Boolean) -> K, valueTransform: (Boolean) -> 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. | |
fun BooleanArray.indexOf(element: Boolean): Int Returns first index of element, or -1 if the array does not contain element. | |
fun BooleanArray.indexOfFirst( predicate: (Boolean) -> Boolean ): Int Returns index of the first element matching the given predicate, or -1 if the array does not contain such element. | |
fun BooleanArray.indexOfLast( predicate: (Boolean) -> Boolean ): Int Returns index of the last element matching the given predicate, or -1 if the array does not contain such element. | |
infix fun BooleanArray.intersect( other: Iterable<Boolean> ): Set<Boolean> Returns a set containing all elements that are contained by both this set and the specified collection. | |
fun BooleanArray.isEmpty(): Boolean Returns | |
fun BooleanArray.isNotEmpty(): Boolean Returns | |
fun <A : Appendable> BooleanArray.joinTo( buffer: A, separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: (Boolean) -> CharSequence = null ): A Appends the string from all the elements separated using separator and using the given prefix and postfix if supplied. | |
fun BooleanArray.joinToString( separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: (Boolean) -> CharSequence = null ): String Creates a string from all the elements separated using separator and using the given prefix and postfix if supplied. | |
fun BooleanArray.last(): Boolean Returns the last element. fun BooleanArray.last( predicate: (Boolean) -> Boolean ): Boolean Returns the last element matching the given predicate. | |
fun BooleanArray.lastIndexOf(element: Boolean): Int Returns last index of element, or -1 if the array does not contain element. | |
fun BooleanArray.lastOrNull(): Boolean? Returns the last element, or fun BooleanArray.lastOrNull( predicate: (Boolean) -> Boolean ): Boolean? Returns the last element matching the given predicate, or | |
fun <R> BooleanArray.map(transform: (Boolean) -> R): List<R> Returns a list containing the results of applying the given transform function to each element in the original array. | |
fun <R> BooleanArray.mapIndexed( transform: (index: Int, Boolean) -> 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, C : MutableCollection<in R>> BooleanArray.mapIndexedTo( destination: C, transform: (index: Int, Boolean) -> 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. | |
fun <R, C : MutableCollection<in R>> BooleanArray.mapTo( destination: C, transform: (Boolean) -> R ): C Applies the given transform function to each element of the original array and appends the results to the given destination. | |
fun <R : Comparable<R>> BooleanArray.maxBy( selector: (Boolean) -> R ): Boolean? Returns the first element yielding the largest value of the given function or | |
fun BooleanArray.maxWith( comparator: Comparator<in Boolean> ): Boolean? fun BooleanArray.maxWith( comparator: Comparator<in Boolean> ): Boolean? Returns the first element having the largest value according to the provided comparator or | |
fun <R : Comparable<R>> BooleanArray.minBy( selector: (Boolean) -> R ): Boolean? Returns the first element yielding the smallest value of the given function or | |
fun BooleanArray.minWith( comparator: Comparator<in Boolean> ): Boolean? fun BooleanArray.minWith( comparator: Comparator<in Boolean> ): Boolean? Returns the first element having the smallest value according to the provided comparator or | |
fun BooleanArray.none(): Boolean Returns fun BooleanArray.none( predicate: (Boolean) -> Boolean ): Boolean Returns | |
fun BooleanArray.partition( predicate: (Boolean) -> Boolean ): Pair<List<Boolean>, List<Boolean>> Splits the original array into pair of lists, where first list contains elements for which predicate yielded | |
operator fun BooleanArray.plus( element: Boolean ): BooleanArray Returns an array containing all elements of the original array and then the given element. operator fun BooleanArray.plus( elements: Collection<Boolean> ): BooleanArray Returns an array containing all elements of the original array and then all elements of the given elements collection. operator fun BooleanArray.plus( elements: BooleanArray ): BooleanArray Returns an array containing all elements of the original array and then all elements of the given elements array. | |
fun BooleanArray.reduce( operation: (acc: Boolean, Boolean) -> Boolean ): Boolean Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element. | |
fun BooleanArray.reduceIndexed( operation: (index: Int, acc: Boolean, Boolean) -> Boolean ): Boolean 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 BooleanArray.reduceRight( operation: (Boolean, acc: Boolean) -> Boolean ): Boolean Accumulates value starting with last element and applying operation from right to left to each element and current accumulator value. | |
fun BooleanArray.reduceRightIndexed( operation: (index: Int, Boolean, acc: Boolean) -> Boolean ): Boolean 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. | |
fun BooleanArray.reverse() Reverses elements in the array in-place. | |
fun BooleanArray.reversed(): List<Boolean> Returns a list with elements in reversed order. | |
fun BooleanArray.reversedArray(): BooleanArray Returns an array with elements of this array in reversed order. | |
fun BooleanArray.single(): Boolean Returns the single element, or throws an exception if the array is empty or has more than one element. fun BooleanArray.single( predicate: (Boolean) -> Boolean ): Boolean Returns the single element matching the given predicate, or throws exception if there is no or more than one matching element. | |
fun BooleanArray.singleOrNull(): Boolean? Returns single element, or fun BooleanArray.singleOrNull( predicate: (Boolean) -> Boolean ): Boolean? Returns the single element matching the given predicate, or | |
fun BooleanArray.slice(indices: IntRange): List<Boolean> Returns a list containing elements at indices in the specified indices range. fun BooleanArray.slice(indices: Iterable<Int>): List<Boolean> Returns a list containing elements at specified indices. | |
fun BooleanArray.sliceArray( indices: Collection<Int> ): BooleanArray Returns an array containing elements of this array at specified indices. fun BooleanArray.sliceArray(indices: IntRange): BooleanArray Returns a list containing elements at indices in the specified indices range. | |
fun <R : Comparable<R>> BooleanArray.sortedBy( selector: (Boolean) -> R? ): List<Boolean> Returns a list of all elements sorted according to natural sort order of the value returned by specified selector function. | |
fun <R : Comparable<R>> BooleanArray.sortedByDescending( selector: (Boolean) -> R? ): List<Boolean> Returns a list of all elements sorted descending according to natural sort order of the value returned by specified selector function. | |
fun BooleanArray.sortedWith( comparator: Comparator<in Boolean> ): List<Boolean> fun BooleanArray.sortedWith( comparator: Comparator<in Boolean> ): List<Boolean> Returns a list of all elements sorted according to the specified comparator. | |
infix fun BooleanArray.subtract( other: Iterable<Boolean> ): Set<Boolean> Returns a set containing all elements that are contained by this array and not contained by the specified collection. | |
fun BooleanArray.sumBy(selector: (Boolean) -> Int): Int Returns the sum of all values produced by selector function applied to each element in the array. | |
fun BooleanArray.sumByDouble( selector: (Boolean) -> Double ): Double Returns the sum of all values produced by selector function applied to each element in the array. | |
fun BooleanArray.take(n: Int): List<Boolean> Returns a list containing first n elements. | |
fun BooleanArray.takeLast(n: Int): List<Boolean> Returns a list containing last n elements. | |
fun BooleanArray.takeLastWhile( predicate: (Boolean) -> Boolean ): List<Boolean> Returns a list containing last elements satisfying the given predicate. | |
fun BooleanArray.takeWhile( predicate: (Boolean) -> Boolean ): List<Boolean> Returns a list containing first elements satisfying the given predicate. | |
fun <C : MutableCollection<in Boolean>> BooleanArray.toCollection( destination: C ): C Appends all elements to the given destination collection. | |
fun BooleanArray.toHashSet(): HashSet<Boolean> Returns a HashSet of all elements. | |
fun BooleanArray.toList(): List<Boolean> Returns a List containing all elements. | |
fun BooleanArray.toMutableList(): MutableList<Boolean> Returns a MutableList filled with all elements of this array. | |
fun BooleanArray.toMutableSet(): MutableSet<Boolean> Returns a mutable set containing all distinct elements from the given array. | |
fun BooleanArray.toSet(): Set<Boolean> Returns a Set of all elements. | |
fun BooleanArray.toSortedSet(): SortedSet<Boolean> Returns a SortedSet of all elements. | |
fun BooleanArray.toTypedArray(): Array<Boolean> Returns a typed object array containing all of the elements of this primitive array. | |
infix fun BooleanArray.union( other: Iterable<Boolean> ): Set<Boolean> Returns a set containing all distinct elements from both collections. | |
fun BooleanArray.withIndex(): Iterable<IndexedValue<Boolean>> Returns a lazy Iterable of IndexedValue for each element of the original array. | |
infix fun <R> any_array<R>.zip( other: Array<out R> ): List<Pair<Boolean, 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: Boolean, 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. |
© 2010–2017 JetBrains s.r.o.
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean-array/