kone.collections/dev.lounres.kone.collections.iterables/KoneReversibleIterator

KoneReversibleIterator

interface KoneReversibleIterator<out Element> : KoneIterator<Element> (source)

Represents an KoneIterator that can iterate over the elements in both directions, forward and backward.

Inheritors

KoneReversibleSettableIterator

KoneReversibleExtendableIterator

KoneReversibleRemovableIterator

KoneLinearIterator

KoneLinkedNoddedSetIterator

Functions

asKotlin

fun <Element> KoneIterator<Element>.asKotlin(): Iterator<Element>

fold

inline fun <E, R> KoneIterator<E>.fold(initial: R, operation: (acc: R, E) -> R): R

foldIndexed

inline fun <E, R> KoneIterator<E>.foldIndexed(initial: R, operation: (index: UInt, acc: R, E) -> R): R

getAndMoveNext

fun <Element> KoneIterator<Element>.getAndMoveNext(): Element

Gets the next element, moves forward, and returns the got element.

getAndMovePrevious

fun <Element> KoneReversibleIterator<Element>.getAndMovePrevious(): Element

Gets the previous element, moves backward, and returns the got element.

getNext

abstract fun getNext(): Element

Returns next element in the order or throws NoFollowingElementInIteratorException if there is no next element.

getPrevious

abstract fun getPrevious(): Element

Returns previous element in the order or throws NoFollowingElementInIteratorException if there is no previous element.

hasNext

abstract operator fun hasNext(): Boolean

Returns true iff there is next element in the order.

hasPrevious

abstract fun hasPrevious(): Boolean

Returns true iff there is previous element in the order.

iterator

inline operator fun <E> KoneIterator<E>.iterator(): KoneIterator<E>

moveNext

abstract fun moveNext()

Moves forward bypassing next element or throws NoFollowingElementInIteratorException if there is no next element.

movePrevious

abstract fun movePrevious()

Moves backward bypassing previous element or throws NoFollowingElementInIteratorException if there is no previous element.

inline operator fun <Element> KoneIterator<Element>.next(): Element

Gets the next element moves forward and returns the got element. It is an operator function to use in for cycles.

reduce

inline fun <E : R, R> KoneIterator<E>.reduce(operation: (acc: R, E) -> R): R

reduceIndexed

inline fun <E : R, R> KoneIterator<E>.reduceIndexed(operation: (index: UInt, acc: R, E) -> R): R

reduceIndexedMaybe

inline fun <E : R, R> KoneIterator<E>.reduceIndexedMaybe(operation: (index: UInt, acc: R, E) -> R): Maybe<R>

reduceIndexedOrNull

inline fun <E : R, R> KoneIterator<E>.reduceIndexedOrNull(operation: (index: UInt, acc: R, E) -> R): R?

reduceMaybe

inline fun <E : R, R> KoneIterator<E>.reduceMaybe(operation: (acc: R, E) -> R): Maybe<R>

reduceOrNull

inline fun <E : R, R> KoneIterator<E>.reduceOrNull(operation: (acc: R, E) -> R): R?

reversed

fun <E> KoneReversibleIterator<E>.reversed(): KoneReversibleIterator<E>

runningFold

inline fun <E, R> KoneIterator<E>.runningFold(initial: R, operation: (acc: R, E) -> R): KoneList<R>

runningFoldIndexed

inline fun <E, R> KoneIterator<E>.runningFoldIndexed(initial: R, operation: (index: UInt, acc: R, E) -> R): KoneList<R>

withIndex

fun <E> KoneIterator<E>.withIndex(): KoneIterator<KoneIndexedValue<E>>