kmath-coroutines/space.kscience.kmath.chains

Package space.kscience.kmath.chains

Types

BlockingBufferChain

interface BlockingBufferChain<out T> : BlockingChain<T> , BufferChain<T>

interface BlockingChain<out T> : Chain<T>

A chain with blocking generator that could be used without suspension

BlockingDoubleChain

interface BlockingDoubleChain : BlockingBufferChain<Double>

Chunked, specialized chain for double values, which supports blocking nextBlocking operation

BlockingIntChain

interface BlockingIntChain : BlockingBufferChain<Int>

Performance optimized chain for integer values

interface BufferChain<out T> : Chain<T>

interface Chain<out T> : Flow<T>

A not-necessary-Markov chain of some type

class ConstantChain<out T>(value: T) : Chain<T>

A chain that repeats the same value

class MarkovChain<out R : Any>(seed: suspend () -> R, gen: suspend (R) -> R) : Chain<R>

A stateless Markov chain

class SimpleChain<out R>(gen: suspend () -> R) : Chain<R>

A simple chain of independent tokens. fork returns the same chain.

class StatefulChain<S, out R>(state: S, seed: S.() -> R, forkState: (S) -> S, gen: suspend S.(R) -> R) : Chain<R>

A chain with possibly mutable state. The state must not be changed outside the chain. Two chins should never share the state.

Functions

fun <T> Iterator<T>.asChain(): Chain<T>

fun <T> Sequence<T>.asChain(): Chain<T>

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

Represent a chain as a sequence

@UnstableKMathAPI

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

Map the whole chain

combineWithState

@UnstableKMathAPI

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

fun <T> Flow<T>.cumulativeSum(group: GroupOps<T>): Flow<T>

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

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

Represent a chain as regular iterator (uses blocking calls)

fun BlockingDoubleChain.map(transform: (Double) -> Double): BlockingDoubleChain

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

Map the chain result using suspended transformation. Initial chain result can no longer be safely consumed since mapped chain consumes tokens. Accepts regular transformation function.

@ExperimentalCoroutinesApi

fun <T, S : Ring<T>, ScaleOperations<T>> Flow<T>.mean(space: S): Flow<T>

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

nextBufferBlocking

inline fun <T : Any> BlockingChain<T>.nextBufferBlocking(size: Int): Buffer<T>

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

Zip two chains together using given transformation