Generic.Random.Internal.Generic

Random generators

genericArbitrary :: forall a. (Generic a, GA Unsized (Rep a)) => Gen a

Pick a constructor with uniform probability, and fill its fields recursively.

An equivalent definition for Tree is:

genericArbitrary :: Arbitrary a => Gen (Tree a)
genericArbitrary =
  oneof
    [ Leaf <$> arbitrary                -- Uses Arbitrary a
    , Node <$> arbitrary <*> arbitrary  -- Uses Arbitrary (Tree a)
    ]

Note that for many types, genericArbitrary tends to produce big values. For instance for Tree a values are finite but the average number of Leaf and Node constructors is infinite.

genericArbitraryFrequency

Arguments

:: (Generic a, GA Unsized (Rep a))

=> [Int]

List of weights for every constructor

-> Gen a

This allows to specify the probability distribution of constructors as a list of weights, in the same order as the data type definition.

An equivalent definition for Tree is:

genericArbitraryFrequency :: Arbitrary a => [Int] -> Gen (Tree a)
genericArbitraryFrequency [x, y] =
  frequency
    [ (x, Leaf <$> arbitrary)
    , (y, Node <$> arbitrary <*> arbitrary)
    ]

genericArbitraryFrequency'

Arguments

:: (Generic a, GA (Sized n) (Rep a))

=> n

-> [Int]

List of weights for every constructor

-> Gen a

The size parameter of Gen is divided among the fields of the chosen constructor. When it reaches zero, the generator selects a finite term whenever it can find any of the given type.

The natural number n determines the maximum depth of terms that can be used to end recursion. It is encoded using Z :: Z and S :: n -> S n.

genericArbitraryFrequency' n weights

With n = Z, the generator looks for a simple nullary constructor. If none exist at the current type, as is the case for our Tree type, it carries on as in genericArbitraryFrequency.

genericArbitraryFrequency' Z :: Arbitrary a => [Int] -> Gen (Tree a)
genericArbitraryFrequency' Z [x, y] =
  frequency
    [ (x, Leaf <$> arbitrary)
    , (y, scale (`div` 2) $ Node <$> arbitrary <*> arbitrary)
    ]
    -- 2 because Node is 2-ary.

Here is another example:

data Tree' = Leaf1 | Leaf2 | Node3 Tree' Tree' Tree'
  deriving Generic

instance Arbitrary Tree' where
  arbitrary = genericArbitraryFrequency' Z [1, 2, 3]

genericArbitraryFrequency' is equivalent to:

genericArbitraryFrequency' Z :: [Int] -> Gen Tree'
genericArbitraryFrequency' Z [x, y, z] =
  sized $ \n ->
    if n == 0 then
      -- If the size parameter is zero, the non-nullary alternative is discarded.
      frequency $
        [ (x, return Leaf1)
        , (y, return Leaf2)
        ]
    else
      frequency $
        [ (x, return Leaf1)
        , (y, return Leaf2)
        , (z, resize (n `div` 3) node)
        ]
        -- 3 because Node3 is 3-ary
  where
    node = Node3 <$> arbitrary <*> arbitrary <*> arbitrary

To increase the chances of termination when no nullary constructor is directly available, such as in Tree, we can pass a larger depth n. The effectiveness of this parameter depends on the concrete type the generator is used for.

For instance, if we want to generate a value of type Tree (), there is a value of depth 1 (represented by S Z) that we can use to end recursion: Leaf ().

genericArbitraryFrequency' (S Z) :: [Int] -> Gen (Tree ())
genericArbitraryFrequency' (S Z) [x, y] =
  sized $ \n ->
    if n == 0 then
      return (Leaf ())
    else
      frequency
        [ (x, Leaf <$> arbitrary)
        , (y, scale (`div` 2) $ Node <$> arbitrary <*> arbitrary)
        ]

Because the argument of Tree must be inspected in order to discover values of type Tree (), we incur some extra constraints if we want polymorphism.

FlexibleContexts and UndecidableInstances are also required.

instance (Arbitrary a, Generic a, BaseCases Z (Rep a))
  => Arbitrary (Tree a) where
  arbitrary = genericArbitraryFrequency' (S Z) [1, 2]

A synonym is provided for brevity.

