java.lang.Object

com.jnape.palatable.lambda.monad.transformer.builtin.LazyT<M,A>

Type Parameters:: M - the outer stack-safe monad; A - the carrier type

All Implemented Interfaces:: Applicative<A,LazyT<M,?>>, Functor<A,LazyT<M,?>>, Monad<A,LazyT<M,?>>, MonadBase<M,A,LazyT<?,?>>, MonadRec<A,LazyT<M,?>>, MonadT<M,A,LazyT<M,?>,LazyT<?,?>>

public final class LazyT<M extends MonadRec<?,M>,A> extends Object implements MonadT<M,A,LazyT<M,?>,LazyT<?,?>>

A monad transformer for Lazy. Note that both flatMap(Fn1) and

trampolineM(com.jnape.palatable.lambda.functions.Fn1<? super A, ? extends com.jnape.palatable.lambda.monad.MonadRec<com.jnape.palatable.lambda.functions.recursion.RecursiveResult<A, B>, com.jnape.palatable.lambda.monad.transformer.builtin.LazyT<M, ?>>>)

must force its value.

Field Summary

Fields

Modifier and Type

Field

Description

private final MonadRec<Lazy<A>,M>

mla
Constructor Summary

Constructors

Modifier

Constructor

Description

private

LazyT(MonadRec<Lazy<A>,M> mla)
Method Summary

Modifier and Type

Method

Description

 LazyT<M,B>

discardL(Applicative<B,LazyT<M,?>> appB)

Sequence both this Applicative and appB, discarding this Applicative's result and returning appB.

 LazyT<M,A>

discardR(Applicative<B,LazyT<M,?>> appB)

Sequence both this Applicative and appB, discarding appB's result and returning this Applicative.

boolean

equals(Object other)

 LazyT<M,B>

flatMap(Fn1<? super A,? extends Monad<B,LazyT<M,?>>> f)

Chain dependent computations that may continue or short-circuit based on previous results.

 LazyT<M,B>

fmap(Fn1<? super A,? extends B> fn)

Covariantly transmute this functor's parameter using the given mapping function.

int

hashCode()

static <M extends MonadRec<?, M>, A> LazyT<M,A>

lazyT(MonadRec<Lazy<A>,M> mla)

Static factory method for lifting a Monad<Lazy<A>, M> into a LazyT.

 Lazy<LazyT<M,B>>

lazyZip(Lazy<? extends Applicative<Fn1<? super A,? extends B>,LazyT<M,?>>> lazyAppFn)

Given a lazy instance 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>> LazyT<N,B>

lift(MonadRec<B,N> mb)

Lift a new argument MonadRec into this MonadBase.

static Lift<LazyT<?,?>>

liftLazyT()

Lift for LazyT.

 LazyT<M,B>

pure(B b)

Lift the value b into this applicative functor.

static <M extends MonadRec<?, M>> Pure<LazyT<M,?>>

pureLazyT(Pure<M> pureM)

The canonical Pure instance for LazyT.

<MLA extends MonadRec<Lazy<A>, M>> MLA

runLazyT()

Recover the full structure of the embedded Monad.

String

toString()

 LazyT<M,B>

trampolineM(Fn1<? super A,? extends MonadRec<RecursiveResult<A,B>,LazyT<M,?>>> fn)

Given some operation yielding a RecursiveResult inside this MonadRec, internally trampoline the operation until it yields a termination instruction.

 LazyT<M,B>

