BooleanArray
An array of booleans. When targeting the JVM, instances of this class are represented as boolean[]
.
Constructors
Properties
size
Returns the number of elements in the array.
val size: Int
Functions
get
Returns the array element at the given index. This method can be called using the index operator.
operator fun get(index: Int): Boolean
iterator
Creates an iterator over the elements of the array.
operator fun iterator(): BooleanIterator
Extension Properties
indices
Returns the range of valid indices for the array.
val BooleanArray.indices: IntRange
lastIndex
Returns the last valid index for the array.
val BooleanArray.lastIndex: Int
Extension Functions
all
Returns true
if all elements match the given predicate.
fun BooleanArray.all(
predicate: (Boolean) -> Boolean
): Boolean
any
Returns true
if array has at least one element.
fun BooleanArray.any(): Boolean
Returns true
if at least one element matches the given predicate.
fun BooleanArray.any(
predicate: (Boolean) -> Boolean
): Boolean
asIterable
Creates an Iterable instance that wraps the original array returning its elements when being iterated.
fun BooleanArray.asIterable(): Iterable<Boolean>
asSequence
Creates a Sequence instance that wraps the original array returning its elements when being iterated.
fun BooleanArray.asSequence(): Sequence<Boolean>
associate
Returns a Map containing key-value pairs provided by transform function applied to elements of the given array.
fun <K, V> BooleanArray.associate(
transform: (Boolean) -> Pair<K, V>
): Map<K, V>
associateBy
Returns a Map containing the elements from the given array indexed by the key returned from keySelector function applied to each element.
fun <K> BooleanArray.associateBy(
keySelector: (Boolean) -> K
): Map<K, Boolean>
Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to elements of the given array.
fun <K, V> BooleanArray.associateBy(
keySelector: (Boolean) -> K,
valueTransform: (Boolean) -> V
): Map<K, V>
associateByTo
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 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 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.associateByTo(
destination: M,
keySelector: (Boolean) -> K,
valueTransform: (Boolean) -> V
): M
associateTo
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>> BooleanArray.associateTo(
destination: M,
transform: (Boolean) -> Pair<K, V>
): M
component1
Returns 1st element from the array.
operator fun BooleanArray.component1(): Boolean
component2
Returns 2nd element from the array.
operator fun BooleanArray.component2(): Boolean
component3
Returns 3rd element from the array.
operator fun BooleanArray.component3(): Boolean
component4
Returns 4th element from the array.
operator fun BooleanArray.component4(): Boolean
component5
Returns 5th element from the array.
operator fun BooleanArray.component5(): Boolean
contains
Returns true
if element is found in the array.
operator fun BooleanArray.contains(element: Boolean): Boolean
count
Returns the number of elements in this array.
fun BooleanArray.count(): Int
Returns the number of elements matching the given predicate.
fun BooleanArray.count(predicate: (Boolean) -> Boolean): Int
distinct
Returns a list containing only distinct elements from the given array.
fun BooleanArray.distinct(): List<Boolean>
distinctBy
Returns a list containing only elements from the given array having distinct keys returned by the given selector function.
fun <K> BooleanArray.distinctBy(
selector: (Boolean) -> K
): List<Boolean>
drop
Returns a list containing all elements except first n elements.
fun BooleanArray.drop(n: Int): List<Boolean>
dropLast
Returns a list containing all elements except last n elements.
fun BooleanArray.dropLast(n: Int): List<Boolean>
dropLastWhile
Returns a list containing all elements except last elements that satisfy the given predicate.
fun BooleanArray.dropLastWhile(
predicate: (Boolean) -> Boolean
): List<Boolean>
dropWhile
Returns a list containing all elements except first elements that satisfy the given predicate.
fun BooleanArray.dropWhile(
predicate: (Boolean) -> Boolean
): List<Boolean>
elementAtOrElse
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.elementAtOrElse(
index: Int,
defaultValue: (Int) -> Boolean
): Boolean
elementAtOrNull
Returns an element at the given index or null
if the index is out of bounds of this array.
fun BooleanArray.elementAtOrNull(index: Int): Boolean?
filter
Returns a list containing only elements matching the given predicate.
fun BooleanArray.filter(
predicate: (Boolean) -> Boolean
): List<Boolean>
filterIndexed
Returns a list containing only elements matching the given predicate.
fun BooleanArray.filterIndexed(
predicate: (index: Int, Boolean) -> Boolean
): List<Boolean>
filterIndexedTo
Appends all elements matching the given predicate to the given destination.
fun <C : MutableCollection<in Boolean>> BooleanArray.filterIndexedTo(
destination: C,
predicate: (index: Int, Boolean) -> Boolean
): C
filterNot
Returns a list containing all elements not matching the given predicate.
fun BooleanArray.filterNot(
predicate: (Boolean) -> Boolean
): List<Boolean>
filterNotTo
Appends all elements not matching the given predicate to the given destination.
fun <C : MutableCollection<in Boolean>> BooleanArray.filterNotTo(
destination: C,
predicate: (Boolean) -> Boolean
): C
filterTo
Appends all elements matching the given predicate to the given destination.
fun <C : MutableCollection<in Boolean>> BooleanArray.filterTo(
destination: C,
predicate: (Boolean) -> Boolean
): C
find
Returns the first element matching the given predicate, or null
if no such element was found.
fun BooleanArray.find(
predicate: (Boolean) -> Boolean
): Boolean?
findLast
Returns the last element matching the given predicate, or null
if no such element was found.
fun BooleanArray.findLast(
predicate: (Boolean) -> Boolean
): Boolean?
first
Returns first element.
fun BooleanArray.first(): Boolean
Returns the first element matching the given predicate.
fun BooleanArray.first(
predicate: (Boolean) -> Boolean
): Boolean
firstOrNull
Returns the first element, or null
if the array is empty.
fun BooleanArray.firstOrNull(): Boolean?
Returns the first element matching the given predicate, or null
if element was not found.
fun BooleanArray.firstOrNull(
predicate: (Boolean) -> Boolean
): Boolean?
flatMap
Returns a single list of all elements yielded from results of transform function being invoked on each element of original array.
fun <R> BooleanArray.flatMap(
transform: (Boolean) -> Iterable<R>
): List<R>
flatMapTo
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>> BooleanArray.flatMapTo(
destination: C,
transform: (Boolean) -> Iterable<R>
): C
fold
Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each element.
fun <R> BooleanArray.fold(
initial: R,
operation: (acc: R, Boolean) -> R
): R
foldIndexed
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.foldIndexed(
initial: R,
operation: (index: Int, acc: R, Boolean) -> R
): R
foldRight
Accumulates value starting with initial value and applying operation from right to left to each element and current accumulator value.
fun <R> BooleanArray.foldRight(
initial: R,
operation: (Boolean, acc: R) -> R
): R
foldRightIndexed
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 <R> BooleanArray.foldRightIndexed(
initial: R,
operation: (index: Int, Boolean, acc: R) -> R
): R
forEach
Performs the given action on each element.
fun BooleanArray.forEach(action: (Boolean) -> Unit)
forEachIndexed
Performs the given action on each element, providing sequential index with the element.
fun BooleanArray.forEachIndexed(
action: (index: Int, Boolean) -> Unit)
getOrElse
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.getOrElse(
index: Int,
defaultValue: (Int) -> Boolean
): Boolean
getOrNull
Returns an element at the given index or null
if the index is out of bounds of this array.
fun BooleanArray.getOrNull(index: Int): Boolean?
groupBy
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> BooleanArray.groupBy(
keySelector: (Boolean) -> K
): Map<K, List<Boolean>>
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> BooleanArray.groupBy(
keySelector: (Boolean) -> K,
valueTransform: (Boolean) -> V
): Map<K, List<V>>
groupByTo
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<Boolean>>> BooleanArray.groupByTo(
destination: M,
keySelector: (Boolean) -> 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>>> BooleanArray.groupByTo(
destination: M,
keySelector: (Boolean) -> K,
valueTransform: (Boolean) -> V
): M
indexOf
Returns first index of element, or -1 if the array does not contain element.
fun BooleanArray.indexOf(element: Boolean): Int
indexOfFirst
Returns index of the first element matching the given predicate, or -1 if the array does not contain such element.
fun BooleanArray.indexOfFirst(
predicate: (Boolean) -> Boolean
): Int
indexOfLast
Returns index of the last element matching the given predicate, or -1 if the array does not contain such element.
fun BooleanArray.indexOfLast(
predicate: (Boolean) -> Boolean
): Int
intersect
Returns a set containing all elements that are contained by both this array and the specified collection.
infix fun BooleanArray.intersect(
other: Iterable<Boolean>
): Set<Boolean>
isEmpty
Returns true
if the array is empty.
fun BooleanArray.isEmpty(): Boolean
isNotEmpty
Returns true
if the array is not empty.
fun BooleanArray.isNotEmpty(): Boolean
joinTo
Appends the string from all the elements separated using separator and using the given prefix and postfix if supplied.
fun <A : Appendable> BooleanArray.joinTo(
buffer: A,
separator: CharSequence = ", ",
prefix: CharSequence = "",
postfix: CharSequence = "",
limit: Int = -1,
truncated: CharSequence = "...",
transform: ((Boolean) -> CharSequence)? = null
): A
joinToString
Creates a 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
last
Returns the last element.
fun BooleanArray.last(): Boolean
Returns the last element matching the given predicate.
fun BooleanArray.last(
predicate: (Boolean) -> Boolean
): Boolean
lastIndexOf
Returns last index of element, or -1 if the array does not contain element.
fun BooleanArray.lastIndexOf(element: Boolean): Int
lastOrNull
Returns the last element, or null
if the array is empty.
fun BooleanArray.lastOrNull(): Boolean?
Returns the last element matching the given predicate, or null
if no such element was found.
fun BooleanArray.lastOrNull(
predicate: (Boolean) -> Boolean
): Boolean?
map
Returns a list containing the results of applying the given transform function to each element in the original array.
fun <R> BooleanArray.map(transform: (Boolean) -> R): List<R>
mapIndexed
Returns a list containing the results of applying the given transform function to each element and its index in the original array.
fun <R> BooleanArray.mapIndexed(
transform: (index: Int, Boolean) -> R
): List<R>
mapIndexedTo
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.mapIndexedTo(
destination: C,
transform: (index: Int, Boolean) -> R
): C
mapTo
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>> BooleanArray.mapTo(
destination: C,
transform: (Boolean) -> R
): C
maxBy
Returns the first element yielding the largest value of the given function or null
if there are no elements.
fun <R : Comparable<R>> BooleanArray.maxBy(
selector: (Boolean) -> R
): Boolean?
maxWith
Returns the first element having the largest value according to the provided comparator or null
if there are no elements.
fun BooleanArray.maxWith(
comparator: Comparator<in Boolean>
): Boolean?
minBy
Returns the first element yielding the smallest value of the given function or null
if there are no elements.
fun <R : Comparable<R>> BooleanArray.minBy(
selector: (Boolean) -> R
): Boolean?
minWith
Returns the first element having the smallest value according to the provided comparator or null
if there are no elements.
fun BooleanArray.minWith(
comparator: Comparator<in Boolean>
): Boolean?
none
Returns true
if the array has no elements.
fun BooleanArray.none(): Boolean
Returns true
if no elements match the given predicate.
fun BooleanArray.none(
predicate: (Boolean) -> Boolean
): Boolean
random
Returns a random element from this array.
fun BooleanArray.random(): Boolean
Returns a random element from this array using the specified source of randomness.
fun BooleanArray.random(random: Random): Boolean
randomOrNull
Returns a random element from this array, or null
if this array is empty.
fun BooleanArray.randomOrNull(): Boolean?
Returns a random element from this array using the specified source of randomness, or null
if this array is empty.
fun BooleanArray.randomOrNull(random: Random): Boolean?
reduce
Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element.
fun BooleanArray.reduce(
operation: (acc: Boolean, Boolean) -> Boolean
): Boolean
reduceIndexed
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.reduceIndexed(
operation: (index: Int, acc: Boolean, Boolean) -> Boolean
): Boolean
reduceOrNull
Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element. Returns null if the array is empty.
fun BooleanArray.reduceOrNull(
operation: (acc: Boolean, Boolean) -> Boolean
): Boolean?
reduceRight
Accumulates value starting with last element and applying operation from right to left to each element and current accumulator value.
fun BooleanArray.reduceRight(
operation: (Boolean, acc: Boolean) -> Boolean
): Boolean
reduceRightIndexed
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.reduceRightIndexed(
operation: (index: Int, Boolean, acc: Boolean) -> Boolean
): Boolean
reduceRightOrNull
Accumulates value starting with last element and applying operation from right to left to each element and current accumulator value. Returns null if the array is empty.
fun BooleanArray.reduceRightOrNull(
operation: (Boolean, acc: Boolean) -> Boolean
): Boolean?
reverse
Reverses elements in the array in-place.
fun BooleanArray.reverse()
reversed
Returns a list with elements in reversed order.
fun BooleanArray.reversed(): List<Boolean>
reversedArray
Returns an array with elements of this array in reversed order.
fun BooleanArray.reversedArray(): BooleanArray
scan
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.
fun <R> BooleanArray.scan(
initial: R,
operation: (acc: R, Boolean) -> R
): List<R>
scanIndexed
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> BooleanArray.scanIndexed(
initial: R,
operation: (index: Int, acc: R, Boolean) -> R
): List<R>
scanReduce
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 BooleanArray.scanReduce(
operation: (acc: Boolean, Boolean) -> Boolean
): List<Boolean>
scanReduceIndexed
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 BooleanArray.scanReduceIndexed(
operation: (index: Int, acc: Boolean, Boolean) -> Boolean
): List<Boolean>
single
Returns the single element, or throws an exception if the array is empty or has more than one element.
fun BooleanArray.single(): Boolean
Returns the single element matching the given predicate, or throws exception if there is no or more than one matching element.
fun BooleanArray.single(
predicate: (Boolean) -> Boolean
): Boolean
singleOrNull
Returns single element, or null
if the array is empty or has more than one element.
fun BooleanArray.singleOrNull(): Boolean?
Returns the single element matching the given predicate, or null
if element was not found or more than one element was found.
fun BooleanArray.singleOrNull(
predicate: (Boolean) -> Boolean
): Boolean?
slice
Returns a list containing elements at indices in the specified indices range.
fun BooleanArray.slice(indices: IntRange): List<Boolean>
Returns a list containing elements at specified indices.
fun BooleanArray.slice(indices: Iterable<Int>): List<Boolean>
sliceArray
Returns an array containing elements of this array at specified indices.
fun BooleanArray.sliceArray(
indices: Collection<Int>
): BooleanArray
Returns an array containing elements at indices in the specified indices range.
fun BooleanArray.sliceArray(indices: IntRange): BooleanArray
sortedBy
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.sortedBy(
selector: (Boolean) -> R?
): List<Boolean>
sortedByDescending
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>> BooleanArray.sortedByDescending(
selector: (Boolean) -> R?
): List<Boolean>
sortedWith
Returns a list of all elements sorted according to the specified comparator.
fun BooleanArray.sortedWith(
comparator: Comparator<in Boolean>
): List<Boolean>
subtract
Returns a set containing all elements that are contained by this array and not contained by the specified collection.
infix fun BooleanArray.subtract(
other: Iterable<Boolean>
): Set<Boolean>
sumBy
Returns the sum of all values produced by selector function applied to each element in the array.
fun BooleanArray.sumBy(selector: (Boolean) -> Int): Int
sumByDouble
Returns the sum of all values produced by selector function applied to each element in the array.
fun BooleanArray.sumByDouble(
selector: (Boolean) -> Double
): Double
take
Returns a list containing first n elements.
fun BooleanArray.take(n: Int): List<Boolean>
takeLast
Returns a list containing last n elements.
fun BooleanArray.takeLast(n: Int): List<Boolean>
takeLastWhile
Returns a list containing last elements satisfying the given predicate.
fun BooleanArray.takeLastWhile(
predicate: (Boolean) -> Boolean
): List<Boolean>
takeWhile
Returns a list containing first elements satisfying the given predicate.
fun BooleanArray.takeWhile(
predicate: (Boolean) -> Boolean
): List<Boolean>
toCollection
Appends all elements to the given destination collection.
fun <C : MutableCollection<in Boolean>> BooleanArray.toCollection(
destination: C
): C
toHashSet
Returns a HashSet of all elements.
fun BooleanArray.toHashSet(): HashSet<Boolean>
toList
Returns a List containing all elements.
fun BooleanArray.toList(): List<Boolean>
toMutableList
Returns a MutableList filled with all elements of this array.
fun BooleanArray.toMutableList(): MutableList<Boolean>
toMutableSet
Returns a mutable set containing all distinct elements from the given array.
fun BooleanArray.toMutableSet(): MutableSet<Boolean>
toSet
Returns a Set of all elements.
fun BooleanArray.toSet(): Set<Boolean>
toSortedSet
Returns a SortedSet of all elements.
fun BooleanArray.toSortedSet(): SortedSet<Boolean>
union
Returns a set containing all distinct elements from both collections.
infix fun BooleanArray.union(
other: Iterable<Boolean>
): Set<Boolean>
withIndex
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 BooleanArray.withIndex(): Iterable<IndexedValue<Boolean>>
zip
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.
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> BooleanArray.zip(
other: Array<out R>,
transform: (a: Boolean, 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> BooleanArray.zip(
other: Iterable<R>
): List<Pair<Boolean, 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> BooleanArray.zip(
other: Iterable<R>,
transform: (a: Boolean, 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> BooleanArray.zip(
other: BooleanArray,
transform: (a: Boolean, b: Boolean) -> V
): List<V>