Safe Haskell	None
Language	Haskell2010

Test.StrictCheck.Consume

Contents

Incrementally consuming input
Manually writing Consume instances
Generically deriving Consume instances

Description

This module defines the Consume typeclass, used for incrementally destructing inputs to random non-strict functions.

Calling consume on some value lazily returns an abstract type of Input, which contains all the entropy present in the original value. Paired with Produce, these Input values can be used to generate random non-strict functions, whose strictness behavior is dependent on the values given to them.

Synopsis

data Input
data Inputs
class Consume a where
- consume :: a -> Input
constructor :: Int -> [Input] -> Input
normalize :: Consume a => a -> ()
consumeTrivial :: a -> Input
consumePrimitive :: CoArbitrary a => a -> Input
type GConsume a = (Generic a, All2 Consume (Code a))
gConsume :: GConsume a => a -> Input

Incrementally consuming input

data Input Source #

A tree representing all possible destruction sequences for a value Unfolding the contained lists forces a particular random control path for destructing the datatype.

data Inputs Source #

A list of inputs given to a function, in abstract form. This lazy structure is evaluated piecewise during the course of producing a function, thus triggering the partial evaluation of the original input to the function.

class Consume a where Source #

Lazily monomorphize some input value, by converting it into an Input. This is an incremental version of QuickCheck's CoArbitrary typeclass. It can also be seen as a generalization of the NFData class.

Instances of Consume can be derived automatically for any type implementing the Generic class from GHC.Generics. Using the DeriveAnyClass extension, we can say:

import GHC.Generics as GHC
import Generics.SOP as SOP

data D x y
  = A
  | B (x, y)
  deriving (GHC.Generic, SOP.Generic, Consume)

This automatic derivation follows these rules, which you can follow too if you're manually writing an instance for some type which is not Generic:

For each distinct constructor, make a single call to constructor with a distinct Int, and a list of Inputs, each created by recursively calling consume on every field in that constructor. For abstract types (e.g. sets), the same procedure can be used upon an extracted list representation of the contents.

Minimal complete definition

Nothing

Methods

consume :: a -> Input Source #

Convert an a into an Input by recursively destructing it using calls to consume

consume :: GConsume a => a -> Input Source #

Convert an a into an Input by recursively destructing it using calls to consume

Instances

Consume Bool Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Bool -> Input Source #
Consume Char Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Char -> Input Source #
Consume Double Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Double -> Input Source #
Consume Float Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Float -> Input Source #
Consume Int Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Int -> Input Source #
Consume Integer Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Integer -> Input Source #
Consume Ordering Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Ordering -> Input Source #
Consume Rational Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Rational -> Input Source #
Consume Word Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Word -> Input Source #
Consume () Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: () -> Input Source #
Consume IntSet Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: IntSet -> Input Source #
Consume Key Source #
Instance details Defined in Test.StrictCheck.Examples.Map Methods consume :: Key -> Input Source #
Consume a => Consume [a] Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: [a] -> Input Source #
Consume a => Consume (Maybe a) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Maybe a -> Input Source #
(CoArbitrary a, RealFloat a) => Consume (Complex a) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Complex a -> Input Source #
Consume a => Consume (NonEmpty a) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: NonEmpty a -> Input Source #
Consume v => Consume (IntMap v) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: IntMap v -> Input Source #
Consume a => Consume (Tree a) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Tree a -> Input Source #
Consume v => Consume (Seq v) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Seq v -> Input Source #
Consume v => Consume (Set v) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Set v -> Input Source #
Consume (a -> b) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a -> b) -> Input Source #
(Consume a, Consume b) => Consume (Either a b) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Either a b -> Input Source #
(Consume a, Consume b) => Consume (a, b) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b) -> Input Source #
Consume (Proxy p) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Proxy p -> Input Source #
Consume v => Consume (Map k v) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: Map k v -> Input Source #
(Consume k, Consume v) => Consume (Map k v) Source #
Instance details Defined in Test.StrictCheck.Examples.Map Methods consume :: Map k v -> Input Source #
(Consume a, Consume b, Consume c) => Consume (a, b, c) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c) -> Input Source #
(Consume a, Consume b, Consume c, Consume d) => Consume (a, b, c, d) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e) => Consume (a, b, c, d, e) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f) => Consume (a, b, c, d, e, f) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g) => Consume (a, b, c, d, e, f, g) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h) => Consume (a, b, c, d, e, f, g, h) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i) => Consume (a, b, c, d, e, f, g, h, i) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j) => Consume (a, b, c, d, e, f, g, h, i, j) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k) => Consume (a, b, c, d, e, f, g, h, i, j, k) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l) => Consume (a, b, c, d, e, f, g, h, i, j, k, l) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m, Consume n) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m, n) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m, Consume n, Consume o) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m, Consume n, Consume o, Consume p) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m, Consume n, Consume o, Consume p, Consume q) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m, Consume n, Consume o, Consume p, Consume q, Consume r) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m, Consume n, Consume o, Consume p, Consume q, Consume r, Consume s) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m, Consume n, Consume o, Consume p, Consume q, Consume r, Consume s, Consume t) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m, Consume n, Consume o, Consume p, Consume q, Consume r, Consume s, Consume t, Consume u) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m, Consume n, Consume o, Consume p, Consume q, Consume r, Consume s, Consume t, Consume u, Consume v) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m, Consume n, Consume o, Consume p, Consume q, Consume r, Consume s, Consume t, Consume u, Consume v, Consume w) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m, Consume n, Consume o, Consume p, Consume q, Consume r, Consume s, Consume t, Consume u, Consume v, Consume w, Consume x) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m, Consume n, Consume o, Consume p, Consume q, Consume r, Consume s, Consume t, Consume u, Consume v, Consume w, Consume x, Consume y) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y) -> Input Source #
(Consume a, Consume b, Consume c, Consume d, Consume e, Consume f, Consume g, Consume h, Consume i, Consume j, Consume k, Consume l, Consume m, Consume n, Consume o, Consume p, Consume q, Consume r, Consume s, Consume t, Consume u, Consume v, Consume w, Consume x, Consume y, Consume z) => Consume (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z) Source #
Instance details Defined in Test.StrictCheck.Consume Methods consume :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z) -> Input Source #