BindRec

Companion object BindRec

trait BindRec[F[_]] extends Bind[F]

scalaz.Bind capable of using constant stack space when doing recursive binds.

Implementations of tailrecM should not make recursive calls without the @tailrec annotation.

Based on Phil Freeman's work on stack safety in PureScript, described in Stack Safety for Free.

Self Type: BindRec[F]
Source: BindRec.scala

Linear Supertypes

Bind[F], Apply[F], Functor[F], InvariantFunctor[F], AnyRef, Any

Known Subclasses

IsomorphismBindRec

Ordering

Alphabetic
By Inheritance

Inherited

BindRec
Bind
Apply
Functor
InvariantFunctor
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

trait ApplyLaw extends FunctorLaw

Definition Classes
Apply
trait BindLaw extends ApplyLaw

Definition Classes
Bind
trait BindRecLaw extends BindLaw
trait FunctorLaw extends InvariantFunctorLaw

Definition Classes
Functor
trait InvariantFunctorLaw extends AnyRef

Definition Classes
InvariantFunctor

Abstract Value Members

abstract def bind[A, B](fa: F[A])(f: (A) ⇒ F[B]): F[B]
Equivalent to join(map(fa)(f)).
Equivalent to join(map(fa)(f)).

Definition Classes
Bind
abstract def map[A, B](fa: F[A])(f: (A) ⇒ B): F[B]
Lift f into F and apply to F[A].
Lift f into F and apply to F[A].

Definition Classes
Functor
abstract def tailrecM[A, B](f: (A) ⇒ F[\/[A, B]])(a: A): F[B]

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
def ap[A, B](fa: ⇒ F[A])(f: ⇒ F[(A) ⇒ B]): F[B]
Sequence f, then fa, combining their results by function application.
Sequence f, then fa, combining their results by function application.
NB: with respect to apply2 and all other combinators, as well as scalaz.Bind, the f action appears to the *left*. So f should be the "first" F-action to perform. This is in accordance with all other implementations of this typeclass in common use, which are "function first".

Definition Classes
Bind → Apply
def ap2[A, B, C](fa: ⇒ F[A], fb: ⇒ F[B])(f: F[(A, B) ⇒ C]): F[C]

Definition Classes
Apply
def ap3[A, B, C, D](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C])(f: F[(A, B, C) ⇒ D]): F[D]

Definition Classes
Apply
def ap4[A, B, C, D, E](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D])(f: F[(A, B, C, D) ⇒ E]): F[E]

Definition Classes
Apply
def ap5[A, B, C, D, E, R](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D], fe: ⇒ F[E])(f: F[(A, B, C, D, E) ⇒ R]): F[R]

Definition Classes
Apply
def ap6[A, B, C, D, E, FF, R](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D], fe: ⇒ F[E], ff: ⇒ F[FF])(f: F[(A, B, C, D, E, FF) ⇒ R]): F[R]

Definition Classes
Apply
def ap7[A, B, C, D, E, FF, G, R](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D], fe: ⇒ F[E], ff: ⇒ F[FF], fg: ⇒ F[G])(f: F[(A, B, C, D, E, FF, G) ⇒ R]): F[R]

Definition Classes
Apply
def ap8[A, B, C, D, E, FF, G, H, R](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D], fe: ⇒ F[E], ff: ⇒ F[FF], fg: ⇒ F[G], fh: ⇒ F[H])(f: F[(A, B, C, D, E, FF, G, H) ⇒ R]): F[R]

Definition Classes
Apply
def apF[A, B](f: ⇒ F[(A) ⇒ B]): (F[A]) ⇒ F[B]
Flipped variant of ap.
Flipped variant of ap.

Definition Classes
Apply
def apply[A, B](fa: F[A])(f: (A) ⇒ B): F[B]
Alias for map.
Alias for map.

Definition Classes
Functor
def apply10[A, B, C, D, E, FF, G, H, I, J, R](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D], fe: ⇒ F[E], ff: ⇒ F[FF], fg: ⇒ F[G], fh: ⇒ F[H], fi: ⇒ F[I], fj: ⇒ F[J])(f: (A, B, C, D, E, FF, G, H, I, J) ⇒ R): F[R]

Definition Classes
Apply
def apply11[A, B, C, D, E, FF, G, H, I, J, K, R](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D], fe: ⇒ F[E], ff: ⇒ F[FF], fg: ⇒ F[G], fh: ⇒ F[H], fi: ⇒ F[I], fj: ⇒ F[J], fk: ⇒ F[K])(f: (A, B, C, D, E, FF, G, H, I, J, K) ⇒ R): F[R]

Definition Classes
Apply
def apply12[A, B, C, D, E, FF, G, H, I, J, K, L, R](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D], fe: ⇒ F[E], ff: ⇒ F[FF], fg: ⇒ F[G], fh: ⇒ F[H], fi: ⇒ F[I], fj: ⇒ F[J], fk: ⇒ F[K], fl: ⇒ F[L])(f: (A, B, C, D, E, FF, G, H, I, J, K, L) ⇒ R): F[R]

Definition Classes
Apply
def apply2[A, B, C](fa: ⇒ F[A], fb: ⇒ F[B])(f: (A, B) ⇒ C): F[C]

Definition Classes
Apply
def apply3[A, B, C, D](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C])(f: (A, B, C) ⇒ D): F[D]

Definition Classes
Apply
def apply4[A, B, C, D, E](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D])(f: (A, B, C, D) ⇒ E): F[E]

Definition Classes
Apply
def apply5[A, B, C, D, E, R](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D], fe: ⇒ F[E])(f: (A, B, C, D, E) ⇒ R): F[R]

Definition Classes
Apply
def apply6[A, B, C, D, E, FF, R](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D], fe: ⇒ F[E], ff: ⇒ F[FF])(f: (A, B, C, D, E, FF) ⇒ R): F[R]

Definition Classes
Apply
def apply7[A, B, C, D, E, FF, G, R](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D], fe: ⇒ F[E], ff: ⇒ F[FF], fg: ⇒ F[G])(f: (A, B, C, D, E, FF, G) ⇒ R): F[R]

Definition Classes
Apply
def apply8[A, B, C, D, E, FF, G, H, R](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D], fe: ⇒ F[E], ff: ⇒ F[FF], fg: ⇒ F[G], fh: ⇒ F[H])(f: (A, B, C, D, E, FF, G, H) ⇒ R): F[R]

Definition Classes
Apply
def apply9[A, B, C, D, E, FF, G, H, I, R](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D], fe: ⇒ F[E], ff: ⇒ F[FF], fg: ⇒ F[G], fh: ⇒ F[H], fi: ⇒ F[I])(f: (A, B, C, D, E, FF, G, H, I) ⇒ R): F[R]

Definition Classes
Apply
def applyApplicative: Applicative[[α]\/[F[α], α]]
Add a unit to any Apply to form an Applicative.
Add a unit to any Apply to form an Applicative.

Definition Classes
Apply
def applyLaw: ApplyLaw

Definition Classes
Apply
val applySyntax: ApplySyntax[F]

Definition Classes
Apply
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bicompose[G[_, _]](implicit arg0: Bifunctor[G]): Bifunctor[[α, β]F[G[α, β]]]
The composition of Functor F and Bifunctor G, [x, y]F[G[x, y]], is a Bifunctor
The composition of Functor F and Bifunctor G, [x, y]F[G[x, y]], is a Bifunctor

Definition Classes
Functor
def bindLaw: BindLaw

Definition Classes
Bind
def bindRecLaw: BindRecLaw
val bindRecSyntax: BindRecSyntax[F]
val bindSyntax: BindSyntax[F]

Definition Classes
Bind
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def compose[G[_]](implicit G0: Apply[G]): Apply[[α]F[G[α]]]
The composition of Applys F and G, [x]F[G[x]], is a Apply
The composition of Applys F and G, [x]F[G[x]], is a Apply

Definition Classes
Apply
def compose[G[_]](implicit G0: Functor[G]): Functor[[α]F[G[α]]]
The composition of Functors F and G, [x]F[G[x]], is a Functor
The composition of Functors F and G, [x]F[G[x]], is a Functor

Definition Classes
Functor
def counzip[A, B](a: \/[F[A], F[B]]): F[\/[A, B]]

Definition Classes
Functor
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def forever[A, B](fa: F[A]): F[B]
Repeats a monadic action infinitely
Repeats a monadic action infinitely

Definition Classes
BindRec → Bind
def fpair[A](fa: F[A]): F[(A, A)]
Twin all As in fa.
Twin all As in fa.

Definition Classes
Functor
def fproduct[A, B](fa: F[A])(f: (A) ⇒ B): F[(A, B)]
Pair all As in fa with the result of function application.
Pair all As in fa with the result of function application.

