Chain

interface Chain<out T> : Flow<T>

A not-necessary-Markov chain of some type

Parameters

the chain element type

Types

Companion

common

object Companion

Functions

collect

common

open suspend override fun collect(collector: FlowCollector<T>)

fork

common

abstract suspend fun fork(): Chain<T>

Create a copy of current chain state.

common

abstract suspend fun next(): T

Generate next value, changing state if needed

Inheritors

BufferChain

BlockingChain

SimpleChain

MarkovChain

StatefulChain

ConstantChain

Extensions

asSequence

jvm

fun <R> Chain<R>.asSequence(): Sequence<R>

Represent a chain as a sequence

collect

common

fun <T, R> Chain<T>.collect(mapper: suspend (Chain<T>) -> R): Chain<R>

Map the whole chain

collectWithState

common

fun <T, S, R> Chain<T>.collectWithState(state: S, stateFork: (S) -> S, mapper: suspend S.(Chain<T>) -> R): Chain<R>

filter

common

fun <T> Chain<T>.filter(block: (T) -> Boolean): Chain<T>

block must be a pure function or at least not use external random variables, otherwise fork could be broken

iterator

jvm

operator fun <R> Chain<R>.iterator(): Iterator<R>

Represent a chain as regular iterator (uses blocking calls)

map

common

fun <T, R> Chain<T>.map(func: suspend (T) -> R): Chain<R>

Map the chain result using suspended transformation.

nextBuffer

common

inline suspend fun <T : Any> Chain<T>.nextBuffer(size: Int): Buffer<T>

zip

common

fun <T, U, R> Chain<T>.zip(other: Chain<U>, block: suspend (T, U) -> R): Chain<R>

Zip two chains together using given transformation