kotlin-stdlib/kotlin.collections/BooleanIterator

BooleanIterator

abstract class BooleanIterator : Iterator<Boolean> (source)

An iterator over a sequence of values of type Boolean.

This is a substitute for Iterator<Boolean> that provides a specialized version of next(): T method: nextBoolean(): Boolean and has a special handling by the compiler to avoid platform-specific boxing conversions as a performance optimization.

In the following example:

class BooleanContainer(private val data: BooleanArray) {

    // BooleanIterator instead of Iterator<Boolean> in the signature
    operator fun iterator(): BooleanIterator = object : BooleanIterator() {
        private var idx = 0

        override fun nextBoolean(): Boolean {
            if (!hasNext()) throw NoSuchElementException()
            return data[idx++]
        }

        override fun hasNext(): Boolean = idx < data.size
    }
}

for (element in BooleanContainer(booleanArrayOf(true, false, true))) {
    ... handle element ...
}
Content copied to clipboard

No boxing conversion is performed during the for-loop iteration. Note that the iterator itself will still be allocated.

Since Kotlin

1.0

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
fun <T> Iterator<T>.asSequence(): Sequence<T>

Creates a sequence that returns all elements from this iterator. The sequence is constrained to be iterated only once.

Since Kotlin 1.0
Link copied to clipboard
inline fun <T> Iterator<T>.forEach(operation: (T) -> Unit)

Performs the given operation on each element of this Iterator.

Since Kotlin 1.0
Link copied to clipboard
expect abstract operator fun hasNext(): Boolean

Returns true if the iteration has more elements.

Since Kotlin 1.0
Link copied to clipboard
inline operator fun <T> Iterator<T>.iterator(): Iterator<T>

Returns the given iterator itself. This allows to use an instance of iterator in a for loop.

Since Kotlin 1.0
Link copied to clipboard
operator override fun next(): Boolean

Returns the next element in the iteration.

Since Kotlin 1.0
Link copied to clipboard
abstract fun nextBoolean(): Boolean

Returns the next element in the iteration without boxing conversion.

Since Kotlin 1.0
Link copied to clipboard
fun <T> Iterator<T>.withIndex(): Iterator<IndexedValue<T>>

Returns an Iterator that wraps each element produced by the original iterator into an IndexedValue containing the index of that element and the element itself.

Since Kotlin 1.0