zip(Applicative<Fn1<? super A,? extends B>,LazyT<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.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.jnape.palatable.lambda.functor.Functor
coerce

Field Details
- mla
 
 private final MonadRec<Lazy<A>,M extends MonadRec<?,M>> mla
Constructor Details
- LazyT
 
 private LazyT(MonadRec<Lazy<A>,M> mla)
Method Details
- runLazyT
 
 public <MLA extends MonadRec<Lazy<A>, M>> MLA runLazyT()
 
 Recover the full structure of the embedded Monad.
 
 Type Parameters:
 
 MLA - the witnessed target type
 
 Returns:
 
 the embedded Monad
- lift
 
 public <B, N extends MonadRec<?, N>> LazyT<N,B> lift(MonadRec<B,N> mb)
 
 Lift a new argument MonadRec into this MonadBase.
 
 Specified by:
 
 lift in interface MonadBase<M extends MonadRec<?,M>,A,LazyT<?,?>>
 
 Specified by:
 
 lift in interface MonadT<M extends MonadRec<?,M>,A,LazyT<M extends MonadRec<?,M>,?>,LazyT<?,?>>
 
 Type Parameters:
 
 B - the MonadRec carrier type
 
 N - the argument MonadRec witness
 
 Parameters:
 
 mb - the argument MonadRec
 
 Returns:
 
 the new MonadBase
- flatMap
 
 public LazyT<M,B> flatMap(Fn1<? super A,? extends Monad<B,LazyT<M,?>>> f)
 
 Chain dependent computations that may continue or short-circuit based on previous results.
 
 Specified by:
 
 flatMap in interface Monad<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 flatMap in interface MonadRec<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 flatMap in interface MonadT<M extends MonadRec<?,M>,A,LazyT<M extends MonadRec<?,M>,?>,LazyT<?,?>>
 
 Type Parameters:
 
 B - the resulting monad parameter type
 
 Parameters:
 
 f - the dependent computation over A
 
 Returns:
 
 the new monad instance
- trampolineM
 
 public LazyT<M,B> trampolineM(Fn1<? super A,? extends MonadRec<RecursiveResult<A,B>,LazyT<M,?>>> fn)
 
 Given some operation yielding a RecursiveResult inside this MonadRec, internally trampoline the operation until it yields a termination instruction.
 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:
 
 trampolineM in interface MonadRec<M extends MonadRec<?,M>,A>
 
 Type Parameters:
 
 B - the ultimate resulting carrier type
 
 Parameters:
 
 fn - the function to internally trampoline
 
 Returns:
 
 the trampolined MonadRec
 
 See Also:
 
 for a basic implementation
 
 for a coproduct implementation
 
 for an implementation leveraging an already stack-safe Monad#flatMap(Fn1)
 
 for a monad transformer implementation
- pure
 
 public LazyT<M,B> pure(B b)
 
 Lift the value b into this applicative functor.
 
 Specified by:
 
 pure in interface Applicative<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 pure in interface Monad<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 pure in interface MonadRec<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 pure in interface MonadT<M extends MonadRec<?,M>,A,LazyT<M extends MonadRec<?,M>,?>,LazyT<?,?>>
 
 Type Parameters:
 
 B - the type of the returned applicative's parameter
 
 Parameters:
 
 b - the value
 
 Returns:
 
 an instance of this applicative over b
- fmap
 
 public LazyT<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:
 
 fmap in interface Applicative<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 fmap in interface Functor<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 fmap in interface Monad<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 fmap in interface MonadRec<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 fmap in interface MonadT<M extends MonadRec<?,M>,A,LazyT<M extends MonadRec<?,M>,?>,LazyT<?,?>>
 
 Type Parameters:
 
 B - the new parameter type
 
 Parameters:
 
 fn - the mapping function
 
 Returns:
 
 a functor over B (the new parameter type)
- zip
 
 public LazyT<M,B> zip(Applicative<Fn1<? super A,? extends B>,LazyT<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:
 
 zip in interface Applicative<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 zip in interface Monad<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 zip in interface MonadRec<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 zip in interface MonadT<M extends MonadRec<?,M>,A,LazyT<M extends MonadRec<?,M>,?>,LazyT<?,?>>
 
 Type Parameters:
 
 B - the resulting applicative parameter type
 
 Parameters:
 
 appFn - the other applicative instance
 
 Returns:
 
 the mapped applicative
- lazyZip
 
 public Lazy<LazyT<M,B>> lazyZip(Lazy<? extends Applicative<Fn1<? super A,? extends B>,LazyT<M,?>>> lazyAppFn)
 
 Given a lazy instance 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:
 
 lazyZip in interface Applicative<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 lazyZip in interface Monad<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 lazyZip in interface MonadRec<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 lazyZip in interface MonadT<M extends MonadRec<?,M>,A,LazyT<M extends MonadRec<?,M>,?>,LazyT<?,?>>
 
 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 LazyT<M,B> discardL(Applicative<B,LazyT<M,?>> appB)
 
 Sequence both this Applicative and appB, discarding this Applicative's result and returning appB. This is generally useful for sequentially performing side-effects.
 
 Specified by:
 
 discardL in interface Applicative<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 discardL in interface Monad<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 discardL in interface MonadRec<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 discardL in interface MonadT<M extends MonadRec<?,M>,A,LazyT<M extends MonadRec<?,M>,?>,LazyT<?,?>>
 
 Type Parameters:
 
 B - the type of the returned Applicative's parameter
 
 Parameters:
 
 appB - the other Applicative
 
 Returns:
 
 appB
- discardR
 
 public LazyT<M,A> discardR(Applicative<B,LazyT<M,?>> appB)
 
 Sequence both this Applicative and appB, discarding appB's result and returning this Applicative. This is generally useful for sequentially performing side-effects.
 
 Specified by:
 
 discardR in interface Applicative<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 discardR in interface Monad<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 discardR in interface MonadRec<M extends MonadRec<?,M>,A>
 
 Specified by:
 
 discardR in interface MonadT<M extends MonadRec<?,M>,A,LazyT<M extends MonadRec<?,M>,?>,LazyT<?,?>>
 
 Type Parameters:
 
 B - the type of appB's parameter
 
 Parameters:
 
 appB - the other Applicative
 
 Returns:
 
 this Applicative
- equals
 
 public boolean equals(Object other)
 
 Overrides:
 
 equals in class Object
- hashCode
 
 public int hashCode()
 
 Overrides:
 
 hashCode in class Object
- toString
 
 public String toString()
 
 Overrides:
 
 toString in class Object
- lazyT
 
 public static <M extends MonadRec<?, M>, A> LazyT<M,A> lazyT(MonadRec<Lazy<A>,M> mla)
 
 Static factory method for lifting a Monad<Lazy<A>, M> into a LazyT.
 
 Type Parameters:
 
 M - the outer Monad unification parameter
 
 A - the carrier type
 
 Parameters:
 
 mla - the Monad<Lazy<A>, M>
 
 Returns:
 
 the new LazyT
- pureLazyT
 
 public static <M extends MonadRec<?, M>> Pure<LazyT<M,?>> pureLazyT(Pure<M> pureM)
 
 The canonical Pure instance for LazyT.
 
 Type Parameters:
 
 M - the argument Monad witness
 
 Parameters:
 
 pureM - the argument Monad Pure
 
 Returns:
 
 the Pure instance
- liftLazyT
 
 public static Lift<LazyT<?,?>> liftLazyT()
 
 Lift for LazyT.
 
 Returns:
 
 the Monad lifted into LazyT

Class LazyT<M extends MonadRec<?,M>,A>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.jnape.palatable.lambda.functor.Functor

Field Details

mla

Constructor Details

LazyT

Method Details

runLazyT

lift

flatMap

trampolineM

pure

fmap

zip

lazyZip

discardL

discardR

equals

hashCode

toString

lazyT

pureLazyT

liftLazyT