Package com.jnape.palatable.lambda.monad
Class SafeT<M extends MonadRec<?,M>,A>
- java.lang.Object
-
- com.jnape.palatable.lambda.monad.SafeT<M,A>
-
- Type Parameters:
M- theMonadRecinstanceA- the carrier type
- All Implemented Interfaces:
Applicative<A,SafeT<M,?>>,Functor<A,SafeT<M,?>>,Monad<A,SafeT<M,?>>,MonadBase<M,A,SafeT<?,?>>,MonadRec<A,SafeT<M,?>>,MonadT<M,A,SafeT<M,?>,SafeT<?,?>>
public final class SafeT<M extends MonadRec<?,M>,A> extends java.lang.Object implements MonadT<M,A,SafeT<M,?>,SafeT<?,?>>
A stack-safemonad transformerthat can safely interpret deeply nested left- or right-associated binds for anyMonadRec.Example:
Times.<Fn1<Integer, Integer>>times(100_000, f -> f.fmap(x -> x + 1), id()).apply(0); // stack-overflow Times.<SafeT<Fn1<Integer, ?>, Integer>>times(100_000, f -> f.fmap(x -> x + 1), safeT(id())) .<Fn1<Integer, Integer>>runSafeT() .apply(0); // 100_000Inspired by Phil Freeman's paper Stack Safety for Free.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static classSafeT.Body<M extends MonadRec<?,M>,A>
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description <B> SafeT<M,B>discardL(Applicative<B,SafeT<M,?>> appB)Sequence both thisApplicativeandappB, discarding thisApplicative'sresult and returningappB.<B> SafeT<M,A>discardR(Applicative<B,SafeT<M,?>> appB)Sequence both thisApplicativeandappB, discardingappB'sresult and returning thisApplicative.<B> SafeT<M,B>flatMap(Fn1<? super A,? extends Monad<B,SafeT<M,?>>> f)Chain dependent computations that may continue or short-circuit based on previous results.<B> SafeT<M,B>fmap(Fn1<? super A,? extends B> fn)Covariantly transmute this functor's parameter using the given mapping function.<B> Lazy<SafeT<M,B>>lazyZip(Lazy<? extends Applicative<Fn1<? super A,? extends B>,SafeT<M,?>>> lazyAppFn)Given alazyinstance of this applicative over a mapping function, "zip" the two instances together using whatever application semantics the current applicative supports.<B,N extends MonadRec<?,N>>
SafeT<N,B>lift(MonadRec<B,N> nb)static Lift<SafeT<?,?>>liftSafeT()<B> SafeT<M,B>pure(B b)Lift the valuebinto this applicative functor.static <M extends MonadRec<?,M>>
Pure<SafeT<M,?>>pureSafeT(Pure<M> pureM)<MA extends MonadRec<A,M>>
MArunSafeT()Recover the full structure of the embeddedMonadin a stack-safe way.static <M extends MonadRec<?,M>,A>
SafeT<M,A>safeT(MonadRec<A,M> ma)<B> SafeT<M,B>trampolineM(Fn1<? super A,? extends MonadRec<RecursiveResult<A,B>,SafeT<M,?>>> bounce)Given some operation yielding aRecursiveResultinside thisMonadRec, internally trampoline the operation until it yields aterminationinstruction.<B> SafeT<M,B>zip(Applicative<Fn1<? super A,? extends B>,SafeT<M,?>> appFn)Given another instance of this applicative over a mapping function, "zip" the two instances together using whatever application semantics the current applicative supports.
-
-
-
Constructor Detail
-
SafeT
private SafeT(SafeT.Body<M,A> body, Pure<M> pureM)
-
-
Method Detail
-
runSafeT
public <MA extends MonadRec<A,M>> MA runSafeT()
Recover the full structure of the embeddedMonadin a stack-safe way.- Type Parameters:
MA- the witnessed target type- Returns:
- the embedded
Monad
-
fmap
public <B> SafeT<M,B> fmap(Fn1<? super A,? extends B> fn)
Covariantly transmute this functor's parameter using the given mapping function. Generally this method is specialized to return an instance of the class implementing Functor.- Specified by:
fmapin interfaceApplicative<M extends MonadRec<?,M>,A>- Specified by:
fmapin interfaceFunctor<M extends MonadRec<?,M>,A>- Specified by:
fmapin interfaceMonad<M extends MonadRec<?,M>,A>- Specified by:
fmapin interfaceMonadRec<M extends MonadRec<?,M>,A>- Specified by:
fmapin interfaceMonadT<M extends MonadRec<?,M>,A,SafeT<M extends MonadRec<?,M>,?>,SafeT<?,?>>- Type Parameters:
B- the new parameter type- Parameters:
fn- the mapping function- Returns:
- a functor over B (the new parameter type)
-
lift
public <B,N extends MonadRec<?,N>> SafeT<N,B> lift(MonadRec<B,N> nb)
- Specified by:
liftin interfaceMonadBase<M extends MonadRec<?,M>,A,SafeT<?,?>>- Specified by:
liftin interfaceMonadT<M extends MonadRec<?,M>,A,SafeT<M extends MonadRec<?,M>,?>,SafeT<?,?>>- Type Parameters:
B- theMonadReccarrier typeN- the argumentMonadRecwitness- Parameters:
nb- the argumentMonadRec- Returns:
- the new
MonadBase
-
flatMap
public <B> SafeT<M,B> flatMap(Fn1<? super A,? extends Monad<B,SafeT<M,?>>> f)
Chain dependent computations that may continue or short-circuit based on previous results.- Specified by:
flatMapin interfaceMonad<M extends MonadRec<?,M>,A>- Specified by:
flatMapin interfaceMonadRec<M extends MonadRec<?,M>,A>- Specified by:
flatMapin interfaceMonadT<M extends MonadRec<?,M>,A,SafeT<M extends MonadRec<?,M>,?>,SafeT<?,?>>- Type Parameters:
B- the resulting monad parameter type- Parameters:
f- the dependent computation over A- Returns:
- the new monad instance
-
zip
public <B> SafeT<M,B> zip(Applicative<Fn1<? super A,? extends B>,SafeT<M,?>> appFn)
Given another instance of this applicative over a mapping function, "zip" the two instances together using whatever application semantics the current applicative supports.- Specified by:
zipin interfaceApplicative<M extends MonadRec<?,M>,A>- Specified by:
zipin interfaceMonad<M extends MonadRec<?,M>,A>- Specified by:
zipin interfaceMonadRec<M extends MonadRec<?,M>,A>- Specified by:
zipin interfaceMonadT<M extends MonadRec<?,M>,A,SafeT<M extends MonadRec<?,M>,?>,SafeT<?,?>>- Type Parameters:
B- the resulting applicative parameter type- Parameters:
appFn- the other applicative instance- Returns:
- the mapped applicative
-
lazyZip
public <B> Lazy<SafeT<M,B>> lazyZip(Lazy<? extends Applicative<Fn1<? super A,? extends B>,SafeT<M,?>>> lazyAppFn)
Given alazyinstance of this applicative over a mapping function, "zip" the two instances together using whatever application semantics the current applicative supports. This is useful for applicatives that support lazy evaluation and early termination.- Specified by:
lazyZipin interfaceApplicative<M extends MonadRec<?,M>,A>- Specified by:
lazyZipin interfaceMonad<M extends MonadRec<?,M>,A>- Specified by:
lazyZipin interfaceMonadRec<M extends MonadRec<?,M>,A>- Specified by:
lazyZipin interfaceMonadT<M extends MonadRec<?,M>,A,SafeT<M extends MonadRec<?,M>,?>,SafeT<?,?>>- Type Parameters:
B- the resulting applicative parameter type- Parameters:
lazyAppFn- the lazy other applicative instance- Returns:
- the mapped applicative
- See Also:
Maybe,Either
-
discardL
public <B> SafeT<M,B> discardL(Applicative<B,SafeT<M,?>> appB)
Sequence both thisApplicativeandappB, discarding thisApplicative'sresult and returningappB. This is generally useful for sequentially performing side-effects.- Specified by:
discardLin interfaceApplicative<M extends MonadRec<?,M>,A>- Specified by:
discardLin interfaceMonad<M extends MonadRec<?,M>,A>- Specified by:
discardLin interfaceMonadRec<M extends MonadRec<?,M>,A>- Specified by:
discardLin interfaceMonadT<M extends MonadRec<?,M>,A,SafeT<M extends MonadRec<?,M>,?>,SafeT<?,?>>- Type Parameters:
B- the type of the returned Applicative's parameter- Parameters:
appB- the other Applicative- Returns:
- appB
-
discardR
public <B> SafeT<M,A> discardR(Applicative<B,SafeT<M,?>> appB)
Sequence both thisApplicativeandappB, discardingappB'sresult and returning thisApplicative. This is generally useful for sequentially performing side-effects.- Specified by:
discardRin interfaceApplicative<M extends MonadRec<?,M>,A>- Specified by:
discardRin interfaceMonad<M extends MonadRec<?,M>,A>- Specified by:
discardRin interfaceMonadRec<M extends MonadRec<?,M>,A>- Specified by:
discardRin interfaceMonadT<M extends MonadRec<?,M>,A,SafeT<M extends MonadRec<?,M>,?>,SafeT<?,?>>- Type Parameters:
B- the type of appB's parameter- Parameters:
appB- the other Applicative- Returns:
- this Applicative
-
pure
public <B> SafeT<M,B> pure(B b)
Lift the valuebinto this applicative functor.- Specified by:
purein interfaceApplicative<M extends MonadRec<?,M>,A>- Specified by:
purein interfaceMonad<M extends MonadRec<?,M>,A>- Specified by:
purein interfaceMonadRec<M extends MonadRec<?,M>,A>- Specified by:
purein interfaceMonadT<M extends MonadRec<?,M>,A,SafeT<M extends MonadRec<?,M>,?>,SafeT<?,?>>- Type Parameters:
B- the type of the returned applicative's parameter- Parameters:
b- the value- Returns:
- an instance of this applicative over b
-
trampolineM
public <B> SafeT<M,B> trampolineM(Fn1<? super A,? extends MonadRec<RecursiveResult<A,B>,SafeT<M,?>>> bounce)
Given some operation yielding aRecursiveResultinside thisMonadRec, internally trampoline the operation until it yields aterminationinstruction.Stack-safety depends on implementations guaranteeing that the growth of the call stack is a constant factor independent of the number of invocations of the operation. For various examples of how this can be achieved in stereotypical circumstances, see the referenced types.
- Specified by:
trampolineMin interfaceMonadRec<M extends MonadRec<?,M>,A>- Type Parameters:
B- the ultimate resulting carrier type- Parameters:
bounce- the function to internally trampoline- Returns:
- the trampolined
MonadRec - See Also:
for a basic implementation,for a implementation,for an implementation leveraging an already stack-safe,for a implementation
-
-