Control.Applicative.Cancelative

This module contains definitions for Cancelative functors along with the relevant combinators.

Cancelative

class Alternative f => Cancelative f where

A group on Applicative functors.

Cancelative functors have the following laws:

Left Cancelation

cancel a <|> a = empty

Rigth Cancelation

a <|> cancel a = empty

This is analogous to a group operation on applicative functors, in the sense that Alternative forms a monoid. A straight- forward implementation exists whenever f a forms a Group for all a, in which case, cancel == invert.

Minimal complete definition

cancel

Methods

cancel :: f a -> f a

Invert (or cancel) a Cancelative functor, such that, if the functor is also a GroupFoldable, then gold . cancel amounts to evaluating the inverse of a word in the functor.

Examples:

>>> let x = FreeGroup [Left (Sum (2 :: Word8)), Right (Sum 3)]
>>> cancel x
FreeGroup {runFreeGroup = [Right (Sum {getSum = 2}),Left (Sum {getSum = 3})]}

default cancel :: Group (f a) => f a -> f a

Instances

Cancelative FreeGroup

Defined in Control.Applicative.Cancelative

Methods

cancel :: FreeGroup a -> FreeGroup a

Cancelative FA

Defined in Control.Applicative.Cancelative

Methods

cancel :: FA a -> FA a

Cancelative FG

Defined in Control.Applicative.Cancelative

Methods

cancel :: FG a -> FG a

Cancelative (Proxy :: Type -> Type)

Defined in Control.Applicative.Cancelative

Methods

cancel :: Proxy a -> Proxy a

Cancelative combinators

cancel1 :: (Group a, Cancelative f) => a -> f a -> f a

Cancel a single element in a Cancelative functor.

Examples:

>>> let x = FreeGroup [Left (Sum (2 :: Word8)), Right (Sum 3)]
>>> gold x
Sum {getSum = 1}
>>> gold $ cancel1 (Sum 1) x
Sum {getSum = 0}

annihalate :: (Cancelative f, Traversable t) => (a -> f a) -> t a -> f (t a)

Annihalate a Traversable's worth of elements in a Cancelative functor.