Copyright | (C) 2011-2015 Edward Kmett |
---|---|

License | BSD-style (see the file LICENSE) |

Maintainer | Edward Kmett <ekmett@gmail.com> |

Stability | provisional |

Portability | non-portable (rank-2 polymorphism) |

Safe Haskell | Safe |

Language | Haskell2010 |

"Free Monads for Less"

The most straightforward way of implementing free monads is as a recursive
datatype that allows for arbitrarily deep nesting of the base functor. This is
akin to a tree, with the leaves containing the values, and the nodes being a
level of `Functor`

over subtrees.

For each time that the `fmap`

or `>>=`

operations is used, the old tree is
traversed up to the leaves, a new set of nodes is allocated, and
the old ones are garbage collected. Even if the Haskell runtime
optimizes some of the overhead through laziness and generational garbage
collection, the asymptotic runtime is still quadratic.

On the other hand, if the Church encoding is used, the tree only needs to be constructed once, because:

- All uses of
`fmap`

are collapsed into a single one, so that the values on the _leaves_ are transformed in one pass.

fmap f . fmap g == fmap (f . g)

- All uses of
`>>=`

are right associated, so that every new subtree created is final.

(m >>= f) >>= g == m >>= (\x -> f x >>= g)

Asymptotically, the Church encoding supports the monadic operations more
efficiently than the naïve `Free`

.

This is based on the "Free Monads for Less" series of articles by Edward Kmett:

- newtype F f a = F {
- runF :: forall r. (a -> r) -> (f r -> r) -> r

- improve :: Functor f => (forall m. MonadFree f m => m a) -> Free f a
- fromF :: MonadFree f m => F f a -> m a
- iter :: (f a -> a) -> F f a -> a
- iterM :: Monad m => (f (m a) -> m a) -> F f a -> m a
- toF :: Functor f => Free f a -> F f a
- retract :: Monad m => F m a -> m a
- hoistF :: (forall x. f x -> g x) -> F f a -> F g a
- foldF :: Monad m => (forall x. f x -> m x) -> F f a -> m a
- class Monad m => MonadFree f m | m -> f where
- liftF :: (Functor f, MonadFree f m) => f a -> m a
- cutoff :: Functor f => Integer -> F f a -> F f (Maybe a)

# Documentation

The Church-encoded free monad for a functor `f`

.

It is *asymptotically* more efficient to use (`>>=`

) for `F`

than it is to (`>>=`

) with `Free`

.

MonadTrans F # | |

MonadReader e m => MonadReader e (F m) # | |

MonadState s m => MonadState s (F m) # | |

MonadWriter w m => MonadWriter w (F m) # | |

Functor f => MonadFree f (F f) # | |

Monad (F f) # | |

Functor (F f) # | |

MonadFix (F f) # | |

Applicative (F f) # | |

Foldable f => Foldable (F f) # | |

Alternative f => Alternative (F f) # | This violates the Alternative laws, handle with care. |

MonadPlus f => MonadPlus (F f) # | This violates the MonadPlus laws, handle with care. |

MonadCont m => MonadCont (F m) # | |

Apply (F f) # | |

Bind (F f) # | |

improve :: Functor f => (forall m. MonadFree f m => m a) -> Free f a #

Improve the asymptotic performance of code that builds a free monad with only binds and returns by using `F`

behind the scenes.

This is based on the "Free Monads for Less" series of articles by Edward Kmett:

and "Asymptotic Improvement of Computations over Free Monads" by Janis Voightländer.

hoistF :: (forall x. f x -> g x) -> F f a -> F g a #

Lift a natural transformation from `f`

to `g`

into a natural transformation from `F f`

to `F g`

.

foldF :: Monad m => (forall x. f x -> m x) -> F f a -> m a #

The very definition of a free monad is that given a natural transformation you get a monad homomorphism.

class Monad m => MonadFree f m | m -> f where #

Monads provide substitution (`fmap`

) and renormalization (`join`

):

m`>>=`

f =`join`

(`fmap`

f m)

A free `Monad`

is one that does no work during the normalization step beyond simply grafting the two monadic values together.

`[]`

is not a free `Monad`

(in this sense) because

smashes the lists flat.`join`

[[a]]

On the other hand, consider:

data Tree a = Bin (Tree a) (Tree a) | Tip a

instance`Monad`

Tree where`return`

= Tip Tip a`>>=`

f = f a Bin l r`>>=`

f = Bin (l`>>=`

f) (r`>>=`

f)

This `Monad`

is the free `Monad`

of Pair:

data Pair a = Pair a a

And we could make an instance of `MonadFree`

for it directly:

instance`MonadFree`

Pair Tree where`wrap`

(Pair l r) = Bin l r

Or we could choose to program with

instead of `Free`

Pair`Tree`

and thereby avoid having to define our own `Monad`

instance.

Moreover, Control.Monad.Free.Church provides a `MonadFree`

instance that can improve the *asymptotic* complexity of code that
constructs free monads by effectively reassociating the use of
(`>>=`

). You may also want to take a look at the `kan-extensions`

package (http://hackage.haskell.org/package/kan-extensions).

See `Free`

for a more formal definition of the free `Monad`

for a `Functor`

.

Add a layer.

wrap (fmap f x) ≡ wrap (fmap return x) >>= f

wrap :: (m ~ t n, MonadTrans t, MonadFree f n, Functor f) => f (m a) -> m a #

Add a layer.

wrap (fmap f x) ≡ wrap (fmap return x) >>= f

(Functor f, MonadFree f m) => MonadFree f (ListT m) # | |

(Functor f, MonadFree f m) => MonadFree f (MaybeT m) # | |

Functor f => MonadFree f (Free f) # | |

Functor f => MonadFree f (F f) # | |

Monad m => MonadFree Identity (IterT m) # | |

(Functor f, MonadFree f m) => MonadFree f (ExceptT e m) # | |

(Functor f, MonadFree f m, Error e) => MonadFree f (ErrorT e m) # | |

(Functor f, MonadFree f m) => MonadFree f (IdentityT * m) # | |

(Functor f, MonadFree f m, Monoid w) => MonadFree f (WriterT w m) # | |

(Functor f, MonadFree f m, Monoid w) => MonadFree f (WriterT w m) # | |

(Functor f, MonadFree f m) => MonadFree f (StateT s m) # | |

(Functor f, MonadFree f m) => MonadFree f (StateT s m) # | |

(Functor f, Monad m) => MonadFree f (FreeT f m) # | |

MonadFree f (FT f m) # | |

(Functor f, MonadFree f m) => MonadFree f (ContT * r m) # | |

(Functor f, MonadFree f m) => MonadFree f (ReaderT * e m) # | |

(Functor f, MonadFree f m, Monoid w) => MonadFree f (RWST r w s m) # | |

(Functor f, MonadFree f m, Monoid w) => MonadFree f (RWST r w s m) # | |

liftF :: (Functor f, MonadFree f m) => f a -> m a #

A version of lift that can be used with just a Functor for f.

cutoff :: Functor f => Integer -> F f a -> F f (Maybe a) #

Cuts off a tree of computations at a given depth. If the depth is 0 or less, no computation nor monadic effects will take place.

Some examples (`n ≥ 0`

):

cutoff 0 _ == return Nothing

cutoff (n+1) . return == return . Just

cutoff (n+1) . lift == lift . liftM Just

cutoff (n+1) . wrap == wrap . fmap (cutoff n)

Calling

is always terminating, provided each of the
steps in the iteration is terminating.`retract`

. `cutoff`

n