Data.GenValidity.Utils

Helper functions for implementing generators

upTo :: Int -> Gen Int

upTo generates an integer between 0 (inclusive) and n.

genSplit :: Int -> Gen (Int, Int)

'genSplit a' generates a tuple '(b, c)' such that 'b + c' equals a.

genSplit3 :: Int -> Gen (Int, Int, Int)

'genSplit3 a' generates a triple '(b, c, d)' such that 'b + c + d' equals a.

genSplit4 :: Int -> Gen (Int, Int, Int, Int)

'genSplit4 a' generates a quadruple '(b, c, d, e)' such that 'b + c + d + e' equals a.

genSplit5 :: Int -> Gen (Int, Int, Int, Int, Int)

'genSplit5 a' generates a quintuple '(b, c, d, e, f)' such that 'b + c + d + e + f' equals a.

genSplit6 :: Int -> Gen (Int, Int, Int, Int, Int, Int)

'genSplit6 a' generates a sextuple '(b, c, d, e, f, g)' such that 'b + c + d + e + f + g' equals a.

genSplit7 :: Int -> Gen (Int, Int, Int, Int, Int, Int, Int)

'genSplit7 a' generates a septtuple '(b, c, d, e, f, g)' such that 'b + c + d + e + f + g' equals a.

genSplit8 :: Int -> Gen (Int, Int, Int, Int, Int, Int, Int, Int)

'genSplit8 a' generates a octtuple '(b, c, d, e, f, g, h)' such that 'b + c + d + e + f + g + h' equals a.

arbPartition :: Int -> Gen [Int]

'arbPartition n' generates a list ls such that 'sum ls' equals n, approximately.

shuffle :: [a] -> Gen [a]

Generates a random permutation of the given list.

genListLength :: Gen Int

genStringBy :: Gen Char -> Gen String

genStringBy1 :: Gen Char -> Gen String

genListOf :: Gen a -> Gen [a]

A version of listOf that takes size into account more accurately.

This generator distributes the size that is is given among the values in the list that it generates.

genListOf1 :: Gen a -> Gen [a]

A version of genNonEmptyOf that returns a list instead of a NonEmptyList.

genMaybe :: Gen a -> Gen (Maybe a)

genNonEmptyOf :: Gen a -> Gen (NonEmpty a)

genIntX :: forall a. (Integral a, Bounded a, Random a) => Gen a

Generate Int, Int8, Int16, Int32 and Int64 values smartly.

• Some at the border
• Some around zero
• Mostly uniformly

genWordX :: forall a. (Integral a, Bounded a, Random a) => Gen a

Generate Word, Word8, Word16, Word32 and Word64 values smartly.

• Some at the border
• Some around zero
• Mostly uniformly

genFloat :: Gen Float

See genFloatX

genDouble :: Gen Double

See genFloatX

genFloatX :: forall a w. (Read a, RealFloat a, Bounded w, Random w) => (w -> a) -> Gen a

Generate floating point numbers smartly:

• Some denormalised
• Some around zero
• Some around the bounds
• Some by encoding an Integer and an Int to a floating point number.
• Some accross the entire range
• Mostly uniformly via the bitrepresentation

The function parameter is to go from the bitrepresentation to the floating point value.

genInteger :: Gen Integer

Helper functions for implementing shrinking functions

shrinkMaybe :: (a -> [a]) -> Maybe a -> [Maybe a]

Lift a shrinker function into a maybe

shrinkTuple :: (a -> [a]) -> (b -> [b]) -> (a, b) -> [(a, b)]

Combine two shrinking functions to shrink a tuple.

shrinkTriple :: (a -> [a]) -> (b -> [b]) -> (c -> [c]) -> (a, b, c) -> [(a, b, c)]

Like shrinkTuple, but for triples

shrinkQuadruple :: (a -> [a]) -> (b -> [b]) -> (c -> [c]) -> (d -> [d]) -> (a, b, c, d) -> [(a, b, c, d)]

Like shrinkTuple, but for quadruples

shrinkT2 :: (a -> [a]) -> (a, a) -> [(a, a)]

Turn a shrinking function into a function that shrinks tuples.

shrinkT3 :: (a -> [a]) -> (a, a, a) -> [(a, a, a)]

Turn a shrinking function into a function that shrinks triples.

shrinkT4 :: (a -> [a]) -> (a, a, a, a) -> [(a, a, a, a)]

Turn a shrinking function into a function that shrinks quadruples.

shrinkList :: (a -> [a]) -> [a] -> [[a]]

Shrink a list of values given a shrinking function for individual values.

shrinkNonEmpty :: (a -> [a]) -> NonEmpty a -> [NonEmpty a]