bv-little

Efficient little-endian bit vector library

https://github.com/recursion-ninja/bv-little

Version on this page:1.0.0
LTS Haskell 22.14:1.3.2
Stackage Nightly 2024-03-28:1.3.2
Latest on Hackage:1.3.2

See all snapshots bv-little appears in

BSD-3-Clause licensed by Alex Washburn
Maintained by [email protected]
This version can be pinned in stack with:bv-little-1.0.0@sha256:654c1ab395c26e2184bf0c74454702687f7d130a6a83d8c0b23a8de41d656362,5363

Module documentation for 1.0.0

Efficient little-endian bit vector Haskell library

Build Status Coverage Status License FreeBSD Hackage Stackage Nightly Stackage LTS

This package contains an efficient implementation of little-endian bit vectors. It implements most applicable typeclasses and also conversions to and from signed or unsigned numbers. Care has been taken to balance the number of transitive dependencies with respect to functionality provided.

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

Tests

The test suite ensures that all typeclass 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 new-test

  • cabal test

  • stack test

Benchmarks

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

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

  • cabal new-bench

  • cabal bench

  • stack bench

Changes

Unreleased Changes

  • None

v1.0.0

  • Added explicit recursion to monomorphic folds to improve time and space performance

  • Added the following instances:

    • MonoAdjustable
    • MonoFoldableWithKey
    • MonoIndexable
    • MonoKeyed
    • MonoLookup
    • MonoTraversableWithKey
    • MonoZip
    • MonoZipWithKey
    • TextShow
  • Updated the following functions to be constant time:

    • omap
    • olength64
    • oall
    • oany
    • ofoldr1Ex
    • ofoldl1Ex
    • oelem
    • onotElem
    • ozipWith

v0.1.2

  • Updating to base bounds for GHC 8.6.1

v0.1.1

  • Updated to well-typed internal representation

  • Corrected defect in rotate, rotateL, and rotateR

  • Improved performance by switching exponentiation with base 2 to bit shifting operations

  • Improved performance of clearBit by increasing strictness

  • Increased benchmark coverage

  • Increased test suite coverage

v0.1.0

  • Created instances of applicable typeclass instances

  • Added numeric conversion functions

  • Added basic test suite

  • Added stub benchmark