# The sbv package

Express properties about Haskell programs and automatically prove them using SMT (Satisfiability Modulo Theories) solvers. Automatically generate C programs from Haskell functions. The SBV library adds support for symbolic bit vectors and other symbolic types, allowing formal models of Haskell programs to be created.

$ ghci -XScopedTypeVariables Prelude> :m Data.SBV Prelude Data.SBV> prove $ \(x::SWord8) -> x `shiftL` 2 .== 4*x Q.E.D. Prelude Data.SBV> prove $ forAll ["x"] $ \(x::SWord8) -> x `shiftL` 2 .== x Falsifiable. Counter-example: x = 128 :: SWord8

The SBV library uses Microsoft's Z3 SMT solver (http://research.microsoft.com/en-us/um/redmond/projects/z3/) as the default underlying solver. It is also possible to use SRI's Yices SMT solver with SBV as well (http://yices.csl.sri.com/download-yices2.shtml), although the Z3 binding is much more richer.

SBV introduces the following types and concepts:

`SBool`: Symbolic Booleans (bits)`SWord8`,`SWord16`,`SWord32`,`SWord64`: Symbolic Words (unsigned)`SInt8`,`SInt16`,`SInt32`,`SInt64`: Symbolic Ints (signed)`SInteger`: Symbolic unbounded integers (signed)`SReal`: Symbolic algebraic reals (signed)`SArray`,`SFunArray`: Flat arrays of symbolic values`STree`: Full binary trees of symbolic values (for fast symbolic access)Symbolic polynomials over GF(2^n), and polynomial arithmetic

Uninterpreted constants and functions over symbolic values, with user defined axioms.

Uninterpreted sorts, and proofs over such sorts, potentially with axioms.

Functions built out of these types can be:

proven correct via an external SMT solver (the

`prove`function)checked for satisfiability (the

`sat`, and`allSat`functions)used in synthesis (the

`sat`function with existential variables)optimized with respect to cost functions (the

`optimize`,`maximize`, and`minimize`functions)quick-checked

used in concrete test case generation (the

`genTest`function), rendered as values in various languages, including Haskell and C.

Predicates can have both existential and universal variables. Use of alternating quantifiers provides considerable expressive power. Furthermore, existential variables allow synthesis via model generation.

The SBV library can also compile Haskell functions that manipulate symbolic values directly to C, rendering them as straight-line C programs.

In addition to the library, the installation will create the
executable `SBVUnitTests`. You should run it once the installation is complete,
to make sure the unit tests are run and all is well.

SBV is hosted at GitHub: http://github.com/LeventErkok/sbv. Comments, bug reports, and patches are always welcome.

The following people reported bugs, provided comments/feedback, or contributed to the development of SBV in various ways: Ian Blumenfeld, Ian Calvert, Iavor Diatchki, John Erickson, Tom Hawkins, Lee Pike, Austin Seipp, Don Stewart, Josef Svenningsson, and Nis Wegmann.

Release notes can be seen at: http://github.com/LeventErkok/sbv/blob/master/RELEASENOTES.

[Skip to ReadMe]

## Properties

Versions | 0.9, 0.9.1, 0.9.2, 0.9.3, 0.9.4, 0.9.5, 0.9.6, 0.9.7, 0.9.8, 0.9.9, 0.9.10, 0.9.11, 0.9.12, 0.9.13, 0.9.14, 0.9.15, 0.9.16, 0.9.17, 0.9.18, 0.9.19, 0.9.20, 0.9.21, 0.9.22, 0.9.23, 0.9.24, 1.0, 1.1, 1.2, 1.3, 1.4, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 4.0, 4.1, 4.2, 4.3, 4.4, 5.0 (info) |
---|---|

Change log | None available |

Dependencies | array, base (==4.*), containers, deepseq, directory, filepath, HUnit, mtl, old-time, pretty, process, QuickCheck, random, sbv, syb [details] |

License | BSD3 |

Copyright | Levent Erkok, 2010-2012 |

Author | Levent Erkok |

Maintainer | Levent Erkok (erkokl@gmail.com) |

Stability | Experimental |

Category | Formal Methods, Theorem Provers, Bit vectors, Symbolic Computation, Math, SMT |

Home page | http://github.com/LeventErkok/sbv |

Bug tracker | http://github.com/LeventErkok/sbv/issues |

Source repository | head: git clone git://github.com/LeventErkok/sbv.git |

Executables | SBVUnitTests |

Uploaded | Fri Oct 19 13:29:59 UTC 2012 by LeventErkok |

Distributions | LTSHaskell:4.4, NixOS:5.0, Stackage:4.4 |

Downloads | 8324 total (433 in last 30 days) |

Votes | |

Status | Docs not available [build log] All reported builds failed as of 2015-06-07 [all 2 reports] |

## Modules

*Data*- Data.SBV
*Examples**BitPrecise*- Data.SBV.Examples.BitPrecise.BitTricks
- Data.SBV.Examples.BitPrecise.Legato
- Data.SBV.Examples.BitPrecise.MergeSort
- Data.SBV.Examples.BitPrecise.PrefixSum

*CodeGeneration*- Data.SBV.Examples.CodeGeneration.AddSub
- Data.SBV.Examples.CodeGeneration.CRC_USB5
- Data.SBV.Examples.CodeGeneration.Fibonacci
- Data.SBV.Examples.CodeGeneration.GCD
- Data.SBV.Examples.CodeGeneration.PopulationCount
- Data.SBV.Examples.CodeGeneration.Uninterpreted

*Crypto*- Data.SBV.Examples.Crypto.AES
- Data.SBV.Examples.Crypto.RC4

*Existentials*- Data.SBV.Examples.Existentials.CRCPolynomial
- Data.SBV.Examples.Existentials.Diophantine

*Polynomials*- Data.SBV.Examples.Polynomials.Polynomials

*Puzzles*- Data.SBV.Examples.Puzzles.Coins
- Data.SBV.Examples.Puzzles.Counts
- Data.SBV.Examples.Puzzles.DogCatMouse
- Data.SBV.Examples.Puzzles.Euler185
- Data.SBV.Examples.Puzzles.MagicSquare
- Data.SBV.Examples.Puzzles.NQueens
- Data.SBV.Examples.Puzzles.Sudoku
- Data.SBV.Examples.Puzzles.U2Bridge

*Uninterpreted*- Data.SBV.Examples.Uninterpreted.AUF
- Data.SBV.Examples.Uninterpreted.Deduce
- Data.SBV.Examples.Uninterpreted.Function
- Data.SBV.Examples.Uninterpreted.Sort

- Data.SBV.Internals

- Data.SBV

## Downloads

- sbv-2.5.tar.gz [browse] (Cabal source package)
- Package description (included in the package)

#### Maintainers' corner

For package maintainers and hackage trustees