Definition Classes
Functor
def functorLaw: FunctorLaw

Definition Classes
Functor
val functorSyntax: FunctorSyntax[F]

Definition Classes
Functor
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def icompose[G[_]](implicit G0: Contravariant[G]): Contravariant[[α]F[G[α]]]
The composition of Functor F and Contravariant G, [x]F[G[x]], is contravariant.
The composition of Functor F and Contravariant G, [x]F[G[x]], is contravariant.

Definition Classes
Functor
def ifM[B](value: F[Boolean], ifTrue: ⇒ F[B], ifFalse: ⇒ F[B]): F[B]
if lifted into a binding.
if lifted into a binding. Unlike lift3((t,c,a)=>if(t)c else a), this will only include context from the chosen of ifTrue and ifFalse, not the other.

Definition Classes
Bind
def invariantFunctorLaw: InvariantFunctorLaw

Definition Classes
InvariantFunctor
val invariantFunctorSyntax: InvariantFunctorSyntax[F]

Definition Classes
InvariantFunctor
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def join[A](ffa: F[F[A]]): F[A]
Sequence the inner F of FFA after the outer F, forming a single F[A].
Sequence the inner F of FFA after the outer F, forming a single F[A].

Definition Classes
Bind
def lift[A, B](f: (A) ⇒ B): (F[A]) ⇒ F[B]
Lift f into F.
Lift f into F.

Definition Classes
Functor
def lift10[A, B, C, D, E, FF, G, H, I, J, R](f: (A, B, C, D, E, FF, G, H, I, J) ⇒ R): (F[A], F[B], F[C], F[D], F[E], F[FF], F[G], F[H], F[I], F[J]) ⇒ F[R]

Definition Classes
Apply
def lift11[A, B, C, D, E, FF, G, H, I, J, K, R](f: (A, B, C, D, E, FF, G, H, I, J, K) ⇒ R): (F[A], F[B], F[C], F[D], F[E], F[FF], F[G], F[H], F[I], F[J], F[K]) ⇒ F[R]

Definition Classes
Apply
def lift12[A, B, C, D, E, FF, G, H, I, J, K, L, R](f: (A, B, C, D, E, FF, G, H, I, J, K, L) ⇒ R): (F[A], F[B], F[C], F[D], F[E], F[FF], F[G], F[H], F[I], F[J], F[K], F[L]) ⇒ F[R]

Definition Classes
Apply
def lift2[A, B, C](f: (A, B) ⇒ C): (F[A], F[B]) ⇒ F[C]

Definition Classes
Apply
def lift3[A, B, C, D](f: (A, B, C) ⇒ D): (F[A], F[B], F[C]) ⇒ F[D]

Definition Classes
Apply
def lift4[A, B, C, D, E](f: (A, B, C, D) ⇒ E): (F[A], F[B], F[C], F[D]) ⇒ F[E]

Definition Classes
Apply
def lift5[A, B, C, D, E, R](f: (A, B, C, D, E) ⇒ R): (F[A], F[B], F[C], F[D], F[E]) ⇒ F[R]

Definition Classes
Apply
def lift6[A, B, C, D, E, FF, R](f: (A, B, C, D, E, FF) ⇒ R): (F[A], F[B], F[C], F[D], F[E], F[FF]) ⇒ F[R]

Definition Classes
Apply
def lift7[A, B, C, D, E, FF, G, R](f: (A, B, C, D, E, FF, G) ⇒ R): (F[A], F[B], F[C], F[D], F[E], F[FF], F[G]) ⇒ F[R]

Definition Classes
Apply
def lift8[A, B, C, D, E, FF, G, H, R](f: (A, B, C, D, E, FF, G, H) ⇒ R): (F[A], F[B], F[C], F[D], F[E], F[FF], F[G], F[H]) ⇒ F[R]

Definition Classes
Apply
def lift9[A, B, C, D, E, FF, G, H, I, R](f: (A, B, C, D, E, FF, G, H, I) ⇒ R): (F[A], F[B], F[C], F[D], F[E], F[FF], F[G], F[H], F[I]) ⇒ F[R]

Definition Classes
Apply
def mapply[A, B](a: A)(f: F[(A) ⇒ B]): F[B]
Lift apply(a), and apply the result to f.
Lift apply(a), and apply the result to f.

