Eval

sealed class Eval<out A>(source)

Eval is a monad which controls evaluation of a value or a computation that produces a value.

Three basic evaluation strategies:

  • Now: evaluated immediately

  • Later: evaluated once when value is needed

  • Always: evaluated every time value is needed

The Later and Always are both lazy strategies while Now is eager. Later and Always are distinguished from each other only by memoization: once evaluated Later will save the value to be returned immediately if it is needed again. Always will run its computation every time.

methods, which use an internal trampoline to avoid stack overflows. Computation done within .map and .flatMap is always done lazily, even when applied to a Now instance.

It is not generally good style to pattern-match on Eval instances. Rather, use .map and .flatMap to chain computation, and use .value to get the result when needed. It is also not good style to create Eval instances whose computation involves calling .value on another Eval instance -- this can defeat the trampolining and lead to stack overflows.

Example of stack safety:

import arrow.eval.Eval

//sampleStart
fun even(n: Int): Eval<Boolean> =
Eval.always { n == 0 }.flatMap {
if(it == true) Eval.now(true)
else odd(n - 1)
}

fun odd(n: Int): Eval<Boolean> =
Eval.always { n == 0 }.flatMap {
if(it == true) Eval.now(false)
else even(n - 1)
}

// if not wrapped in eval this type of computation would blow the stack and result in a StackOverflowError
fun main() {
println(odd(100000).value())
}
//sampleEnd

Inheritors

Types

Link copied to clipboard
data class Always<out A>(f: () -> A) : Eval<A>

Construct a lazy Eval instance.

Link copied to clipboard
object Companion
Link copied to clipboard
data class Defer<out A>(val thunk: () -> Eval<A>) : Eval<A>
Link copied to clipboard
data class Later<out A>(f: () -> A) : Eval<A> , Lazy<A>

Construct a lazy Eval instance.

Link copied to clipboard
data class Now<out A>(val value: A) : Eval<A> , Lazy<A>

Functions

Link copied to clipboard
inline fun <B> coflatMap(crossinline f: (Eval<A>) -> B): Eval<B>
Link copied to clipboard
fun <B> flatMap(f: (A) -> Eval<B>): Eval<B>
Link copied to clipboard
operator fun invoke(): A
Link copied to clipboard
inline fun <B> map(crossinline f: (A) -> B): Eval<B>
Link copied to clipboard
abstract fun memoize(): Eval<A>
Link copied to clipboard
fun <A> Eval<A>.replicate(n: Int): Eval<List<A>>
fun <A, B> Eval<A>.replicate(n: Int, initial: () -> B, combine: (A, B) -> B): Eval<B>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
abstract fun value(): A
Link copied to clipboard
fun <A, B> Eval<A>.zip(b: Eval<B>): Eval<Pair<A, B>>
fun <A, B, Z> Eval<A>.zip(b: Eval<B>, map: (A, B) -> Z): Eval<Z>
fun <A, B, C, D> Eval<A>.zip(b: Eval<B>, c: Eval<C>, map: (A, B, C) -> D): Eval<D>
fun <A, B, C, D, E> Eval<A>.zip(b: Eval<B>, c: Eval<C>, d: Eval<D>, map: (A, B, C, D) -> E): Eval<E>
fun <A, B, C, D, E, F> Eval<A>.zip(b: Eval<B>, c: Eval<C>, d: Eval<D>, e: Eval<E>, map: (A, B, C, D, E) -> F): Eval<F>
fun <A, B, C, D, E, F, G> Eval<A>.zip(b: Eval<B>, c: Eval<C>, d: Eval<D>, e: Eval<E>, f: Eval<F>, map: (A, B, C, D, E, F) -> G): Eval<G>
fun <A, B, C, D, E, F, G, H> Eval<A>.zip(b: Eval<B>, c: Eval<C>, d: Eval<D>, e: Eval<E>, f: Eval<F>, g: Eval<G>, map: (A, B, C, D, E, F, G) -> H): Eval<H>
fun <A, B, C, D, E, F, G, H, I> Eval<A>.zip(b: Eval<B>, c: Eval<C>, d: Eval<D>, e: Eval<E>, f: Eval<F>, g: Eval<G>, h: Eval<H>, map: (A, B, C, D, E, F, G, H) -> I): Eval<I>
fun <A, B, C, D, E, F, G, H, I, J> Eval<A>.zip(b: Eval<B>, c: Eval<C>, d: Eval<D>, e: Eval<E>, f: Eval<F>, g: Eval<G>, h: Eval<H>, i: Eval<I>, map: (A, B, C, D, E, F, G, H, I) -> J): Eval<J>
fun <A, B, C, D, E, F, G, H, I, J, K> Eval<A>.zip(b: Eval<B>, c: Eval<C>, d: Eval<D>, e: Eval<E>, f: Eval<F>, g: Eval<G>, h: Eval<H>, i: Eval<I>, j: Eval<J>, map: (A, B, C, D, E, F, G, H, I, J) -> K): Eval<K>