bv-little: Efficient little-endian bit vector library

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Warnings:

This package contains a time- and space- efficient implementation of little-endian, immutable bit vectors. Provides implementations of applicable typeclasses and numeric conversions.

The declared cost of each operation is either worst-case or amortized.

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.


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.1, 0.1.2, 1.0.0, 1.0.1, 1.1.0, 1.1.1, 1.1.1
Change log changelog.md
Dependencies base (>=4.5.1 && <5), deepseq (>=1.4.1.1), hashable (>=1.2.3.2), integer-gmp (>=1.0), keys (>=3.10.1), mono-traversable (>=1.0.5.0), mono-traversable-keys (>=0.1.0), primitive (>=0.6.4.0), QuickCheck (>=2.8), semigroups (>=0.18 && <1.0), text-show (>=3.2.1) [details]
License BSD-3-Clause
Copyright (c) Alex Washburn 2018
Author Alex Washburn
Maintainer hackage@recursion.ninja
Category Data, Bit Vectors
Home page https://github.com/recursion-ninja/bv-little
Bug tracker https://github.com/recursion-ninja/bv-little/issues
Source repo head: git clone https://github.com/recursion-ninja/bv-little
Uploaded by recursion_ninja at 2019-10-09T15:11:16Z

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for bv-little-1.1.1

[back to package description]

Efficient little-endian bit vector Haskell library

Build 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 typeclasses 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.

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:

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 Benchmaks.hs file contains these metrics. It can be run by invoking any of the following commands: