Test.QuickCheck.Arbitrary
Source Contents Index QuickCheck-2.8.2: Automatic testing of Haskell programs Safe Haskell Safe Language Haskell98 Test.QuickCheck.Arbitrary Contents Arbitrary and CoArbitrary classes Helper functions for implementing arbitrary Helper functions for implementing shrink Helper functions for implementing coarbitrary Generators which use arbitrary Description Type classes for random generation of values. Synopsis class Arbitrary a where arbitrary :: Gen a shrink :: a -> [a] class CoArbitrary a where coarbitrary :: a -> Gen b -> Gen b arbitrarySizedIntegral :: Integral a => Gen a arbitrarySizedNatural :: Integral a => Gen a arbitraryBoundedIntegral :: ( Bounded a, Integral a) => Gen a arbitrarySizedBoundedIntegral :: ( Bounded a, Integral a) => Gen a arbitrarySizedFractional :: Fractional a => Gen a arbitraryBoundedRandom :: ( Bounded a, Random a) => Gen a arbitraryBoundedEnum :: ( Bounded a, Enum a) => Gen a genericShrink :: ( Generic a, RecursivelyShrink ( Rep a), GSubterms ( Rep a) a) => a -> [a] subterms :: ( Generic a, GSubterms ( Rep a) a) => a -> [a] recursivelyShrink :: ( Generic a, RecursivelyShrink ( Rep a)) => a -> [a] genericCoarbitrary :: ( Generic a, GCoArbitrary ( Rep a)) => a -> Gen b -> Gen b shrinkNothing :: a -> [a] shrinkList :: (a -> [a]) -> [a] -> [[a]] shrinkIntegral :: Integral a => a -> [a] shrinkRealFrac :: RealFrac a => a -> [a] shrinkRealFracToInteger :: RealFrac a => a -> [a] coarbitraryIntegral :: Integral a => a -> Gen b -> Gen b coarbitraryReal :: Real a => a -> Gen b -> Gen b coarbitraryShow :: Show a => a -> Gen b -> Gen b coarbitraryEnum :: Enum a => a -> Gen b -> Gen b (><) :: ( Gen a -> Gen a) -> ( Gen a -> Gen a) -> Gen a -> Gen a vector :: Arbitrary a => Int -> Gen [a] orderedList :: ( Ord a, Arbitrary a) => Gen [a] infiniteList :: Arbitrary a => Gen [a] Arbitrary and CoArbitrary classes class Arbitrary a where Source Random generation and shrinking of values.
Minimal complete definition arbitrary Methods arbitrary :: Gen a Source A generator for values of the given type. shrink :: a -> [a] Source Produces a (possibly) empty list of all the possible immediate shrinks of the given value. The default implementation returns the empty list, so will not try to shrink the value. Most implementations of shrink should try at least three things: Shrink a term to any of its immediate subterms.
Recursively apply shrink to all immediate subterms. Type-specific shrinkings such as replacing a constructor by a simpler constructor. For example, suppose we have the following implementation of binary trees: data Tree a = Nil | Branch a (Tree a) (Tree a) We can then define shrink as follows: shrink Nil = [] shrink (Branch x l r) = -- shrink Branch to Nil [Nil] ++ -- shrink to subterms [l, r] ++ -- recursively shrink subterms [Branch x' l' r' | (x', l', r') <- shrink (x, l, r)] There are a couple of subtleties here: QuickCheck tries the shrinking candidates in the order they appear in the list, so we put more aggressive shrinking steps (such as replacing the whole tree by Nil ) before smaller ones (such as recursively shrinking the subtrees).
It is tempting to write the last line as [Branch x' l' r' | x' <- shrink x, l' <- shrink l, r' <- shrink r] but this is the wrong thing ! It will force QuickCheck to shrink x , l and r in tandem, and shrinking will stop once one of the three is fully shrunk. There is a fair bit of boilerplate in the code above. We can avoid it with the help of some generic functions; note that these only work on GHC 7.2 and above. The function genericShrink tries shrinking a term to all of its subterms and, failing that, recursively shrinks the subterms.
Using it, we can define shrink as: shrink x = shrinkToNil x ++ genericShrink x where shrinkToNil Nil = [] shrinkToNil (Branch _ l r) = [Nil] genericShrink is a combination of subterms , which shrinks a term to any of its subterms, and recursivelyShrink , which shrinks all subterms of a term. These may be useful if you need a bit more control over shrinking than genericShrink gives you. A final gotcha: we cannot define shrink as simply shrink x = Nil: genericShrink x as this shrinks Nil to Nil , and shrinking will go into an infinite loop.
If all this leaves you bewildered, you might try shrink = genericShrink to begin with, after deriving Generic for your type. However, if your data type has any special invariants, you will need to check that genericShrink can't break those invariants. Instances Arbitrary Bool Source Arbitrary Char Source Arbitrary Double Source Arbitrary Float Source Arbitrary Int Source Arbitrary Int8 Source Arbitrary Int16 Source Arbitrary Int32 Source Arbitrary Int64 Source Arbitrary Integer Source Arbitrary Ordering Source Arbitrary Word Source Arbitrary Word8 Source Arbitrary Word16 Source Arbitrary Word32 Source Arbitrary Word64 Source Arbitrary () Source Arbitrary Natural Source Arbitrary IntSet Source Arbitrary OrdC Source Arbitrary OrdB Source Arbitrary OrdA Source Arbitrary C Source Arbitrary B Source Arbitrary A Source Arbitrary a => Arbitrary [a] Source Integral a => Arbitrary ( Ratio a) Source HasResolution a => Arbitrary ( Fixed a) Source ( RealFloat a, Arbitrary a) => Arbitrary ( Complex a) Source Arbitrary a => Arbitrary ( Maybe a) Source Arbitrary a => Arbitrary ( IntMap a) Source ( Ord a, Arbitrary a) => Arbitrary ( Set a) Source Arbitrary a => Arbitrary ( Seq a) Source Arbitrary a => Arbitrary ( Smart a) Source Arbitrary a => Arbitrary ( Shrink2 a) Source Integral a => Arbitrary ( Small a) Source ( Integral a, Bounded a) => Arbitrary ( Large a) Source ( Num a, Ord a, Arbitrary a) => Arbitrary ( NonNegative a) Source ( Num a, Eq a, Arbitrary a) => Arbitrary ( NonZero a) Source ( Num a, Ord a, Arbitrary a) => Arbitrary ( Positive a) Source Arbitrary a => Arbitrary ( NonEmptyList a) Source ( Ord a, Arbitrary a) => Arbitrary ( OrderedList a) Source Arbitrary a => Arbitrary ( Fixed a) Source Arbitrary a => Arbitrary ( Blind a) Source ( CoArbitrary a, Arbitrary b) => Arbitrary (a -> b) Source ( Arbitrary a, Arbitrary b) => Arbitrary ( Either a b) Source ( Arbitrary a, Arbitrary b) => Arbitrary (a, b) Source ( Ord k, Arbitrary k, Arbitrary v) => Arbitrary ( Map k v) Source ( Arbitrary a, ShrinkState s a) => Arbitrary ( Shrinking s a) Source ( Function a, CoArbitrary a, Arbitrary b) => Arbitrary ( Fun a b) Source ( Function a, CoArbitrary a, Arbitrary b) => Arbitrary ( (:->) a b) Source ( Arbitrary a, Arbitrary b, Arbitrary c) => Arbitrary (a, b, c) Source ( Arbitrary a, Arbitrary b, Arbitrary c, Arbitrary d) => Arbitrary (a, b, c, d) Source ( Arbitrary a, Arbitrary b, Arbitrary c, Arbitrary d, Arbitrary e) => Arbitrary (a, b, c, d, e) Source class CoArbitrary a where Source Used for random generation of functions.
If you are using a recent GHC, there is a default definition of coarbitrary using genericCoarbitrary , so if your type has a Generic instance it's enough to say instance CoArbitrary MyType You should only use genericCoarbitrary for data types where equality is structural, i.e. if you can't have two different representations of the same value. An example where it's not safe is sets implemented using binary search trees: the same set can be represented as several different trees.
Here you would have to explicitly define coarbitrary s = coarbitrary (toList s) . Minimal complete definition Nothing Methods coarbitrary :: a -> Gen b -> Gen b Source Used to generate a function of type a -> b . The first argument is a value, the second a generator. You should use variant to perturb the random generator; the goal is that different values for the first argument will lead to different calls to variant .
An example will help: instance CoArbitrary a => CoArbitrary [a] where coarbitrary [] = variant 0 coarbitrary (x:xs) = variant 1 . coarbitrary (x,xs) Instances CoArbitrary Bool Source CoArbitrary Char Source CoArbitrary Double Source CoArbitrary Float Source CoArbitrary Int Source CoArbitrary Int8 Source CoArbitrary Int16 Source CoArbit
The rest of this page is on the live site.