Maintainer	Iago Abal <iago.abal@gmail.com>
Safe Haskell	Safe-Inferred

Data.BitVector

Contents

Bit-vectors
Creation
Comparison
Indexing
Arithmetic
List-like operations
Bitwise operations
Conversion
Utilities

Description

Implementation of bit-vectors as wrappers over Integer.

Bit-vectors are interpreted as unsigned integers (i.e. natural numbers) except for some very specific cases.
Bit-vectors are size-polymorphic insofar as most operations treat a bit-vector of size k as of size n for n >= k if required.

For documentation purposes we will write [n]k to denote a bit-vector of size n representing the natural number k.

Synopsis

Bit-vectors

type BitVector = BV Source

An alias for BV.

data BV Source

Big-endian pseudo size-polymorphic bit-vectors.

Instances

Enum BV
Eq BV
Integral BV
Num BV
Ord BV
Real BV
Show BV
Bits BV

size :: BV -> Int Source

The size of a bit-vector.

width :: BV -> Int Source

An alias for size.

nat :: BV -> Integer Source

The value of a bit-vector, as a natural number.

uint :: BV -> Integer Source

An alias for nat.

int :: BV -> Integer Source

2's complement value of a bit-vector.

Creation

bitVec :: Integral a => Int -> a -> BV Source

Create a bit-vector given a size and an integer value.

>>> bitVec 4 3
[4]3

This function also handles negative values.

>>> bitVec 4 (-1)
[4]15

ones :: Int -> BV Source

Create a mask of ones.

zeros :: Int -> BV Source

Create a mask of zeros.

Comparison

(==.) :: BV -> BV -> Bool Source

Fixed-size equality.

In contrast with ==, which is size-polymorphic, this equality requires both bit-vectors to be of equal size.

>>> [n]k ==. [m]k
False

>>> [n]k == [n]k
True

(/=.) :: BV -> BV -> Bool Source

Fixed-size inequality.

The negated version of ==..

Indexing

(@.) :: BV -> Int -> Bool Source

Bit indexing.

u @. i stands for the i-th bit of u.

>>> [4]2 @. 0
False

>>> [4]2 @. 1
True

(@@) :: BV -> (Int, Int) -> BV Source

Bit-string extraction.

u @@ (j,i) == fromBits (map (u @.) [j,j-1..i])

>>> [4]7 @@ (3,1)
[3]3

(!.) :: BV -> Int -> Bool Source

Reverse bit-indexing.

Index from the end of the sequenc

u !. i == u @. (size u - i - 1)

>>> [3]3 !. 0
False

least :: Int -> BV -> BV Source

Take least significant bits.

least m u == u @@ (m-1,0)

most :: Int -> BV -> BV Source

Take most significant bits.

most m u == u @@ (n-1,n-m)

msb :: BV -> Bool Source

Most significant bit.

msb u == u !. 0

lsb :: BV -> Bool Source

Least significant bit.

lsb u == u @. 0

msb1 :: BV -> Int Source

Most significant 1-bit.

Pre: input must be non-zero.

>>> msb1 [4]2
1

>>> msb1 [4]4
2

Arithmetic

sdiv :: BV -> BV -> BV Source

2's complement signed division.

srem :: BV -> BV -> BV Source

2's complement signed remainder (sign follows dividend).

smod :: BV -> BV -> BV Source

2's complement signed remainder (sign follows divisor).

lg2 :: BV -> BV Source

Ceiling logarithm base 2.

Pre: input bit-vector must be non-zero.

List-like operations

(#) :: BV -> BV -> BV Source

Concatenation of two bit-vectors.

zeroExtend :: Int -> BV -> BV Source

Logical extension.

>>> zeroExtend 3 [1]1
[4]1

signExtend :: Int -> BV -> BV Source

Arithmetic extension.

>>> signExtend 2 [2]1
[4]1

>>> signExtend 2 [2]3
[4]15

foldl_ :: (a -> Bool -> a) -> a -> BV -> aSource

foldl_ f z (fromBits [un, ..., u1, u0]) == ((((z `f` un) `f` ...) `f` u1) `f` u0)

foldl_ f e = fromBits . foldl f e . toBits

foldr_ :: (Bool -> a -> a) -> a -> BV -> aSource

foldr_ f z (fromBits [un, ..., u1, u0]) == un f (... f (u1 `f` (u0 `f` z)))

foldr_ f e = fromBits . foldr f e . toBits

reverse_ :: BV -> BV Source

reverse_ == fromBits . reverse . toBits

replicate_ :: Int -> BV -> BV Source

Pre: if replicate_ n u then n > 0 must hold.

replicate_ n == fromBits . concat . replicate n . toBits

Bitwise operations

module Data.Bits

not_ :: BV -> BV Source

An alias for complement.

nand :: BV -> BV -> BV Source

Negated .&..

nor :: BV -> BV -> BV Source

Negated .|..

xnor :: BV -> BV -> BV Source

Negated xor.

(<<.) :: BV -> BV -> BV Source

Left shift.

(>>.) :: BV -> BV -> BV Source

Logical right shift.

ashr :: BV -> BV -> BV Source

Arithmetic right shift

(<<<.) :: BV -> BV -> BV Source

Rotate left.

(>>>.) :: BV -> BV -> BV Source

Rotate right.

Conversion

fromBits :: [Bool] -> BV Source

Create a bit-vector from a big-endian list of bits.

>>> fromBits [False, False, True]
[3]1

toBits :: BV -> [Bool]Source

Create a big-endian list of bits from a bit-vector.

>>> toBits [4]11
[True, False, True, True]

Utilities

maxNat :: Integral a => Int -> aSource

Greatest natural number representable with n bits.

integerWidth :: Integer -> Int Source

Minimum width of a bit-vector to represent a given integer number.

>>> integerWith 4
3

>>> integerWith (-4)
4