Copyright	(C) 2013-2016 University of Twente
License	BSD2 (see the file LICENSE)
Maintainer	Christiaan Baaij <christiaan.baaij@gmail.com>
Safe Haskell	Trustworthy
Language	Haskell2010
Extensions	MagicHash

Clash.Sized.BitVector

Contents

Bit
- Construction
  - Initialisation
BitVector

Description

Synopsis

data Bit
high :: Bit
low :: Bit
data BitVector (n :: Nat)
size# :: KnownNat n => BitVector n -> Int
maxIndex# :: KnownNat n => BitVector n -> Int
bLit :: KnownNat n => String -> Q (TExp (BitVector n))
(++#) :: KnownNat m => BitVector n -> BitVector m -> BitVector (n + m)

Bit

data Bit Source #

Bit

Instances

Bounded Bit Source #
Instance details Methods minBound :: Bit # maxBound :: Bit #
Enum Bit Source #
Instance details Methods succ :: Bit -> Bit # pred :: Bit -> Bit # toEnum :: Int -> Bit # fromEnum :: Bit -> Int # enumFrom :: Bit -> [Bit] # enumFromThen :: Bit -> Bit -> [Bit] # enumFromTo :: Bit -> Bit -> [Bit] # enumFromThenTo :: Bit -> Bit -> Bit -> [Bit] #
Eq Bit Source #
Instance details Methods (==) :: Bit -> Bit -> Bool # (/=) :: Bit -> Bit -> Bool #
Integral Bit Source #
Instance details Methods quot :: Bit -> Bit -> Bit # rem :: Bit -> Bit -> Bit # div :: Bit -> Bit -> Bit # mod :: Bit -> Bit -> Bit # quotRem :: Bit -> Bit -> (Bit, Bit) # divMod :: Bit -> Bit -> (Bit, Bit) # toInteger :: Bit -> Integer #
Data Bit Source #
Instance details Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Bit -> c Bit # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Bit # toConstr :: Bit -> Constr # dataTypeOf :: Bit -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Bit) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Bit) # gmapT :: (forall b. Data b => b -> b) -> Bit -> Bit # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Bit -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Bit -> r # gmapQ :: (forall d. Data d => d -> u) -> Bit -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Bit -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Bit -> m Bit # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Bit -> m Bit # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Bit -> m Bit #
Num Bit Source #
Instance details Methods (+) :: Bit -> Bit -> Bit # (-) :: Bit -> Bit -> Bit # (*) :: Bit -> Bit -> Bit # negate :: Bit -> Bit # abs :: Bit -> Bit # signum :: Bit -> Bit # fromInteger :: Integer -> Bit #
Ord Bit Source #
Instance details Methods compare :: Bit -> Bit -> Ordering # (<) :: Bit -> Bit -> Bool # (<=) :: Bit -> Bit -> Bool # (>) :: Bit -> Bit -> Bool # (>=) :: Bit -> Bit -> Bool # max :: Bit -> Bit -> Bit # min :: Bit -> Bit -> Bit #
Real Bit Source #
Instance details Methods toRational :: Bit -> Rational #
Show Bit Source #
Instance details Methods showsPrec :: Int -> Bit -> ShowS # show :: Bit -> String # showList :: [Bit] -> ShowS #
Lift Bit Source #
Instance details Methods lift :: Bit -> Q Exp #
Bits Bit Source #
Instance details Methods (.&.) :: Bit -> Bit -> Bit # (.\|.) :: Bit -> Bit -> Bit # xor :: Bit -> Bit -> Bit # complement :: Bit -> Bit # shift :: Bit -> Int -> Bit # rotate :: Bit -> Int -> Bit # zeroBits :: Bit # bit :: Int -> Bit # setBit :: Bit -> Int -> Bit # clearBit :: Bit -> Int -> Bit # complementBit :: Bit -> Int -> Bit # testBit :: Bit -> Int -> Bool # bitSizeMaybe :: Bit -> Maybe Int # bitSize :: Bit -> Int # isSigned :: Bit -> Bool # shiftL :: Bit -> Int -> Bit # unsafeShiftL :: Bit -> Int -> Bit # shiftR :: Bit -> Int -> Bit # unsafeShiftR :: Bit -> Int -> Bit # rotateL :: Bit -> Int -> Bit # rotateR :: Bit -> Int -> Bit # popCount :: Bit -> Int #
FiniteBits Bit Source #
Instance details Methods finiteBitSize :: Bit -> Int # countLeadingZeros :: Bit -> Int # countTrailingZeros :: Bit -> Int #
NFData Bit Source #
Instance details Methods rnf :: Bit -> () #
ShowX Bit Source #
Instance details Methods showsPrecX :: Int -> Bit -> ShowS Source # showX :: Bit -> String Source # showListX :: [Bit] -> ShowS Source #
Default Bit Source #
Instance details Methods def :: Bit
BitPack Bit Source #
Instance details Associated Types type BitSize Bit :: Nat Source # Methods pack :: Bit -> BitVector (BitSize Bit) Source # unpack :: BitVector (BitSize Bit) -> Bit Source #
Bundle Bit Source #
Instance details Associated Types type Unbundled domain Bit = (res :: *) Source # Methods bundle :: Unbundled domain Bit -> Signal domain Bit Source # unbundle :: Signal domain Bit -> Unbundled domain Bit Source #
type BitSize Bit Source #
Instance details type BitSize Bit = 1
type Unbundled domain Bit Source #
Instance details type Unbundled domain Bit = Signal domain Bit

Construction

Initialisation

high :: Bit Source #

logic '1'

low :: Bit Source #

logic '0'

BitVector

data BitVector (n :: Nat) Source #

A vector of bits.

Bit indices are descending
Num instance performs unsigned arithmetic.

Instances

Resize BitVector Source #
Instance details Methods resize :: (KnownNat a, KnownNat b) => BitVector a -> BitVector b Source # extend :: (KnownNat a, KnownNat b) => BitVector a -> BitVector (b + a) Source # zeroExtend :: (KnownNat a, KnownNat b) => BitVector a -> BitVector (b + a) Source # signExtend :: (KnownNat a, KnownNat b) => BitVector a -> BitVector (b + a) Source # truncateB :: KnownNat a => BitVector (a + b) -> BitVector a Source #
KnownNat n => Bounded (BitVector n) Source #
Instance details Methods minBound :: BitVector n # maxBound :: BitVector n #
KnownNat n => Enum (BitVector n) Source #	The functions: `enumFrom`, `enumFromThen`, `enumFromTo`, and `enumFromThenTo`, are not synthesisable.
Instance details Methods succ :: BitVector n -> BitVector n # pred :: BitVector n -> BitVector n # toEnum :: Int -> BitVector n # fromEnum :: BitVector n -> Int # enumFrom :: BitVector n -> [BitVector n] # enumFromThen :: BitVector n -> BitVector n -> [BitVector n] # enumFromTo :: BitVector n -> BitVector n -> [BitVector n] # enumFromThenTo :: BitVector n -> BitVector n -> BitVector n -> [BitVector n] #
Eq (BitVector n) Source #
Instance details Methods (==) :: BitVector n -> BitVector n -> Bool # (/=) :: BitVector n -> BitVector n -> Bool #
KnownNat n => Integral (BitVector n) Source #
Instance details Methods quot :: BitVector n -> BitVector n -> BitVector n # rem :: BitVector n -> BitVector n -> BitVector n # div :: BitVector n -> BitVector n -> BitVector n # mod :: BitVector n -> BitVector n -> BitVector n # quotRem :: BitVector n -> BitVector n -> (BitVector n, BitVector n) # divMod :: BitVector n -> BitVector n -> (BitVector n, BitVector n) # toInteger :: BitVector n -> Integer #
KnownNat n => Data (BitVector n) Source #
Instance details Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BitVector n -> c (BitVector n) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (BitVector n) # toConstr :: BitVector n -> Constr # dataTypeOf :: BitVector n -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (BitVector n)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (BitVector n)) # gmapT :: (forall b. Data b => b -> b) -> BitVector n -> BitVector n # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BitVector n -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BitVector n -> r # gmapQ :: (forall d. Data d => d -> u) -> BitVector n -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> BitVector n -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> BitVector n -> m (BitVector n) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BitVector n -> m (BitVector n) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BitVector n -> m (BitVector n) #
KnownNat n => Num (BitVector n) Source #
Instance details Methods (+) :: BitVector n -> BitVector n -> BitVector n # (-) :: BitVector n -> BitVector n -> BitVector n # (*) :: BitVector n -> BitVector n -> BitVector n # negate :: BitVector n -> BitVector n # abs :: BitVector n -> BitVector n # signum :: BitVector n -> BitVector n # fromInteger :: Integer -> BitVector n #
Ord (BitVector n) Source #
Instance details Methods compare :: BitVector n -> BitVector n -> Ordering # (<) :: BitVector n -> BitVector n -> Bool # (<=) :: BitVector n -> BitVector n -> Bool # (>) :: BitVector n -> BitVector n -> Bool # (>=) :: BitVector n -> BitVector n -> Bool # max :: BitVector n -> BitVector n -> BitVector n # min :: BitVector n -> BitVector n -> BitVector n #
KnownNat n => Real (BitVector n) Source #
Instance details Methods toRational :: BitVector n -> Rational #
KnownNat n => Show (BitVector n) Source #
Instance details Methods showsPrec :: Int -> BitVector n -> ShowS # show :: BitVector n -> String # showList :: [BitVector n] -> ShowS #
KnownNat n => Lift (BitVector n) Source #
Instance details Methods lift :: BitVector n -> Q Exp #
KnownNat n => Bits (BitVector n) Source #
Instance details Methods (.&.) :: BitVector n -> BitVector n -> BitVector n # (.\|.) :: BitVector n -> BitVector n -> BitVector n # xor :: BitVector n -> BitVector n -> BitVector n # complement :: BitVector n -> BitVector n # shift :: BitVector n -> Int -> BitVector n # rotate :: BitVector n -> Int -> BitVector n # zeroBits :: BitVector n # bit :: Int -> BitVector n # setBit :: BitVector n -> Int -> BitVector n # clearBit :: BitVector n -> Int -> BitVector n # complementBit :: BitVector n -> Int -> BitVector n # testBit :: BitVector n -> Int -> Bool # bitSizeMaybe :: BitVector n -> Maybe Int # bitSize :: BitVector n -> Int # isSigned :: BitVector n -> Bool # shiftL :: BitVector n -> Int -> BitVector n # unsafeShiftL :: BitVector n -> Int -> BitVector n # shiftR :: BitVector n -> Int -> BitVector n # unsafeShiftR :: BitVector n -> Int -> BitVector n # rotateL :: BitVector n -> Int -> BitVector n # rotateR :: BitVector n -> Int -> BitVector n # popCount :: BitVector n -> Int #
KnownNat n => FiniteBits (BitVector n) Source #
Instance details Methods finiteBitSize :: BitVector n -> Int # countLeadingZeros :: BitVector n -> Int # countTrailingZeros :: BitVector n -> Int #
NFData (BitVector n) Source #
Instance details Methods rnf :: BitVector n -> () #
KnownNat n => SaturatingNum (BitVector n) Source #
Instance details Methods satPlus :: SaturationMode -> BitVector n -> BitVector n -> BitVector n Source # satMin :: SaturationMode -> BitVector n -> BitVector n -> BitVector n Source # satMult :: SaturationMode -> BitVector n -> BitVector n -> BitVector n Source #
KnownNat n => ShowX (BitVector n) Source #
Instance details Methods showsPrecX :: Int -> BitVector n -> ShowS Source # showX :: BitVector n -> String Source # showListX :: [BitVector n] -> ShowS Source #
KnownNat n => Ixed (BitVector n) Source #
Instance details Methods ix :: Index (BitVector n) -> Traversal' (BitVector n) (IxValue (BitVector n))
Default (BitVector n) Source #
Instance details Methods def :: BitVector n
KnownNat n => Arbitrary (BitVector n) Source #
Instance details Methods arbitrary :: Gen (BitVector n) shrink :: BitVector n -> [BitVector n]
KnownNat n => CoArbitrary (BitVector n) Source #
Instance details Methods coarbitrary :: BitVector n -> Gen b -> Gen b
BitPack (BitVector n) Source #
Instance details Associated Types type BitSize (BitVector n) :: Nat Source # Methods pack :: BitVector n -> BitVector (BitSize (BitVector n)) Source # unpack :: BitVector (BitSize (BitVector n)) -> BitVector n Source #
Bundle (BitVector n) Source #
Instance details Associated Types type Unbundled domain (BitVector n) = (res :: *) Source # Methods bundle :: Unbundled domain (BitVector n) -> Signal domain (BitVector n) Source # unbundle :: Signal domain (BitVector n) -> Unbundled domain (BitVector n) Source #
(KnownNat m, KnownNat n) => ExtendingNum (BitVector m) (BitVector n) Source #
Instance details Associated Types type AResult (BitVector m) (BitVector n) :: * Source # type MResult (BitVector m) (BitVector n) :: * Source # Methods plus :: BitVector m -> BitVector n -> AResult (BitVector m) (BitVector n) Source # minus :: BitVector m -> BitVector n -> AResult (BitVector m) (BitVector n) Source # times :: BitVector m -> BitVector n -> MResult (BitVector m) (BitVector n) Source #
type Unbundled domain (BitVector n) Source #
Instance details type Unbundled domain (BitVector n) = Signal domain (BitVector n)
type Index (BitVector n) Source #
Instance details type Index (BitVector n) = Int
type IxValue (BitVector n) Source #
Instance details type IxValue (BitVector n) = Bit
type BitSize (BitVector n) Source #
Instance details type BitSize (BitVector n) = n
type AResult (BitVector m) (BitVector n) Source #
Instance details type AResult (BitVector m) (BitVector n) = BitVector (Max m n + 1)
type MResult (BitVector m) (BitVector n) Source #
Instance details type MResult (BitVector m) (BitVector n) = BitVector (m + n)

Accessors

Length information

size# :: KnownNat n => BitVector n -> Int Source #

maxIndex# :: KnownNat n => BitVector n -> Int Source #

Construction

bLit :: KnownNat n => String -> Q (TExp (BitVector n)) Source #

Create a binary literal

>>> $$(bLit "1001") :: BitVector 4
1001
>>> $$(bLit "1001") :: BitVector 3
001

NB: You can also just write:

>>> 0b1001 :: BitVector 4
1001

The advantage of bLit is that you can use computations to create the string literal:

>>> import qualified Data.List as List
>>> $$(bLit (List.replicate 4 '1')) :: BitVector 4
1111

Concatenation

(++#) :: KnownNat m => BitVector n -> BitVector m -> BitVector (n + m) Source #

Concatenate two BitVectors