cats.Eval

Compute

sealed abstract class Compute[A] extends Eval[A]

Compute is a type of Eval[A] that is used to chain computations involving .map and .flatMap. Along with Eval#flatMap it implements the trampoline that guarantees stack-safety.

Users should not instantiate Compute instances themselves. Instead, they will be automatically created when needed.

Unlike a traditional trampoline, the internal workings of the trampoline are not exposed. This allows a slightly more efficient implementation of the .value method.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Compute
  2. Eval
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Compute()

Type Members

  1. abstract type Start

Abstract Value Members

  1. abstract val run: (Start) ⇒ Eval[A]

  2. abstract val start: () ⇒ Eval[Start]

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def flatMap[B](f: (A) ⇒ Eval[B]): Eval[B]

    Lazily perform a computation based on an Eval[A], using the function f to produce an Eval[B] given an A.

    Lazily perform a computation based on an Eval[A], using the function f to produce an Eval[B] given an A.

    This call is stack-safe -- many .flatMap calls may be chained without consumed additional stack during evaluation. It is also written to avoid left-association problems, so that repeated calls to .flatMap will be efficiently applied.

    Computation performed in f is always lazy, even when called on an eager (Now) instance.

    Definition Classes
    Eval
  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  15. def map[B](f: (A) ⇒ B): Eval[B]

    Transform an Eval[A] into an Eval[B] given the transformation function f.

    Transform an Eval[A] into an Eval[B] given the transformation function f.

    This call is stack-safe -- many .map calls may be chained without consumed additional stack during evaluation.

    Computation performed in f is always lazy, even when called on an eager (Now) instance.

    Definition Classes
    Eval
  16. def memoize: Eval[A]

    Ensure that the result of the computation (if any) will be memoized.

    Ensure that the result of the computation (if any) will be memoized.

    Practically, this means that when called on an Always[A] a Later[A] with an equivalent computation will be returned.

    Definition Classes
    ComputeEval
  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  21. def toString(): String

    Definition Classes
    AnyRef → Any
  22. def value: A

    Evaluate the computation and return an A value.

    Evaluate the computation and return an A value.

    For lazy instances (Later, Always), any necessary computation will be performed at this point. For eager instances (Now), a value will be immediately returned.

    Definition Classes
    ComputeEval
  23. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Eval[A]

Inherited from AnyRef

Inherited from Any

Ungrouped