Copyright | (C) 2008-2013 Edward Kmett |
---|---|

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

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

Stability | provisional |

Portability | MPTCs, fundeps |

Safe Haskell | Safe |

Language | Haskell2010 |

Cofree comonads

- data Cofree f a = a :< (f (Cofree f a))
- class (Functor f, Comonad w) => ComonadCofree f w | w -> f where
- unwrap :: w a -> f (w a)

- section :: Comonad f => f a -> Cofree f a
- coiter :: Functor f => (a -> f a) -> a -> Cofree f a
- unfold :: Functor f => (b -> (a, f b)) -> b -> Cofree f a
- unfoldM :: (Traversable f, Monad m) => (b -> m (a, f b)) -> b -> m (Cofree f a)
- hoistCofree :: Functor f => (forall x. f x -> g x) -> Cofree f a -> Cofree g a
- _extract :: Functor f => (a -> f a) -> Cofree g a -> f (Cofree g a)
- _unwrap :: Functor f => (g (Cofree g a) -> f (g (Cofree g a))) -> Cofree g a -> f (Cofree g a)
- telescoped :: (Functor f, Functor g) => [(Cofree g a -> f (Cofree g a)) -> g (Cofree g a) -> f (g (Cofree g a))] -> (a -> f a) -> Cofree g a -> f (Cofree g a)

# Documentation

The `Cofree`

`Comonad`

of a functor `f`

.

*Formally*

A `Comonad`

`v`

is a cofree `Comonad`

for `f`

if every comonad homomorphism
another comonad `w`

to `v`

is equivalent to a natural transformation
from `w`

to `f`

.

A `cofree`

functor is right adjoint to a forgetful functor.

Cofree is a functor from the category of functors to the category of comonads
that is right adjoint to the forgetful functor from the category of comonads
to the category of functors that forgets how to `extract`

and
`duplicate`

, leaving you with only a `Functor`

.

In practice, cofree comonads are quite useful for annotating syntax trees, or talking about streams.

A number of common comonads arise directly as cofree comonads.

For instance,

forms the a comonad for a non-empty list.`Cofree`

`Maybe`

is a product.`Cofree`

(`Const`

b)

forms an infinite stream.`Cofree`

`Identity`

describes a Moore machine with states labeled with values of type a, and transitions on edges of type b.`Cofree`

((->) b)'

Furthermore, if the functor `f`

forms a monoid (for example, by
being an instance of `Alternative`

), the resulting `Comonad`

is
also a `Monad`

. See
Monadic Augment and Generalised Shortcut Fusion by Neil Ghani et al., Section 4.3
for more details.

In particular, if `f a ≡ [a]`

, the
resulting data structure is a Rose tree.
For a practical application, check
Higher Dimensional Trees, Algebraically by Neil Ghani et al.

class (Functor f, Comonad w) => ComonadCofree f w | w -> f where Source

Allows you to peel a layer off a cofree comonad.

ComonadCofree Maybe NonEmpty Source | |

ComonadCofree f w => ComonadCofree f (IdentityT w) Source | |

Functor f => ComonadCofree f (Cofree f) Source | |

Comonad w => ComonadCofree Identity (CoiterT w) Source | |

(ComonadCofree f w, Semigroup m, Monoid m) => ComonadCofree f (TracedT m w) Source | |

ComonadCofree f w => ComonadCofree f (StoreT s w) Source | |

ComonadCofree f w => ComonadCofree f (EnvT e w) Source | |

(Functor f, Comonad w) => ComonadCofree f (CofreeT f w) Source | |

ComonadCofree (Const b) ((,) b) Source |

unfold :: Functor f => (b -> (a, f b)) -> b -> Cofree f a Source

Unfold a cofree comonad from a seed.

unfoldM :: (Traversable f, Monad m) => (b -> m (a, f b)) -> b -> m (Cofree f a) Source

Unfold a cofree comonad from a seed, monadically.

hoistCofree :: Functor f => (forall x. f x -> g x) -> Cofree f a -> Cofree g a Source

# Lenses into cofree comonads

_unwrap :: Functor f => (g (Cofree g a) -> f (g (Cofree g a))) -> Cofree g a -> f (Cofree g a) Source