Definition Classes
Functor
def mproduct[A, B](fa: F[A])(f: (A) ⇒ F[B]): F[(A, B)]
Pair A with the result of function application.
Pair A with the result of function application.

Definition Classes
Bind
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def product[G[_]](implicit G0: BindRec[G]): BindRec[[α](F[α], G[α])]
The product of BindRec F and G, [x](F[x], G[x]]), is a BindRec
def product[G[_]](implicit G0: Bind[G]): Bind[[α](F[α], G[α])]
The product of Bind F and G, [x](F[x], G[x]]), is a Bind
The product of Bind F and G, [x](F[x], G[x]]), is a Bind

Definition Classes
Bind
def product[G[_]](implicit G0: Apply[G]): Apply[[α](F[α], G[α])]
The product of Applys F and G, [x](F[x], G[x]]), is a Apply
The product of Applys F and G, [x](F[x], G[x]]), is a Apply

Definition Classes
Apply
def product[G[_]](implicit G0: Functor[G]): Functor[[α](F[α], G[α])]
The product of Functors F and G, [x](F[x], G[x]]), is a Functor
The product of Functors F and G, [x](F[x], G[x]]), is a Functor

Definition Classes
Functor
def sequence1[A, G[_]](as: G[F[A]])(implicit arg0: Traverse1[G]): F[G[A]]

Definition Classes
Apply
def strengthL[A, B](a: A, f: F[B]): F[(A, B)]
Inject a to the left of Bs in f.
Inject a to the left of Bs in f.

Definition Classes
Functor
def strengthR[A, B](f: F[A], b: B): F[(A, B)]
Inject b to the right of As in f.
Inject b to the right of As in f.

Definition Classes
Functor
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def traverse1[A, G[_], B](value: G[A])(f: (A) ⇒ F[B])(implicit G: Traverse1[G]): F[G[B]]

Definition Classes
Apply
def tuple2[A, B](fa: ⇒ F[A], fb: ⇒ F[B]): F[(A, B)]

Definition Classes
Apply
def tuple3[A, B, C](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C]): F[(A, B, C)]

Definition Classes
Apply
def tuple4[A, B, C, D](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D]): F[(A, B, C, D)]

Definition Classes
Apply
def tuple5[A, B, C, D, E](fa: ⇒ F[A], fb: ⇒ F[B], fc: ⇒ F[C], fd: ⇒ F[D], fe: ⇒ F[E]): F[(A, B, C, D, E)]

Definition Classes
Apply
def void[A](fa: F[A]): F[Unit]
Empty fa of meaningful pure values, preserving its structure.
Empty fa of meaningful pure values, preserving its structure.

Definition Classes
Functor
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def widen[A, B](fa: F[A])(implicit ev: <~<[A, B]): F[B]
Functors are covariant by nature, so we can treat an F[A] as an F[B] if A is a subtype of B.
Functors are covariant by nature, so we can treat an F[A] as an F[B] if A is a subtype of B.

Definition Classes
Functor
def xmap[A, B](fa: F[A], f: (A) ⇒ B, g: (B) ⇒ A): F[B]
Converts ma to a value of type F[B] using the provided functions f and g.
Converts ma to a value of type F[B] using the provided functions f and g.

Definition Classes
Functor → InvariantFunctor
def xmapb[A, B](ma: F[A])(b: Bijection[A, B]): F[B]
Converts ma to a value of type F[B] using the provided bijection.
Converts ma to a value of type F[B] using the provided bijection.

Definition Classes
InvariantFunctor
def xmapi[A, B](ma: F[A])(iso: Isomorphism.<=>[A, B]): F[B]
Converts ma to a value of type F[B] using the provided isomorphism.
Converts ma to a value of type F[B] using the provided isomorphism.

Definition Classes
InvariantFunctor

Packages

BindRec

Companion object BindRec

trait BindRec[F[_]] extends Bind[F]

Type Members

Abstract Value Members

Concrete Value Members

Inherited from Bind[F]

Inherited from Apply[F]

Inherited from Functor[F]

Inherited from InvariantFunctor[F]

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

BindRec 

Companion object BindRec

trait BindRec[F[_]] extends Bind[F]

Type Members

Abstract Value Members

Concrete Value Members

Inherited from Bind[F]

Inherited from Apply[F]

Inherited from Functor[F]

Inherited from InvariantFunctor[F]

Inherited from AnyRef

Inherited from Any

Ungrouped

BindRec