constraints-extras-0.4.0.2: Utility package for constraints

Safe Haskell | Safe-Inferred
Language | Haskell2010

Data.Constraint.Extras

Contents

- The Has typeclass
- Bringing instances into scope
- Misc

Description

Throughout this module, we use the following GADT and `ArgDict` instance in our examples:

    {-# LANGUAGE StandaloneDeriving #-}

    data Tag a where
      I :: Tag Int
      B :: Tag Bool
    deriving instance Show (Tag a)

    $(deriveArgDict ''Tag)

The constructors of `Tag` mean that a type variable `a` in `Tag a` must come from the set { `Int`, `Bool` }. We call this the "set of types `a` that could be applied to `Tag`".

Synopsis

- class Has (c :: k -> Constraint) (f :: k -> Type) where
  - has :: forall (a :: k) r. f a -> (c a => r) -> r
  - argDict :: forall (a :: k). f a -> Dict (c a)
- argDict' :: forall {k} {k'} c (g :: k' -> k) f (a :: k'). Has' c f g => f a -> Dict (c (g a))
- argDictV :: forall {k'} {k2} f c (g :: k') (v :: k' -> k2). HasV c f g => f v -> Dict (c (v g))
- type Has' (c :: k -> Constraint) (f :: k' -> Type) (g :: k' -> k) = Has (ComposeC c g) f
- has' :: forall {k} {k'} c (g :: k' -> k) f (a :: k') r. Has' c f g => f a -> (c (g a) => r) -> r
- type HasV (c :: k2 -> Constraint) (f :: (k' -> k2) -> Type) (g :: k') = Has (FlipC (ComposeC c :: (k' -> k2) -> k' -> Constraint) g) f
- hasV :: forall {k2} {k'} c (g :: k') f (v :: k' -> k2) r. HasV c f g => f v -> (c (v g) => r) -> r
- whichever :: forall {k2} {k1} c (t :: k1 -> k2) (a :: k1) r. ForallF c t => (c (t a) => r) -> r
- class Implies1 (c :: k -> Constraint) (d :: k -> Constraint) where
  - implies1 :: forall (a :: k). c a :- d a

# The Has typeclass

class Has (c :: k -> Constraint) (f :: k -> Type) where Source #

The constraint `Has c f` means that given any value of type `f a`, we can determine that there is an instance of `c a`. For example, `Has Show Tag` means that given any `x :: Tag a`, we can conclude `Show a`. Most commonly, the type `f` will be a GADT, where we can enumerate all the possible index types through pattern matching, and discover that there is an appropriate instance in each case. In this sort of situation, the `c` can be left entirely polymorphic in the instance for `Has`, and this is the sort of instance that the provided Template Haskell code writes.

Minimal complete definition

has | argDict

Methods

has :: forall (a :: k) r. f a -> (c a => r) -> r Source #

Use the `f a` to show that there is an instance of `c a`, and bring it into scope.

The order of type variables is chosen to work with `-XTypeApplications`.

    -- Hold a value of type a, along with a tag identifying the a.
    data SomeTagged tag where
      SomeTagged :: a -> tag a -> SomeTagged tag

    -- Use the stored tag to identify the thing we have, allowing us to call 'show'. Note that we
    -- have no knowledge of the tag type.
    showSomeTagged :: Has Show tag => SomeTagged tag -> String
    showSomeTagged (SomeTagged a tag) = has @Show tag $ show a

argDict :: forall (a :: k). f a -> Dict (c a) Source #

Use an `f a` to obtain a dictionary for `c a`

    argDict @Show I :: Dict (Show Int)

#### Instances

Instances details

(Has c f, Has c g) => Has (c :: k -> Constraint) (Sum f g :: k -> Type) Source # | Since: 0.3.2.0
Instance details Defined in Data.Constraint.Extras Methods has :: forall (a :: k) r. Sum f g a -> (c a => r) -> r Source # argDict :: forall (a :: k). Sum f g a -> Dict (c a) Source #
(Has c f, Has c g) => Has (c :: k -> Constraint) (f :+: g :: k -> Type) Source # | Since: 0.3.2.0
Instance details Defined in Data.Constraint.Extras Methods has :: forall (a :: k) r. (f :+: g) a -> (c a => r) -> r Source # argDict :: forall (a :: k). (f :+: g) a -> Dict (c a) Source #

argDict' :: forall {k} {k'} c (g :: k' -> k) f (a :: k'). Has' c f g => f a -> Dict (c (g a)) Source #

Get a dictionary for `c (g a)`, using a value of type `f a`.

    argDict' @Show @Identity B :: Dict (Show (Identity Bool))

argDictV :: forall {k'} {k2} f c (g :: k') (v :: k' -> k2). HasV c f g => f v -> Dict (c (v g)) Source #

Get a dictionary for `c (v g)`, using a value of type `f v`.

# Bringing instances into scope

type Has' (c :: k -> Constraint) (f :: k' -> Type) (g :: k' -> k) = Has (ComposeC c g) f Source #

The constraint `Has' c f g` means that given a value of type `f a`, we can satisfy the constraint `c (g a)`.

has' :: forall {k} {k'} c (g :: k' -> k) f (a :: k') r. Has' c f g => f a -> (c (g a) => r) -> r Source #

Like `has`, but we get a `c (g a)` instance brought into scope instead. Use `-XTypeApplications` to specify `c` and `g`.

    -- From dependent-sum:Data.Dependent.Sum
    data DSum tag f = forall a. !(tag a) :=> f a

    -- Show the value from a dependent sum. (We'll need 'whichever', discussed later, to show the key.)
    showDSumVal :: forall tag f . Has' Show tag f => DSum tag f -> String
    showDSumVal (tag :=> fa) = has' @Show @f tag $ show fa

type HasV (c :: k2 -> Constraint) (f :: (k' -> k2) -> Type) (g :: k') = Has (FlipC (ComposeC c :: (k' -> k2) -> k' -> Constraint) g) f Source #

The constraint `HasV c f g` means that given a value of type `f v`, we can satisfy the constraint `c (v g)`.

hasV :: forall {k2} {k'} c (g :: k') f (v :: k' -> k2) r. HasV c f g => f v -> (c (v g) => r) -> r Source #

Similar to `has`, but given a value of type `f v`, we get a `c (v g)` instance brought into scope instead.

whichever :: forall {k2} {k1} c (t :: k1 -> k2) (a :: k1) r. ForallF c t => (c (t a) => r) -> r Source #

Given "forall a. `c (t a)`" (the `ForallF c t` constraint), select a specific `a`, and bring `c (t a)` into scope. Use `-XTypeApplications` to specify `c`, `t` and `a`.

    -- Show the tag of a dependent sum, even though we don't know the tag type.
    showDSumKey :: forall tag f . ForallF Show tag => DSum tag f -> String
    showDSumKey ((tag :: tag a) :=> fa) = whichever @Show @tag @a $ show tag

# Misc

class Implies1 (c :: k -> Constraint) (d :: k -> Constraint) where Source #

Allows explicit specification of constraint implication.

Methods

implies1 :: forall (a :: k). c a :- d a Source #