instance (Arbitrary a, BaseCases' Z a) => Arbitrary (Tree a) where
  arbitrary = genericArbitraryFrequency' (S Z) [1, 2]

genericArbitrary' :: forall n a. (Generic a, GA (Sized n) (Rep a)) => n -> Gen a

Like genericArbitraryFrequency', but with uniformly distributed constructors.

Internal

newtype Freq sized a

Constructors

Freq

Fields

• unFreq :: [Int] -> Gen a

Instances

Functor (Freq sized)

Methods

fmap :: (a -> b) -> Freq sized a -> Freq sized b

(<$) :: a -> Freq sized b -> Freq sized a

Applicative (Freq sized)

Methods

pure :: a -> Freq sized a

(<*>) :: Freq sized (a -> b) -> Freq sized a -> Freq sized b

(*>) :: Freq sized a -> Freq sized b -> Freq sized b

(<*) :: Freq sized a -> Freq sized b -> Freq sized a

newtype Gen' sized a

Constructors

Gen'

Fields

• unGen' :: Gen a

Instances

Functor (Gen' sized)

Methods

fmap :: (a -> b) -> Gen' sized a -> Gen' sized b

(<$) :: a -> Gen' sized b -> Gen' sized a

Applicative (Gen' sized)

Methods

pure :: a -> Gen' sized a

(<*>) :: Gen' sized (a -> b) -> Gen' sized a -> Gen' sized b

(*>) :: Gen' sized a -> Gen' sized b -> Gen' sized b

(<*) :: Gen' sized a -> Gen' sized b -> Gen' sized a

data Sized n

Instances

(GAProduct f, GAProduct g) => GA (Sized n) ((:*:) f g)

Methods

ga :: Freq (Sized n) ((f :*: g) p)

(GASum (Sized n) f, GASum (Sized n) g, BaseCases n f, BaseCases n g) => GA (Sized n) ((:+:) f g)

Methods

ga :: Freq (Sized n) ((f :+: g) p)

data Unsized

Instances

(GASum Unsized f, GASum Unsized g) => GA Unsized ((:+:) f g)

Methods

ga :: Freq Unsized ((f :+: g) p)

(GA Unsized f, GA Unsized g) => GA Unsized ((:*:) f g)

Methods

ga :: Freq Unsized ((f :*: g) p)

liftGen :: Gen a -> Freq sized a

class GA sized f where

Generic Arbitrary

Minimal complete definition

ga

Methods

ga :: Freq sized (f p)

Instances

GA sized U1

Methods

ga :: Freq sized (U1 p)

Arbitrary c => GA sized (K1 i c)

Methods

ga :: Freq sized (K1 i c p)

(GASum Unsized f, GASum Unsized g) => GA Unsized ((:+:) f g)

Methods

ga :: Freq Unsized ((f :+: g) p)

(GA Unsized f, GA Unsized g) => GA Unsized ((:*:) f g)

Methods

ga :: Freq Unsized ((f :*: g) p)

GA sized f => GA sized (M1 i c f)

Methods

ga :: Freq sized (M1 i c f p)

(GAProduct f, GAProduct g) => GA (Sized n) ((:*:) f g)

Methods

ga :: Freq (Sized n) ((f :*: g) p)

(GASum (Sized n) f, GASum (Sized n) g, BaseCases n f, BaseCases n g) => GA (Sized n) ((:+:) f g)

Methods

ga :: Freq (Sized n) ((f :+: g) p)

gArbitrarySingle :: forall sized f p. GA sized f => Gen' sized (f p)

class GASum sized f where

Minimal complete definition

gaSum

Methods

gaSum :: [Gen' sized (f p)]

Instances

(GASum sized f, GASum sized g) => GASum sized ((:+:) f g)

Methods

gaSum :: [Gen' sized ((f :+: g) p)]

GA sized f => GASum sized (M1 i c f)

Methods

gaSum :: [Gen' sized (M1 i c f p)]

class GAProduct f where

Minimal complete definition

gaProduct

Methods

gaProduct :: (Int, Gen' Unsized (f p))

Instances

(GAProduct f, GAProduct g) => GAProduct ((:*:) f g)

Methods

gaProduct :: (Int, Gen' Unsized ((f :*: g) p))

GA Unsized f => GAProduct (M1 i c f)

Methods

gaProduct :: (Int, Gen' Unsized (M1 i c f p))

newtype Tagged a b

Constructors

Tagged

Fields

• unTagged :: b

Use the Z and S data types to define the depths of values used by genericArbitraryFrequency' and genericArbitrary' to make generators terminate.

data Z

Zero

Constructors

Z

Instances

BaseCases Z (K1 i c)

Methods

baseCases :: Tagged Z [[K1 i c p]]

data S n

Successor

Constructors

S n

Instances

(Generic c, BaseCases n (Rep c)) => BaseCases (S n) (K1 i c)

Methods

baseCases :: Tagged (S n) [[K1 i c p]]

class BaseCases n f where

A BaseCases n (Rep a) constraint basically provides the list of values of type a with depth at most n.

Minimal complete definition

baseCases

Methods

baseCases :: Tagged n [[f p]]

Instances

BaseCases n U1

Methods

baseCases :: Tagged n [[U1 p]]

(BaseCases n f, BaseCases n g) => BaseCases n ((:*:) f g)

Methods

baseCases :: Tagged n [[(f :*: g) p]]

(BaseCases n f, BaseCases n g) => BaseCases n ((:+:) f g)

Methods

baseCases :: Tagged n [[(f :+: g) p]]

BaseCases Z (K1 i c)

Methods

baseCases :: Tagged Z [[K1 i c p]]

BaseCases n f => BaseCases n (M1 i c f)

Methods

baseCases :: Tagged n [[M1 i c f p]]

(Generic c, BaseCases n (Rep c)) => BaseCases (S n) (K1 i c)

Methods

baseCases :: Tagged (S n) [[K1 i c p]]

type BaseCases' n a = (Generic a, BaseCases n (Rep a))

For convenience.

baseCases' :: forall n f p. BaseCases n f => Tagged n [f p]