Data.Vector.Bit

Bit vectors

type BitVector = Vector Bool

A BitVector is a little-endian Vector of Bools.

Conversions

To and from other Bits instances

unpack :: Bits a => a -> BitVector

Converts an instance of Bits to a BitVector.

Note: this uses bitSize, and will not work for instances which do not implement this method, notably Integer. To unpack Integer values, use unpackInteger.

pack :: Bits a => BitVector -> a

Converts a BitVector to an instance of Bits.

Specialized conversions

unpackInteger :: Integer -> BitVector

packInteger :: BitVector -> Integer

unpackInt :: Int -> BitVector

packInt :: BitVector -> Int

Utilities

pad :: Int -> BitVector -> BitVector

Pads a BitVector to the specified length by adding a vector of False values to the most-significant end.

padMax :: BitVector -> BitVector -> (BitVector, BitVector)

Pads two BitVectors to the length of the longest vector. If the vectors are the same length, padMax does nothing.

zipPad :: BitVector -> BitVector -> Vector (Bool, Bool)

Like zip, except pads the vectors to equal length rather than discarding elements of the longer vector.

trimLeading :: BitVector -> BitVector

Discards any False values at the most-significant end of the given BitVector.