Copyright	© Edward Kmett 2010-2015, © Eric Mertens 2014, Johan Kiviniemi 2013
License	BSD3
Maintainer	Edward Kmett <ekmett@gmail.com>
Stability	experimental
Portability	non-portable
Safe Haskell	Safe
Language	Haskell2010

Ersatz.Bits

Contents

Fixed length bit vectors
Variable length bit vectors
Adders

Description

Bits is an arbitrary length natural number type

Synopsis

Fixed length bit vectors

newtype Bit1 Source

A container of 1 Bit that encodes from and decodes to Word8

Constructors

Bit1 Bit

Instances

Num Bit1
Show Bit1
Generic Bit1
Variable Bit1
Codec Bit1
Boolean Bit1
Equatable Bit1
Orderable Bit1
HasBits Bit1
Typeable * Bit1
type Rep Bit1
type Decoded Bit1 = Word8

data Bit2 Source

A container of 2 Bits that encodes from and decodes to Word8

Constructors

Bit2 !Bit !Bit

Instances

Num Bit2
Show Bit2
Generic Bit2
Variable Bit2
Codec Bit2
Boolean Bit2
Equatable Bit2
Orderable Bit2
HasBits Bit2
Typeable * Bit2
type Rep Bit2
type Decoded Bit2 = Word8

data Bit3 Source

A container of 3 Bits that encodes from and decodes to Word8

Constructors

Bit3 !Bit !Bit !Bit

Instances

Show Bit3
Generic Bit3
Variable Bit3
Codec Bit3
Boolean Bit3
Equatable Bit3
Orderable Bit3
HasBits Bit3
Typeable * Bit3
type Rep Bit3
type Decoded Bit3 = Word8

data Bit4 Source

A container of 4 Bits that encodes from and decodes to Word8

Constructors

Bit4 !Bit !Bit !Bit !Bit

Instances

Show Bit4
Generic Bit4
Variable Bit4
Codec Bit4
Boolean Bit4
Equatable Bit4
Orderable Bit4
HasBits Bit4
Typeable * Bit4
type Rep Bit4
type Decoded Bit4 = Word8

data Bit5 Source

A container of 5 Bits that encodes from and decodes to Word8

Constructors

Bit5 !Bit !Bit !Bit !Bit !Bit

Instances

Show Bit5
Generic Bit5
Variable Bit5
Codec Bit5
Boolean Bit5
Equatable Bit5
Orderable Bit5
HasBits Bit5
Typeable * Bit5
type Rep Bit5
type Decoded Bit5 = Word8

data Bit6 Source

A container of 6 Bits that encodes from and decodes to Word8

Constructors

Bit6 !Bit !Bit !Bit !Bit !Bit !Bit

Instances

Show Bit6
Generic Bit6
Variable Bit6
Codec Bit6
Boolean Bit6
Equatable Bit6
Orderable Bit6
HasBits Bit6
Typeable * Bit6
type Rep Bit6
type Decoded Bit6 = Word8

data Bit7 Source

A container of 7 Bits that encodes from and decodes to Word8

Constructors

Bit7 !Bit !Bit !Bit !Bit !Bit !Bit !Bit

Instances

Show Bit7
Generic Bit7
Variable Bit7
Codec Bit7
Boolean Bit7
Equatable Bit7
Orderable Bit7
HasBits Bit7
Typeable * Bit7
type Rep Bit7
type Decoded Bit7 = Word8

data Bit8 Source

A container of 8 Bits that encodes from and decodes to Word8

Constructors

Bit8 !Bit !Bit !Bit !Bit !Bit !Bit !Bit !Bit

Instances

Show Bit8
Generic Bit8
Variable Bit8
Codec Bit8
Boolean Bit8
Equatable Bit8
Orderable Bit8
HasBits Bit8
Typeable * Bit8
type Rep Bit8
type Decoded Bit8 = Word8

Variable length bit vectors

newtype Bits Source

Constructors

Bits [Bit]

Instances

Num Bits
Show Bits
Codec Bits
Equatable Bits
Orderable Bits
HasBits Bits
Typeable * Bits
type Decoded Bits = Integer

class HasBits a where Source

HasBits provides the bits method for embedding fixed with numeric encoding types into the arbitrary width Bits type.

Methods

bits :: a -> Bits Source

Instances

HasBits Bit
HasBits Bits
HasBits Bit8
HasBits Bit7
HasBits Bit6
HasBits Bit5
HasBits Bit4
HasBits Bit3
HasBits Bit2
HasBits Bit1

isEven :: HasBits b => b -> Bit Source

Predicate for even-valued Bitss.

isOdd :: HasBits b => b -> Bit Source

Predicate for odd-valued Bitss.

sumBit :: Foldable t => t Bit -> Bits Source

Optimization of sumBits enabled when summing individual Bits.

sumBits :: (Foldable t, HasBits a) => t a -> Bits Source

Compute the sum of a source of Bits values.

Adders

fullAdder Source

Arguments

:: Bit
-> Bit
-> Bit
-> (Bit, Bit)	(sum, carry)

Compute the sum and carry bit from adding three bits.

halfAdder Source

Arguments

:: Bit
-> Bit
-> (Bit, Bit)	(sum, carry)

Compute the sum and carry bit from adding two bits.