Safe Haskell  None 

Language  Haskell2010 
Synopsis
 lawsCheck :: Laws > IO ()
 lawsCheckMany :: [(String, [Laws])] > IO ()
 lawsCheckOne :: Proxy a > [Proxy a > Laws] > IO ()
 bitsLaws :: (FiniteBits a, Arbitrary a, Show a) => Proxy a > Laws
 eqLaws :: (Eq a, Arbitrary a, Show a) => Proxy a > Laws
 substitutiveEqLaws :: forall a. (Eq a, Arbitrary a, CoArbitrary a, Function a, Show a) => Proxy a > Laws
 numLaws :: (Num a, Eq a, Arbitrary a, Show a) => Proxy a > Laws
 integralLaws :: (Integral a, Arbitrary a, Show a) => Proxy a > Laws
 ixLaws :: (Ix a, Arbitrary a, Show a) => Proxy a > Laws
 isListLaws :: (IsList a, Show a, Show (Item a), Arbitrary a, Arbitrary (Item a), Eq a) => Proxy a > Laws
 monoidLaws :: (Monoid a, Eq a, Arbitrary a, Show a) => Proxy a > Laws
 commutativeMonoidLaws :: (Monoid a, Eq a, Arbitrary a, Show a) => Proxy a > Laws
 semigroupMonoidLaws :: forall a. (Semigroup a, Monoid a, Eq a, Arbitrary a, Show a) => Proxy a > Laws
 ordLaws :: (Ord a, Arbitrary a, Show a) => Proxy a > Laws
 enumLaws :: (Enum a, Eq a, Arbitrary a, Show a) => Proxy a > Laws
 boundedEnumLaws :: (Enum a, Bounded a, Eq a, Arbitrary a, Show a) => Proxy a > Laws
 semigroupLaws :: (Semigroup a, Eq a, Arbitrary a, Show a) => Proxy a > Laws
 commutativeSemigroupLaws :: (Semigroup a, Eq a, Arbitrary a, Show a) => Proxy a > Laws
 exponentialSemigroupLaws :: (Semigroup a, Eq a, Arbitrary a, Show a) => Proxy a > Laws
 idempotentSemigroupLaws :: (Semigroup a, Eq a, Arbitrary a, Show a) => Proxy a > Laws
 rectangularBandSemigroupLaws :: (Semigroup a, Eq a, Arbitrary a, Show a) => Proxy a > Laws
 showLaws :: (Show a, Arbitrary a) => Proxy a > Laws
 showReadLaws :: (Show a, Read a, Eq a, Arbitrary a) => Proxy a > Laws
 storableLaws :: (Storable a, Eq a, Arbitrary a, Show a) => Proxy a > Laws
 genericLaws :: (Generic a, Eq a, Arbitrary a, Show a, Show (Rep a ()), Arbitrary (Rep a ()), Eq (Rep a ())) => Proxy a > Laws
 generic1Laws :: (Generic1 f, Eq1 f, Arbitrary1 f, Show1 f, Eq1 (Rep1 f), Show1 (Rep1 f), Arbitrary1 (Rep1 f)) => proxy f > Laws
 alternativeLaws :: (Alternative f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws
 applicativeLaws :: (Applicative f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws
 contravariantLaws :: (Contravariant f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws
 foldableLaws :: forall proxy f. (Foldable f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws
 functorLaws :: (Functor f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws
 monadLaws :: (Monad f, Applicative f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws
 monadPlusLaws :: (MonadPlus f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws
 monadZipLaws :: (MonadZip f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws
 traversableLaws :: (Traversable f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws
 bifoldableLaws :: forall proxy f. (Bifoldable f, forall a b. (Eq a, Eq b) => Eq (f a b), forall a b. (Show a, Show b) => Show (f a b), forall a b. (Arbitrary a, Arbitrary b) => Arbitrary (f a b)) => proxy f > Laws
 bifunctorLaws :: forall proxy f. (Bifunctor f, forall a b. (Eq a, Eq b) => Eq (f a b), forall a b. (Show a, Show b) => Show (f a b), forall a b. (Arbitrary a, Arbitrary b) => Arbitrary (f a b)) => proxy f > Laws
 bitraversableLaws :: forall proxy f. (Bitraversable f, forall a b. (Eq a, Eq b) => Eq (f a b), forall a b. (Show a, Show b) => Show (f a b), forall a b. (Arbitrary a, Arbitrary b) => Arbitrary (f a b)) => proxy f > Laws
 categoryLaws :: forall proxy c. (Category c, forall a b. (Eq a, Eq b) => Eq (c a b), forall a b. (Show a, Show b) => Show (c a b), forall a b. (Arbitrary a, Arbitrary b) => Arbitrary (c a b)) => proxy c > Laws
 commutativeCategoryLaws :: forall proxy c. (Category c, forall a b. (Eq a, Eq b) => Eq (c a b), forall a b. (Show a, Show b) => Show (c a b), forall a b. (Arbitrary a, Arbitrary b) => Arbitrary (c a b)) => proxy c > Laws
 data Laws = Laws {
 lawsTypeclass :: String
 lawsProperties :: [(String, Property)]
 data Proxy1 (f :: * > *) = Proxy1
 data Proxy2 (f :: * > * > *) = Proxy2
Running
lawsCheck :: Laws > IO () Source #
A convenience function for testing properties in GHCi. For example, at GHCi:
>>>
lawsCheck (monoidLaws (Proxy :: Proxy Ordering))
Monoid: Associative +++ OK, passed 100 tests. Monoid: Left Identity +++ OK, passed 100 tests. Monoid: Right Identity +++ OK, passed 100 tests.
Assuming that the Arbitrary
instance for Ordering
is good, we now
have confidence that the Monoid
instance for Ordering
satisfies
the monoid laws.
A convenience function for checking multiple typeclass instances of multiple types. Consider the following Haskell source file:
import Data.Proxy (Proxy(..)) import Data.Map (Map) import Data.Set (Set)  AProxy
forSet
Int
. setInt :: Proxy (Set Int) setInt = Proxy  AProxy
forMap
Int
Int
. mapInt :: Proxy (Map Int Int) mapInt = Proxy myLaws :: Proxy a > [Laws] myLaws p = [eqLaws p, monoidLaws p] namedTests :: [(String, [Laws])] namedTests = [ ("Set Int", myLaws setInt) , ("Map Int Int", myLaws mapInt) ]
Now, in GHCi:
>>>
lawsCheckMany namedTests
Testing properties for common typeclasses   Set Int   Eq: Transitive +++ OK, passed 100 tests. Eq: Symmetric +++ OK, passed 100 tests. Eq: Reflexive +++ OK, passed 100 tests. Monoid: Associative +++ OK, passed 100 tests. Monoid: Left Identity +++ OK, passed 100 tests. Monoid: Right Identity +++ OK, passed 100 tests. Monoid: Concatenation +++ OK, passed 100 tests.   Map Int Int   Eq: Transitive +++ OK, passed 100 tests. Eq: Symmetric +++ OK, passed 100 tests. Eq: Reflexive +++ OK, passed 100 tests. Monoid: Associative +++ OK, passed 100 tests. Monoid: Left Identity +++ OK, passed 100 tests. Monoid: Right Identity +++ OK, passed 100 tests. Monoid: Concatenation +++ OK, passed 100 tests.
In the case of a failing test, the program terminates with exit code 1.
lawsCheckOne :: Proxy a > [Proxy a > Laws] > IO () Source #
A convenience function that allows one to check many typeclass instances of the same type.
>>>
specialisedLawsCheckMany (Proxy :: Proxy Word) [jsonLaws, showReadLaws]
ToJSON/FromJSON: Encoding Equals Value +++ OK, passed 100 tests. ToJSON/FromJSON: Partial Isomorphism +++ OK, passed 100 tests. Show/Read: Partial Isomorphism +++ OK, passed 100 tests.
Properties
Ground types
bitsLaws :: (FiniteBits a, Arbitrary a, Show a) => Proxy a > Laws Source #
Tests the following properties:
 Conjunction Idempotence
n .&. n ≡ n
 Disjunction Idempotence
n .. n ≡ n
 Double Complement
complement (complement n) ≡ n
 Set Bit
setBit n i ≡ n .. bit i
 Clear Bit
clearBit n i ≡ n .&. complement (bit i)
 Complement Bit
complementBit n i ≡ xor n (bit i)
 Clear Zero
clearBit zeroBits i ≡ zeroBits
 Set Zero
setBit zeroBits i ≡ bit i
 Test Zero
testBit zeroBits i ≡ False
 Pop Zero
popCount zeroBits ≡ 0
 Right Rotation
no sign extension → (rotateR n i ≡ (shiftR n i) .. (shiftL n (finiteBitSize ⊥  i)))
 Left Rotation
no sign extension → (rotateL n i ≡ (shiftL n i) .. (shiftR n (finiteBitSize ⊥  i)))
 Count Leading Zeros of Zero
countLeadingZeros zeroBits ≡ finiteBitSize ⊥
 Count Trailing Zeros of Zero
countTrailingZeros zeroBits ≡ finiteBitSize ⊥
All of the useful instances of the Bits
typeclass
also have FiniteBits
instances, so these property
tests actually require that instance as well.
Note: This property test is only available when
using base4.7
or newer.
eqLaws :: (Eq a, Arbitrary a, Show a) => Proxy a > Laws Source #
Tests the following properties:
 Transitive
a
==
b ∧ b==
c ⇒ a==
c Symmetric
a
==
b ⇒ b==
a Reflexive
a
==
a Negation
x
/=
y==
not
(x==
y)
Some of these properties involve implication. In the case that the left hand side of the implication arrow does not hold, we do not retry. Consequently, these properties only end up being useful when the data type has a small number of inhabitants.
substitutiveEqLaws :: forall a. (Eq a, Arbitrary a, CoArbitrary a, Function a, Show a) => Proxy a > Laws Source #
numLaws :: (Num a, Eq a, Arbitrary a, Show a) => Proxy a > Laws Source #
Tests the following properties:
 Additive Commutativity
a + b ≡ b + a
 Additive Left Identity
0 + a ≡ a
 Additive Right Identity
a + 0 ≡ a
 Multiplicative Associativity
a * (b * c) ≡ (a * b) * c
 Multiplicative Left Identity
1 * a ≡ a
 Multiplicative Right Identity
a * 1 ≡ a
 Multiplication Left Distributes Over Addition
a * (b + c) ≡ (a * b) + (a * c)
 Multiplication Right Distributes Over Addition
(a + b) * c ≡ (a * c) + (b * c)
 Multiplicative Left Annihilation
0 * a ≡ 0
 Multiplicative Right Annihilation
a * 0 ≡ 0
 Additive Inverse
negate
a+
a ≡ 0 Subtraction
a
+
negate
b ≡ a
b Abs Is Idempotent
 @
abs
(abs
a) ≡abs
a  Signum Is Idempotent
 @
signum
(signum
a) ≡signum
a  Product Of Abs And Signum Is Id
abs
a *signum
a ≡ a
integralLaws :: (Integral a, Arbitrary a, Show a) => Proxy a > Laws Source #
Tests the following properties:
 Quotient Remainder
(quot x y) * y + (rem x y) ≡ x
 Division Modulus
(div x y) * y + (mod x y) ≡ x
 Integer Roundtrip
fromInteger (toInteger x) ≡ x
 QuotRem is (Quot, Rem)
quotRem x y ≡ (quot x y, rem x y)
 DivMod is (Div, Mod)
divMod x y ≡ (div x y, mod x y)
isListLaws :: (IsList a, Show a, Show (Item a), Arbitrary a, Arbitrary (Item a), Eq a) => Proxy a > Laws Source #
Tests the following properties:
 Partial Isomorphism
fromList . toList ≡ id
 Length Preservation
fromList xs ≡ fromListN (length xs) xs
Note: This property test is only available when
using base4.7
or newer.
monoidLaws :: (Monoid a, Eq a, Arbitrary a, Show a) => Proxy a > Laws Source #
Tests the following properties:
 Associative
mappend a (mappend b c) ≡ mappend (mappend a b) c
 Left Identity
mappend mempty a ≡ a
 Right Identity
mappend a mempty ≡ a
 Concatenation
mconcat as ≡ foldr mappend mempty as
commutativeMonoidLaws :: (Monoid a, Eq a, Arbitrary a, Show a) => Proxy a > Laws Source #
Tests the following properties:
 Commutative
mappend a b ≡ mappend b a
Note that this does not test associativity or identity. Make sure to use
monoidLaws
in addition to this set of laws.
semigroupMonoidLaws :: forall a. (Semigroup a, Monoid a, Eq a, Arbitrary a, Show a) => Proxy a > Laws Source #
ordLaws :: (Ord a, Arbitrary a, Show a) => Proxy a > Laws Source #
Tests the following properties:
 Antisymmetry
a ≤ b ∧ b ≤ a ⇒ a = b
 Transitivity
a ≤ b ∧ b ≤ c ⇒ a ≤ c
 Totality
a ≤ b ∨ a > b
enumLaws :: (Enum a, Eq a, Arbitrary a, Show a) => Proxy a > Laws Source #
Tests the following properties:
This only works for Enum
types that are not bounded, meaning
that succ
and pred
must be total. This means that these property
tests work correctly for types like Integer
but not for Int
.
Sadly, there is not a good way to test fromEnum
and toEnum
,
since many types that have reasonable implementations for succ
and pred
have more inhabitants than Int
does.
commutativeSemigroupLaws :: (Semigroup a, Eq a, Arbitrary a, Show a) => Proxy a > Laws Source #
Tests the following properties:
Note that this does not test associativity. Make sure to use
semigroupLaws
in addition to this set of laws.
idempotentSemigroupLaws :: (Semigroup a, Eq a, Arbitrary a, Show a) => Proxy a > Laws Source #
Tests the following properties:
 Idempotent
a
<>
a ≡ a
Note that this does not test associativity. Make sure to use
semigroupLaws
in addition to this set of laws. In literature,
this class of semigroup is known as a band.
rectangularBandSemigroupLaws :: (Semigroup a, Eq a, Arbitrary a, Show a) => Proxy a > Laws Source #
Tests the following properties:
Note that this does not test associativity. Make sure to use
semigroupLaws
in addition to this set of laws.
showReadLaws :: (Show a, Read a, Eq a, Arbitrary a) => Proxy a > Laws Source #
Tests the following properties:
 Partial Isomorphism:
show
/read
readMaybe
(show
a) ≡Just
a Partial Isomorphism:
show
/read
with initial space readMaybe
(" " ++show
a) ≡Just
a Partial Isomorphism:
showsPrec
/readsPrec
(a,"") `elem`
readsPrec
p (showsPrec
p a "") Partial Isomorphism:
showList
/readList
(as,"") `elem`
readList
(showList
as "") Partial Isomorphism:
showListWith
shows
/readListDefault
(as,"") `elem`
readListDefault
(showListWith
shows
as "")
Note: When using base4.5
or older, a shim implementation
of readMaybe
is used.
storableLaws :: (Storable a, Eq a, Arbitrary a, Show a) => Proxy a > Laws Source #
Tests the following Storable
properties:
 SetGet
(
pokeElemOff
ptr ix a >>peekElemOff
ptr ix') ≡pure
a GetSet
(
peekElemOff
ptr ix >>pokeElemOff
ptr ix a) ≡pure
a
genericLaws :: (Generic a, Eq a, Arbitrary a, Show a, Show (Rep a ()), Arbitrary (Rep a ()), Eq (Rep a ())) => Proxy a > Laws Source #
Tests the following properties:
Note: This property test is only available when
using base4.5
or newer.
Note: from
and to
don't actually care about
the type variable x
in
, so here we instantiate
it to Rep
a x
by default. If you would like to instantiate ()
x
as something else, please file a bug report.
generic1Laws :: (Generic1 f, Eq1 f, Arbitrary1 f, Show1 f, Eq1 (Rep1 f), Show1 (Rep1 f), Arbitrary1 (Rep1 f)) => proxy f > Laws Source #
Unary type constructors
alternativeLaws :: (Alternative f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws Source #
applicativeLaws :: (Applicative f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws Source #
contravariantLaws :: (Contravariant f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws Source #
foldableLaws :: forall proxy f. (Foldable f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws Source #
Tests the following Foldable
properties:
 fold
fold
≡foldMap
id
 foldMap
foldMap
f ≡foldr
(mappend
. f)mempty
 foldr
foldr
f z t ≡appEndo
(foldMap
(Endo
. f) t ) z foldr'
foldr'
f z0 xs ≡ let f' k x z = k$!
f x z infoldl
f'id
xs z0 foldr1
foldr1
f t ≡ letJust
(xs,x) =unsnoc
(toList
t) infoldr
f x xs foldl
foldl
f z t ≡appEndo
(getDual
(foldMap
(Dual
.Endo
.flip
f) t)) z foldl'
foldl'
f z0 xs ≡ let f' x k z = k$!
f z x infoldr
f'id
xs z0 foldl1
foldl1
f t ≡ let x : xs =toList
t infoldl
f x xs toList
toList
≡foldr
(:) [] null
null
≡foldr
(const
(const
False
))True
 length
length
≡getSum
.foldMap
(const
(Sum
1))
Note that this checks to ensure that foldl'
and foldr'
are suitably strict.
functorLaws :: (Functor f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws Source #
monadLaws :: (Monad f, Applicative f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws Source #
monadPlusLaws :: (MonadPlus f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws Source #
monadZipLaws :: (MonadZip f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws Source #
traversableLaws :: (Traversable f, forall a. Eq a => Eq (f a), forall a. Show a => Show (f a), forall a. Arbitrary a => Arbitrary (f a)) => proxy f > Laws Source #
Tests the following Traversable
properties:
 Naturality
t
for every applicative transformation.
traverse
f ≡traverse
(t.
f)t
 Identity
traverse
Identity
≡Identity
 Composition
traverse
(Compose
.
fmap
g.
f) ≡Compose
.
fmap
(traverse
g).
traverse
f Sequence Naturality
t
for every applicative transformation.
sequenceA
≡sequenceA
.
fmap
tt
 Sequence Identity
sequenceA
.
fmap
Identity
≡Identity
 Sequence Composition
sequenceA
.
fmap
Compose
≡Compose
.
fmap
sequenceA
.
sequenceA
 foldMap
foldMap
≡foldMapDefault
 fmap
fmap
≡fmapDefault
Where an applicative transformation is a function
t :: (Applicative f, Applicative g) => f a > g a
preserving the Applicative
operations, i.e.
Binary type constructors
bifoldableLaws :: forall proxy f. (Bifoldable f, forall a b. (Eq a, Eq b) => Eq (f a b), forall a b. (Show a, Show b) => Show (f a b), forall a b. (Arbitrary a, Arbitrary b) => Arbitrary (f a b)) => proxy f > Laws Source #
Tests the following Bifunctor
properties:
 Bifold Identity
bifold
≡bifoldMap
id
id
 BifoldMap Identity
bifoldMap
f g ≡bifoldr
(mappend
.
f) (mappend
.
g)mempty
 Bifoldr Identity
bifoldr
f g z t ≡appEndo
(bifoldMap
(Endo
.
f) (Endo
.
g) t) z
Note: This property test is only available when this package is built with
base4.10+
or transformers0.5+
.
bifunctorLaws :: forall proxy f. (Bifunctor f, forall a b. (Eq a, Eq b) => Eq (f a b), forall a b. (Show a, Show b) => Show (f a b), forall a b. (Arbitrary a, Arbitrary b) => Arbitrary (f a b)) => proxy f > Laws Source #
bitraversableLaws :: forall proxy f. (Bitraversable f, forall a b. (Eq a, Eq b) => Eq (f a b), forall a b. (Show a, Show b) => Show (f a b), forall a b. (Arbitrary a, Arbitrary b) => Arbitrary (f a b)) => proxy f > Laws Source #
Tests the following Bitraversable
properties:
 Naturality
for every applicative transformationbitraverse
(t.
f) (t.
g) ≡ t.
bitraverse
f gt
 Identity
bitraverse
Identity
Identity
≡Identity
 Composition
Compose
.
fmap
(bitraverse
g1 g2).
bitraverse
f1 f2 ≡bitraverse
(Compose
.
fmap
g1 g2.
f1) (Compose
.
fmap
g2.
f2)
Note: This property test is only available when this package is built with
base4.9+
or transformers0.5+
.
categoryLaws :: forall proxy c. (Category c, forall a b. (Eq a, Eq b) => Eq (c a b), forall a b. (Show a, Show b) => Show (c a b), forall a b. (Arbitrary a, Arbitrary b) => Arbitrary (c a b)) => proxy c > Laws Source #
commutativeCategoryLaws :: forall proxy c. (Category c, forall a b. (Eq a, Eq b) => Eq (c a b), forall a b. (Show a, Show b) => Show (c a b), forall a b. (Arbitrary a, Arbitrary b) => Arbitrary (c a b)) => proxy c > Laws Source #
Test everything from categoryLaws
plus the following:
Note: This property test is only available when this package is built with
base4.9+
or transformers0.5+
.
Types
A set of laws associated with a typeclass.
Note: Most of the toplevel functions provided
by this library have the shape
`forall a. (Ctx a) => Proxy a > Laws`. You can just
as easily provide your own Laws
in libraries/test suites
using regular QuickCheck machinery.
Laws  
