Trait/Object

org.atnos.origami

Fold

Related Docs: object Fold | package origami

Permalink

trait Fold[R, A, B] extends AnyRef

A Fold is a "left fold" over a data structure with:

Both 'start' and 'end' have an effect which allows the whole folding to take place inside a context.

Self Type
Fold[R, A, B]
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Fold
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type S

    Permalink

Abstract Value Members

  1. abstract def end(s: S): Eff[R, B]

    Permalink
  2. abstract def fold: (S, A) ⇒ S

    Permalink
  3. abstract def start: Eff[R, S]

    Permalink

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def &&&[C](f: Fold[R, A, C]): Fold[R, A, (B, C)] { type S = (Fold.this.S, f.S) }

    Permalink

    fanout = zip in the Arrow terminology

  4. def ***[V, W](f: Fold[R, V, W]): Fold[R, (A, V), (B, W)] { type S = (Fold.this.S, f.S) }

    Permalink

    parallel composition

  5. def *>[C](f: Fold[R, A, C]): Fold[R, A, C]

    Permalink

    zip with another fold, running this one only for its side effects

  6. def <*[C](f: Fold[R, A, C]): Fold[R, A, B] { type S = (Fold.this.S, f.S) }

    Permalink

    zip with another fold only for its side effects

  7. def <*>[C](f: Fold[R, A, C]): Fold[R, A, (B, C)] { type S = (Fold.this.S, f.S) }

    Permalink

    zip 2 folds to return a pair of values.

    zip 2 folds to return a pair of values. alias for zip

  8. def <+*(sink: Sink[R, S]): Fold[R, A, B] { type S = (Fold.this.S, sink.S) }

    Permalink

    alias for observeNextState

  9. def <-*(sink: Sink[R, S]): Fold[R, A, B] { type S = (Fold.this.S, sink.S) }

    Permalink

    alias for observeState

  10. def <<+*(sink: Sink[R, (A, S)]): Fold[R, A, B] { type S = (Fold.this.S, sink.S) }

    Permalink

    alias for observeWithNextState

  11. def <<-*(sink: Sink[R, (A, S)]): Fold[R, A, B] { type S = (Fold.this.S, sink.S) }

    Permalink

    alias for observeWithState

  12. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def as[C](c: ⇒ C): Fold[R, A, C] { type S = Fold.this.S }

    Permalink

    equivalent of the as method for functors, added here for easier type inference

  14. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  15. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def compose[C](f2: Fold[R, B, C]): Fold[R, A, C] { type S = org.atnos.eff.Eff[R,(Fold.this.S, f2.S)] }

    Permalink

    pipe the output of this fold into another fold

  17. def contramap[C](f: (C) ⇒ A): Fold[R, C, B] { type S = Fold.this.S }

    Permalink

    contramap the input values

  18. def endWith(action: Eff[R, Unit]): Fold[R, A, B]

    Permalink
  19. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  24. def into[U](implicit intoPoly: IntoPoly[R, U]): Fold[U, A, B] { type S = Fold.this.S }

    Permalink

    use a transformation to go from effect stack to another

  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  26. def map[C](f: (B) ⇒ C): Fold[R, A, C] { type S = Fold.this.S }

    Permalink

    map the output value

  27. def mapFlatten[C](f: (B) ⇒ Eff[R, C]): Fold[R, A, C] { type S = Fold.this.S }

    Permalink

    flatMap the output value

  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. def nest[F[_], C](f: (C) ⇒ F[A])(implicit monoid: Monoid[B], foldable: Foldable[F]): Fold[R, C, B] { type S = org.atnos.eff.Eff[R,B] }

    Permalink

    create a fold that will run this fold repeatedly on input elements and collect all results

  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. def observe[C](f: Fold[R, A, C]): Fold[R, A, B] { type S = (Fold.this.S, f.S) }

    Permalink

    alias for <*

  33. def observeNextState(sink: Sink[R, S]): Fold[R, A, B] { type S = (Fold.this.S, sink.S) }

    Permalink

    observe the next state

  34. def observeState(sink: Sink[R, S]): Fold[R, A, B] { type S = (Fold.this.S, sink.S) }

    Permalink

    observe the current state

  35. def observeWithNextState(sink: Sink[R, (A, S)]): Fold[R, A, B] { type S = (Fold.this.S, sink.S) }

    Permalink

    observe both the input value and the next state

  36. def observeWithState(sink: Sink[R, (A, S)]): Fold[R, A, B] { type S = (Fold.this.S, sink.S) }

    Permalink

    observe both the input value and the current state

  37. def observedBy[C](f: Fold[R, A, C]): Fold[R, A, C]

    Permalink

    alias for *>

  38. def pipe[C](f: Fold[R, B, C]): Fold[R, A, C] { type S = Fold.this.S }

    Permalink

    run another fold on the end result

  39. def run[F[_]](foldable: F[A])(implicit arg0: Foldable[F]): Eff[R, B]

    Permalink

    run a Fold with a Foldable instance

  40. def run1(a: A): Eff[R, B]

    Permalink

    run over one element

  41. def startWith(action: Eff[R, Unit]): Fold[R, A, B]

    Permalink
  42. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  43. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  44. def void: Fold[R, A, Unit] { type S = Fold.this.S }

    Permalink

    equivalent of the void method for functors, added here for easier type inference

  45. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. def zip[C](f: Fold[R, A, C]): Fold[R, A, (B, C)] { type S = (Fold.this.S, f.S) }

    Permalink

    zip 2 folds to return a pair of values.

    zip 2 folds to return a pair of values. alias for <*>

Inherited from AnyRef

Inherited from Any

Ungrouped