Safe Haskell | None |
---|---|

Language | Haskell2010 |

n-ary sums (and sums of products)

- data NS :: (k -> *) -> [k] -> * where
- newtype SOP f xss = SOP (NS (NP f) xss)
- unZ :: NS f '[x] -> f x
- unSOP :: SOP f xss -> NS (NP f) xss
- type Injection f xs = f -.-> K (NS f xs)
- injections :: forall xs f. SListI xs => NP (Injection f xs) xs
- shift :: Injection f xs a -> Injection f (x ': xs) a
- shiftInjection :: Injection f xs a -> Injection f (x ': xs) a
- apInjs_NP :: SListI xs => NP f xs -> [NS f xs]
- apInjs_POP :: SListI xss => POP f xss -> [SOP f xss]
- ap_NS :: NP (f -.-> g) xs -> NS f xs -> NS g xs
- ap_SOP :: POP (f -.-> g) xss -> SOP f xss -> SOP g xss
- liftA_NS :: SListI xs => (forall a. f a -> g a) -> NS f xs -> NS g xs
- liftA_SOP :: All SListI xss => (forall a. f a -> g a) -> SOP f xss -> SOP g xss
- liftA2_NS :: SListI xs => (forall a. f a -> g a -> h a) -> NP f xs -> NS g xs -> NS h xs
- liftA2_SOP :: All SListI xss => (forall a. f a -> g a -> h a) -> POP f xss -> SOP g xss -> SOP h xss
- cliftA_NS :: All c xs => proxy c -> (forall a. c a => f a -> g a) -> NS f xs -> NS g xs
- cliftA_SOP :: All2 c xss => proxy c -> (forall a. c a => f a -> g a) -> SOP f xss -> SOP g xss
- cliftA2_NS :: All c xs => proxy c -> (forall a. c a => f a -> g a -> h a) -> NP f xs -> NS g xs -> NS h xs
- cliftA2_SOP :: All2 c xss => proxy c -> (forall a. c a => f a -> g a -> h a) -> POP f xss -> SOP g xss -> SOP h xss
- map_NS :: SListI xs => (forall a. f a -> g a) -> NS f xs -> NS g xs
- map_SOP :: All SListI xss => (forall a. f a -> g a) -> SOP f xss -> SOP g xss
- cmap_NS :: All c xs => proxy c -> (forall a. c a => f a -> g a) -> NS f xs -> NS g xs
- cmap_SOP :: All2 c xss => proxy c -> (forall a. c a => f a -> g a) -> SOP f xss -> SOP g xss
- cliftA2'_NS :: All2 c xss => proxy c -> (forall xs. All c xs => f xs -> g xs -> h xs) -> NP f xss -> NS g xss -> NS h xss
- collapse_NS :: NS (K a) xs -> a
- collapse_SOP :: SListI xss => SOP (K a) xss -> [a]
- sequence'_NS :: Applicative f => NS (f :.: g) xs -> f (NS g xs)
- sequence'_SOP :: (SListI xss, Applicative f) => SOP (f :.: g) xss -> f (SOP g xss)
- sequence_NS :: (SListI xs, Applicative f) => NS f xs -> f (NS I xs)
- sequence_SOP :: (All SListI xss, Applicative f) => SOP f xss -> f (SOP I xss)

# Datatypes

data NS :: (k -> *) -> [k] -> * where Source #

An n-ary sum.

The sum is parameterized by a type constructor `f`

and
indexed by a type-level list `xs`

. The length of the list
determines the number of choices in the sum and if the
`i`

-th element of the list is of type `x`

, then the `i`

-th
choice of the sum is of type `f x`

.

The constructor names are chosen to resemble Peano-style
natural numbers, i.e., `Z`

is for "zero", and `S`

is for
"successor". Chaining `S`

and `Z`

chooses the corresponding
component of the sum.

*Examples:*

Z :: f x -> NS f (x ': xs) S . Z :: f y -> NS f (x ': y ': xs) S . S . Z :: f z -> NS f (x ': y ': z ': xs) ...

Note that empty sums (indexed by an empty list) have no non-bottom elements.

Two common instantiations of `f`

are the identity functor `I`

and the constant functor `K`

. For `I`

, the sum becomes a
direct generalization of the `Either`

type to arbitrarily many
choices. For

, the result is a homogeneous choice type,
where the contents of the type-level list are ignored, but its
length specifies the number of options.`K`

a

In the context of the SOP approach to generic programming, an n-ary sum describes the top-level structure of a datatype, which is a choice between all of its constructors.

*Examples:*

Z (I 'x') :: NS I '[ Char, Bool ] S (Z (I True)) :: NS I '[ Char, Bool ] S (Z (I 1)) :: NS (K Int) '[ Char, Bool ]

HSequence [k] k (NS k) Source # | |

HCollapse [k] k (NS k) Source # | |

HAp [k] k (NS k) Source # | |

All k (Compose * k Eq f) xs => Eq (NS k f xs) Source # | |

(All k (Compose * k Eq f) xs, All k (Compose * k Ord f) xs) => Ord (NS k f xs) Source # | |

All k (Compose * k Show f) xs => Show (NS k f xs) Source # | |

type SListIN [k] k (NS k) Source # | |

type Prod [k] k (NS k) Source # | |

type CollapseTo [k] k (NS k) a Source # | |

A sum of products.

This is a 'newtype' for an `NS`

of an `NP`

. The elements of the
(inner) products are applications of the parameter `f`

. The type
`SOP`

is indexed by the list of lists that determines the sizes
of both the (outer) sum and all the (inner) products, as well as
the types of all the elements of the inner products.

An

reflects the structure of a normal Haskell datatype.
The sum structure represents the choice between the different
constructors, the product structure represents the arguments of
each constructor.`SOP`

`I`

HSequence [[k]] k (SOP k) Source # | |

HCollapse [[k]] k (SOP k) Source # | |

HAp [[k]] k (SOP k) Source # | |

Eq (NS [k] (NP k f) xss) => Eq (SOP k f xss) Source # | |

Ord (NS [k] (NP k f) xss) => Ord (SOP k f xss) Source # | |

Show (NS [k] (NP k f) xss) => Show (SOP k f xss) Source # | |

type SListIN [[k]] k (SOP k) Source # | |

type Prod [[k]] k (SOP k) Source # | |

type CollapseTo [[k]] k (SOP k) a Source # | |

unZ :: NS f '[x] -> f x Source #

Extract the payload from a unary sum.

For larger sums, this function would be partial, so it is only provided with a rather restrictive type.

*Example:*

`>>>`

I 'x'`unZ (Z (I 'x'))`

*Since: 0.2.2.0*

# Constructing sums

type Injection f xs = f -.-> K (NS f xs) Source #

The type of injections into an n-ary sum.

If you expand the type synonyms and newtypes involved, you get

Injection f xs a = (f -.-> K (NS f xs)) a ~= f a -> K (NS f xs) a ~= f a -> NS f xs

If we pick `a`

to be an element of `xs`

, this indeed corresponds to an
injection into the sum.

injections :: forall xs f. SListI xs => NP (Injection f xs) xs Source #

Compute all injections into an n-ary sum.

Each element of the resulting product contains one of the injections.

shift :: Injection f xs a -> Injection f (x ': xs) a Source #

Deprecated: Use `shiftInjection`

instead.

Shift an injection.

Given an injection, return an injection into a sum that is one component larger.

shiftInjection :: Injection f xs a -> Injection f (x ': xs) a Source #

Shift an injection.

Given an injection, return an injection into a sum that is one component larger.

apInjs_NP :: SListI xs => NP f xs -> [NS f xs] Source #

Apply injections to a product.

Given a product containing all possible choices, produce a list of sums by applying each injection to the appropriate element.

*Example:*

`>>>`

[Z (I 'x'), S (Z (I True)), S (S (Z (I 2)))]`apInjs_NP (I 'x' :* I True :* I 2 :* Nil)`

apInjs_POP :: SListI xss => POP f xss -> [SOP f xss] Source #

Apply injections to a product of product.

This operates on the outer product only. Given a product containing all possible choices (that are products), produce a list of sums (of products) by applying each injection to the appropriate element.

*Example:*

`>>>`

[SOP (Z (I 'x' :* Nil)),SOP (S (Z (I True :* (I 2 :* Nil))))]`apInjs_POP (POP ((I 'x' :* Nil) :* (I True :* I 2 :* Nil) :* Nil))`

# Application

# Lifting / mapping

liftA_NS :: SListI xs => (forall a. f a -> g a) -> NS f xs -> NS g xs Source #

Specialization of `hliftA`

.

liftA_SOP :: All SListI xss => (forall a. f a -> g a) -> SOP f xss -> SOP g xss Source #

Specialization of `hliftA`

.

liftA2_NS :: SListI xs => (forall a. f a -> g a -> h a) -> NP f xs -> NS g xs -> NS h xs Source #

Specialization of `hliftA2`

.

liftA2_SOP :: All SListI xss => (forall a. f a -> g a -> h a) -> POP f xss -> SOP g xss -> SOP h xss Source #

Specialization of `hliftA2`

.

cliftA_NS :: All c xs => proxy c -> (forall a. c a => f a -> g a) -> NS f xs -> NS g xs Source #

Specialization of `hcliftA`

.

cliftA_SOP :: All2 c xss => proxy c -> (forall a. c a => f a -> g a) -> SOP f xss -> SOP g xss Source #

Specialization of `hcliftA`

.

cliftA2_NS :: All c xs => proxy c -> (forall a. c a => f a -> g a -> h a) -> NP f xs -> NS g xs -> NS h xs Source #

Specialization of `hcliftA2`

.

cliftA2_SOP :: All2 c xss => proxy c -> (forall a. c a => f a -> g a -> h a) -> POP f xss -> SOP g xss -> SOP h xss Source #

Specialization of `hcliftA2`

.

cmap_SOP :: All2 c xss => proxy c -> (forall a. c a => f a -> g a) -> SOP f xss -> SOP g xss Source #

# Dealing with `All`

c

`All`

ccliftA2'_NS :: All2 c xss => proxy c -> (forall xs. All c xs => f xs -> g xs -> h xs) -> NP f xss -> NS g xss -> NS h xss Source #

Deprecated: Use `cliftA2_NS`

instead.

Specialization of `hcliftA2'`

.

# Collapsing

# Sequencing

sequence'_NS :: Applicative f => NS (f :.: g) xs -> f (NS g xs) Source #

Specialization of `hsequence'`

.

sequence'_SOP :: (SListI xss, Applicative f) => SOP (f :.: g) xss -> f (SOP g xss) Source #

Specialization of `hsequence'`

.

sequence_NS :: (SListI xs, Applicative f) => NS f xs -> f (NS I xs) Source #

Specialization of `hsequence`

.

sequence_SOP :: (All SListI xss, Applicative f) => SOP f xss -> f (SOP I xss) Source #

Specialization of `hsequence`

.