Data.DeriveLiftedInstances

Deriving instances

deriveInstance :: Derivator -> Q Type -> Q [Dec]

Derive the instance with the given Derivator and the given instance head.

The instance head can be passed as a template haskell type quotation, for example:

{-# LANGUAGE TemplateHaskell #-}
[t| Num ShowsPrec |]
[t| forall a. Num a => Num [a] |]
[t| forall a b. (Num a, Num b) => Num (a, b) |]

idDeriv :: Derivator

The identity Derivator. Not useful on its own, but often used as input for other Derivators.

newtypeDeriv :: Name -> Name -> Derivator -> Derivator

Given how to derive an instance for a, and the names of a newtype wrapper around a, newtypeDeriv creates a Derivator for that newtype. Example:

newtype Ap f a = Ap { getAp :: f a } deriving Show
deriveInstance (newtypeDeriv 'Ap 'getAp idDeriv) [t| forall f. Functor f => Functor (Ap f) |]

> fmap (+1) (Ap [1,2,3])
Ap {getAp = [2,3,4]}

isoDeriv :: Q Exp -> Q Exp -> Derivator -> Derivator

Given how to derive an instance for a, and two functions of type a `->` b and b `->` a, isoDeriv creates a Derivator for b. (Note that the 2 functions don't have to form an isomorphism, but if they don't, the new instance can break the class laws.) Example:

newtype X = X { unX :: Int } deriving Show
mkX :: Int -> X
mkX i = X (mod i 10)
deriveInstance (isoDeriv [| mkX |] [| unX |] idDeriv) [t| Num X |]

> mkX 4 ^ 2
X {unX = 6}

recordDeriv :: Q Exp -> [(Q Exp, Derivator)] -> Derivator

Given an n-ary function to a, and a list of pairs, consisting of a function from a and a Derivator for the codomain of that function, create a Derivator for a. Examples:

data Rec f = Rec { getUnit :: f (), getInt :: f Int }
deriveInstance
  (recordDeriv [| Rec |]
    [ ([| getUnit |], apDeriv monoidDeriv)
    , ([| getInt  |], apDeriv idDeriv)
    ])
  [t| forall f. Applicative f => Num (Rec f) |]

tripleDeriv deriv1 deriv2 deriv3 =
  recordDeriv [| (,,) |]
    [ ([| fst3 |], deriv1)
    , ([| snd3 |], deriv2)
    , ([| thd3 |], deriv3) ]

apDeriv :: Derivator -> Derivator

Given how to derive an instance for a, apDeriv creates a Derivator for f a, when f is an instance of Applicative. Example:

deriveInstance (apDeriv idDeriv) [t| forall a. Num a => Num [a] |]

> [2, 3] * [5, 10]
[10, 20, 15, 30]

biapDeriv :: Derivator -> Derivator -> Derivator

Given how to derive an instance for a and b, biapDeriv creates a Derivator for f a b, when f is an instance of Biapplicative. Example:

deriveInstance (biapDeriv idDeriv idDeriv) [t| forall a b. (Num a, Num b) => Num (a, b) |]

> (2, 3) * (5, 10)
(10, 30)

monoidDeriv :: Derivator

Create a Derivator for any Monoid m. This is a degenerate instance that only collects all values of type m, and ignores the rest.

monoidDerivBy :: Q Exp -> Q Exp -> Derivator

Create a Derivator for a monoid, given TH expressions to replace (<>) and mempty respectively. Example:

monoidDerivBy [| (+) |] [| 0 |]

showDeriv :: Derivator

Derive instances for ShowsPrec. Example:

deriveInstance showDeriv [t| Num ShowsPrec |]

> show ((6 * 7) ^ 2 :: ShowsPrec)
"fromInteger 6 * fromInteger 7 * (fromInteger 6 * fromInteger 7)"

data ShowsPrec

Helper for showing infix expressions

Constructors

ShowsPrec (Int -> String -> String)

ShowOp2 Fixity (Int -> String -> String)

ShowOp1 Fixity (Int -> String -> String)

Instances

Bounded ShowsPrec

Defined in Data.DeriveLiftedInstances

Methods

minBound :: ShowsPrec

maxBound :: ShowsPrec

Floating ShowsPrec

Defined in Data.DeriveLiftedInstances

Methods

pi :: ShowsPrec

exp :: ShowsPrec -> ShowsPrec

log :: ShowsPrec -> ShowsPrec

sqrt :: ShowsPrec -> ShowsPrec

(**) :: ShowsPrec -> ShowsPrec -> ShowsPrec

logBase :: ShowsPrec -> ShowsPrec -> ShowsPrec

sin :: ShowsPrec -> ShowsPrec

cos :: ShowsPrec -> ShowsPrec

tan :: ShowsPrec -> ShowsPrec

asin :: ShowsPrec -> ShowsPrec

acos :: ShowsPrec -> ShowsPrec

atan :: ShowsPrec -> ShowsPrec

sinh :: ShowsPrec -> ShowsPrec

cosh :: ShowsPrec -> ShowsPrec

tanh :: ShowsPrec -> ShowsPrec

asinh :: ShowsPrec -> ShowsPrec

acosh :: ShowsPrec -> ShowsPrec

atanh :: ShowsPrec -> ShowsPrec

log1p :: ShowsPrec -> ShowsPrec

expm1 :: ShowsPrec -> ShowsPrec

log1pexp :: ShowsPrec -> ShowsPrec

log1mexp :: ShowsPrec -> ShowsPrec

Fractional ShowsPrec

Defined in Data.DeriveLiftedInstances

Methods

(/) :: ShowsPrec -> ShowsPrec -> ShowsPrec

recip :: ShowsPrec -> ShowsPrec

fromRational :: Rational -> ShowsPrec

Num ShowsPrec

Defined in Data.DeriveLiftedInstances

Methods

(+) :: ShowsPrec -> ShowsPrec -> ShowsPrec

(-) :: ShowsPrec -> ShowsPrec -> ShowsPrec

(*) :: ShowsPrec -> ShowsPrec -> ShowsPrec

negate :: ShowsPrec -> ShowsPrec

abs :: ShowsPrec -> ShowsPrec

signum :: ShowsPrec -> ShowsPrec

fromInteger :: Integer -> ShowsPrec

Show ShowsPrec

Defined in Data.DeriveLiftedInstances.Internal

Methods

showsPrec :: Int -> ShowsPrec -> ShowS

show :: ShowsPrec -> String

showList :: [ShowsPrec] -> ShowS

Semigroup ShowsPrec

Defined in Data.DeriveLiftedInstances

Methods

(<>) :: ShowsPrec -> ShowsPrec -> ShowsPrec

sconcat :: NonEmpty ShowsPrec -> ShowsPrec

stimes :: Integral b => b -> ShowsPrec -> ShowsPrec

Monoid ShowsPrec

Defined in Data.DeriveLiftedInstances

Methods

mempty :: ShowsPrec

mappend :: ShowsPrec -> ShowsPrec -> ShowsPrec

mconcat :: [ShowsPrec] -> ShowsPrec

Creating derivators

data Derivator

To write your own Derivator you need to show how each part of a method gets lifted. For example, when deriving an instance for type a of the following methods:

meth0 :: a
meth1 :: Int -> a
meth2 :: a -> Either Bool a -> Sum Int
meth3 :: Maybe [a] -> IO a

the resulting template haskell declarations are (pseudo code):

meth0 = $res ($op "meth0" meth0)
meth1 a = $res (($op "meth1" meth1) `$ap` ($arg Int a))
meth2 ($inp v0) ($inp v1) = $cst (($op "meth2" meth2) `$ap` ($var (iterate 0) v0)) `$ap` ($var (iterate 1) v1)
meth3 ($inp v2) = $eff (($op "meth2" meth2) `$ap` ($var (iterate 2) v2))

Constructors

Derivator

Fields

• res :: Q Exp -> Q Exp

  Convert the result of the method

• cst :: Q Exp -> Q Exp

  Convert the result of the method if it is a constant

• eff :: Q Exp -> Q Exp

  Convert the result of the method if it has an effect

• op :: Name -> Q Exp -> Q Exp

  Convert the method (still unapplied to any arguments)

• arg :: Type -> Q Exp -> Q Exp

  Convert an argument

• var :: (Q Exp -> Q Exp -> Q Exp) -> Q Exp -> Q Exp

  Convert a variable

• inp :: Q Pat -> Q Pat

  Generate an input pattern for a variable

• ap :: Q Exp -> Q Exp -> Q Exp

  Apply an argument or variable to the method

Orphan instances

Bounded ShowsPrec

Methods

minBound :: ShowsPrec

maxBound :: ShowsPrec

Floating ShowsPrec

Methods

pi :: ShowsPrec

exp :: ShowsPrec -> ShowsPrec

log :: ShowsPrec -> ShowsPrec

sqrt :: ShowsPrec -> ShowsPrec

(**) :: ShowsPrec -> ShowsPrec -> ShowsPrec

logBase :: ShowsPrec -> ShowsPrec -> ShowsPrec

sin :: ShowsPrec -> ShowsPrec

cos :: ShowsPrec -> ShowsPrec

tan :: ShowsPrec -> ShowsPrec

asin :: ShowsPrec -> ShowsPrec

acos :: ShowsPrec -> ShowsPrec

atan :: ShowsPrec -> ShowsPrec

sinh :: ShowsPrec -> ShowsPrec

cosh :: ShowsPrec -> ShowsPrec

tanh :: ShowsPrec -> ShowsPrec

asinh :: ShowsPrec -> ShowsPrec

acosh :: ShowsPrec -> ShowsPrec

atanh :: ShowsPrec -> ShowsPrec

log1p :: ShowsPrec -> ShowsPrec

expm1 :: ShowsPrec -> ShowsPrec

log1pexp :: ShowsPrec -> ShowsPrec

log1mexp :: ShowsPrec -> ShowsPrec

Fractional ShowsPrec

Methods

(/) :: ShowsPrec -> ShowsPrec -> ShowsPrec

recip :: ShowsPrec -> ShowsPrec

fromRational :: Rational -> ShowsPrec

Num ShowsPrec

Methods

(+) :: ShowsPrec -> ShowsPrec -> ShowsPrec

(-) :: ShowsPrec -> ShowsPrec -> ShowsPrec

(*) :: ShowsPrec -> ShowsPrec -> ShowsPrec

negate :: ShowsPrec -> ShowsPrec

abs :: ShowsPrec -> ShowsPrec

signum :: ShowsPrec -> ShowsPrec

fromInteger :: Integer -> ShowsPrec

Semigroup ShowsPrec

Methods

(<>) :: ShowsPrec -> ShowsPrec -> ShowsPrec

sconcat :: NonEmpty ShowsPrec -> ShowsPrec

stimes :: Integral b => b -> ShowsPrec -> ShowsPrec

Monoid ShowsPrec

Methods

mempty :: ShowsPrec

mappend :: ShowsPrec -> ShowsPrec -> ShowsPrec

mconcat :: [ShowsPrec] -> ShowsPrec