kone.collections/dev.lounres.kone.collections.sequence

Package-level declarations

Types

KoneSequence

fun interface KoneSequence<out Element>

Represents a sequence of elements that can be accessed via its iterator.

KoneSequenceCacheThreadSafetyMode

enum KoneSequenceCacheThreadSafetyMode : Enum<KoneSequenceCacheThreadSafetyMode>

Thread-safety modes for caching a KoneSequence.

Functions

asKoneSequence

fun <Element> KoneIterable<Element>.asKoneSequence(): KoneSequence<Element>

Converts this KoneIterable to a KoneSequence by returning this iterable's iterators.

fun <Element> KoneIterator<Element>.asKoneSequence(): KoneSequence<Element>

Converts this KoneIterator to a KoneSequence by wrapping it.

build

fun <Element> KoneSequence.Companion.build(builder: suspend KoneIteratorBuilder<Element>.() -> Unit): KoneSequence<Element>

Builds a KoneSequence using the provided coroutine-based builder function.

cached

fun <Element> KoneSequence<Element>.cached(mode: KoneSequenceCacheThreadSafetyMode = NONE): KoneSequence<Element>

Returns a cached (memorized) version of this sequence.

empty

fun <Element> KoneSequence.Companion.empty(): KoneSequence<Element>

Returns an empty KoneSequence.

fill

fun <Element> KoneSequence.Companion.fill(element: Element): KoneSequence<Element>

Creates an infinite KoneSequence filled with the specified element.

fun <Element> KoneSequence.Companion.fill(size: UInt, element: Element): KoneSequence<Element>

Creates a finite KoneSequence of the given size filled with the specified element.

generate

fun <Element> KoneSequence.Companion.generate(initializer: (index: UInt) -> Element): KoneSequence<Element>

Creates an infinite KoneSequence by invoking the initializer function for each index (i.e. for each natural number from 0 to positive infinity).

fun <Element> KoneSequence.Companion.generate(size: UInt, initializer: (index: UInt) -> Element): KoneSequence<Element>

Creates a finite KoneSequence of the given size by invoking the initializer function for each index on each element access.

fun <Element> KoneSequence.Companion.generate(indices: UIntRange, initializer: (index: UInt) -> Element): KoneSequence<Element>

Creates a KoneSequence for the given indices range by invoking the initializer function for each index on each element access.

induce

fun <Element> KoneSequence.Companion.induce(initialElement: Element, inducer: (index: UInt, previous: Element) -> Element): KoneSequence<Element>

Creates an infinite KoneSequence by induction: starting from initialElement, each subsequent element is produced by applying inducer to the previous element.

fun <Element> KoneSequence.Companion.induce(size: UInt, initialElement: Element, inducer: (index: UInt, previous: Element) -> Element): KoneSequence<Element>

Creates a finite KoneSequence by induction: starting from initialElement, each subsequent element is produced by applying inducer to the previous element.

fun <Element> KoneSequence.Companion.induce(indices: UIntRange, initialElement: Element, inducer: (index: UInt, previous: Element) -> Element): KoneSequence<Element>

Creates a KoneSequence by induction over the given indices range: starting from initialElement, each subsequent element is produced by applying inducer to the previous element.

fun <Element> KoneSequence.Companion.of(vararg elements: Element): KoneSequence<Element>

Creates a KoneSequence from the given vararg elements.