| Copyright | (c) 2009--2010 Universiteit Utrecht |
|---|---|
| License | BSD3 |
| Maintainer | generics@haskell.org |
| Stability | experimental |
| Portability | non-portable |
| Safe Haskell | Safe |
| Language | Haskell2010 |
Generics.MultiRec.FoldAlg
Contents
Description
A variant of fold that allows the specification of the algebra in a convenient way.
The type family of convenient algebras.
type family Alg f r ix :: * Source
The type family we use to describe the convenient algebras.
Instances
| type Alg U r ix = r ix Source | For a unit, no arguments are available. |
| type Alg (K a) r ix = a -> r ix Source | For a constant, we take the constant value to a result. |
| type Alg (I xi) r ix = r xi -> r ix Source | For an identity, we turn the recursive result into a final result. Note that the index can change. |
| type Alg (C c f) r ix = Alg f r ix Source | Constructors are ignored. |
| type Alg ((:.:) f (I xi)) r ix = f (r xi) -> r ix Source | |
| type Alg ((:>:) f xi) r ix = Alg f r xi Source | A tag changes the index of the final result. |
| type Alg ((:*:) f g) r ix = Comp f r ix -> Alg g r ix Source | For a product where the left hand side is a constant, we take the value as an additional argument. |
| type Alg ((:+:) f g) r ix = (Alg f r ix, Alg g r ix) Source | For a sum, the algebra is a pair of two algebras. |
type Algebra phi r = forall ix. phi ix -> Alg (PF phi) r ix Source
The algebras passed to the fold have to work for all index types in the family. The additional witness argument is required only to make GHC's typechecker happy.
The class to turn convenient algebras into standard algebras.
The class fold explains how to convert a convenient algebra
Alg back into a function from functor to result, as required
by the standard fold function.
Interface
fold :: forall phi ix r. (Fam phi, HFunctor phi (PF phi), Fold (PF phi)) => Algebra phi r -> phi ix -> ix -> r ix Source
Fold with convenient algebras.