quickspec: Equational laws for free!

[ bsd3, library, testing ] [ Propose Tags ]

QuickSpec takes your Haskell code and, as if by magic, discovers laws about it. You give QuickSpec a collection of Haskell functions; QuickSpec tests your functions with QuickCheck and prints out laws which seem to hold.

For example, give QuickSpec the functions reverse, ++ and [], and it will find six laws:

reverse [] == []
xs ++ [] == xs
[] ++ xs == xs
reverse (reverse xs) == xs
(xs ++ ys) ++ zs == xs ++ (ys ++ zs)
reverse xs ++ reverse ys == reverse (ys ++ xs)

QuickSpec can find equational laws as well as conditional equations. All you need to supply are the functions to test, as well as Ord and Arbitrary instances for QuickSpec to use in testing; the rest is automatic.

For information on how to use QuickSpec, see the documentation in the main module, QuickSpec. You can also look in the examples directory, for example at Lists.hs, IntSet.hs, or Parsing.hs. To read about how QuickSpec works, see our paper, Quick specifications for the busy programmer.


[Skip to Readme]
Versions 0.9, 0.9.1, 0.9.2, 0.9.3, 0.9.4, 0.9.5, 0.9.6, 2, 2.1
Dependencies base (==4.*), constraints, containers, data-lens-light (>=0.1.1), dlist, QuickCheck (>=2.10), quickcheck-instances (>=0.3.15), random, spoon, template-haskell, transformers, twee-lib (==2.1.5), uglymemo [details]
License BSD-3-Clause
Copyright 2009-2018 Nick Smallbone
Author Nick Smallbone
Maintainer nicsma@chalmers.se
Category Testing
Home page https://github.com/nick8325/quickspec
Source repo head: git clone git://github.com/nick8325/quickspec.git -b master
Uploaded by NickSmallbone at Wed May 16 11:29:48 UTC 2018
Distributions NixOS:2.1
Downloads 3061 total (35 in the last 30 days)
Rating 1.75 (votes: 1) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-05-16 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

  • QuickSpec
    • QuickSpec.Explore
      • QuickSpec.Explore.Conditionals
      • QuickSpec.Explore.PartialApplication
      • QuickSpec.Explore.Polymorphic
      • QuickSpec.Explore.Schemas
      • QuickSpec.Explore.Terms
    • QuickSpec.Haskell
      • QuickSpec.Haskell.Resolve
    • QuickSpec.Parse
    • QuickSpec.Prop
    • QuickSpec.Pruning
      • QuickSpec.Pruning.Background
      • QuickSpec.Pruning.Twee
      • QuickSpec.Pruning.Types
      • QuickSpec.Pruning.UntypedTwee
    • QuickSpec.Term
    • QuickSpec.Terminal
    • QuickSpec.Testing
      • QuickSpec.Testing.DecisionTree
      • QuickSpec.Testing.QuickCheck
    • QuickSpec.Type
    • QuickSpec.Utils

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for quickspec-2.1

[back to package description]

QuickSpec: equational laws for free!

QuickSpec takes your Haskell code and, as if by magic, discovers laws about it. You give QuickSpec a collection of Haskell functions; QuickSpec tests your functions with QuickCheck and prints out laws which seem to hold.

For example, give QuickSpec the functions reverse, ++ and [], and it will find six laws:

reverse [] == []
xs ++ [] == xs
[] ++ xs == xs
reverse (reverse xs) == xs
(xs ++ ys) ++ zs == xs ++ (ys ++ zs)
reverse xs ++ reverse ys == reverse (ys ++ xs)

QuickSpec can find equational laws as well as conditional equations. All you need to supply are the functions to test, as well as Ord and Arbitrary instances for QuickSpec to use in testing; the rest is automatic.

For information on how to use QuickSpec, see the documentation. You can also look in the examples directory, for example at List.hs, IntSet.hs, or Parsing.hs. To read about how QuickSpec works, see our paper, Quick specifications for the busy programmer.