Skip to content

Latest commit

 

History

History
68 lines (39 loc) · 4.47 KB

README.md

File metadata and controls

68 lines (39 loc) · 4.47 KB
Raw

Efficient little-endian bit vector Haskell library

Build Status Workflow Status Coverage Status License FreeBSD

Hackage Hackage CI

Stackage LTS Stackage Nightly

This package contains an efficient implementation of little-endian, immutable bit vectors. It implements most applicable type-classes and also conversions to and from signed or unsigned numbers.

For an implementation of big-endian, immutable bit vectors, use the bv package.

For an implementation of little-endian, mutable bit vectors, use the bitvec package.

Accessing type-class instances

This package utilizes the "multiple sub-libraries" feature of Cabal. The intended usage is an "opt-in" dependency footprint for the bv-little package, as not all type-class instances which are defined are exposed by default. Therefore package consumers can select which, if any, type-class instances outside of the core libraries they wish to have exposed and transitively depend on the associated package(s).

New type-class instance exposure procedure:

  1. All BitVector instances of type-classes defined in base are exported by default from the Data.BitVector.LittleEndian module.

  2. Each BitVector instance of a type-class defined in a package other than base is exposed through a specific sub-library dependency and a special exposing module.

To access an instance of a type-class defined outside base, add the requisite sub-library to your build-depends and import the corresponding exposing module within your code-base.

Sub-library Dependency Exposing Module Type-class Instance(s)
bv-little:instances-binary Data.BitVector.LittleEndian.Binary
  • Binary
bv-little:instances-mono-traversable Data.BitVector.LittleEndian.MonoTraversable
  • MonoFoldable
  • MonoFunctor
  • MonoTraversable
bv-little:instances-mono-traversable-keys Data.BitVector.LittleEndian.MonoKeyed
  • MonoAdjustable
  • MonoFoldableWithKey
  • MonoIndexable
  • MonoKeyed
  • MonoLookup
  • MonoTraversableWithKey
  • MonoZip
  • MonoZipWithKey
bv-little:instances-quickcheck Data.BitVector.LittleEndian.QuickCheck
  • Arbitrary
  • CoArbitrary
bv-little:instances-text-show Data.BitVector.LittleEndian.TextShow
  • TextShow

Tests

The test suite ensures that all type-class instances are "lawful" and that data-structure–specific functionality is well defined.

The TestSuite.hs file contains the specification. It can be run by invoking any of the following commands:

  • cabal test

  • stack test

Benchmarks

The benchmarks provide an empyrical check for the asymptotic complexity of data structure operations and also provide easy metrics for detecting performance regressions.

The Benchmarks.hs file contains these metrics. It can be run by invoking any of the following commands:

  • cabal bench

  • stack bench