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 :: forall n. KnownNat n => String -> Q (TExp (BitVector n))
(++#) :: KnownNat m => BitVector n -> BitVector m -> BitVector (n + m)
bitPattern :: String -> Q Pat

Bit

data Bit Source #

Bit

Instances

Instances details

Bounded Bit Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods minBound :: Bit # maxBound :: Bit #
Enum Bit Source #
Instance details Defined in Clash.Sized.Internal.BitVector 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 Defined in Clash.Sized.Internal.BitVector Methods (==) :: Bit -> Bit -> Bool # (/=) :: Bit -> Bit -> Bool #
Integral Bit Source #
Instance details Defined in Clash.Sized.Internal.BitVector 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 Defined in Clash.Sized.Internal.BitVector 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 :: forall r r'. (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 Defined in Clash.Sized.Internal.BitVector 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 Defined in Clash.Sized.Internal.BitVector 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 Defined in Clash.Sized.Internal.BitVector Methods toRational :: Bit -> Rational #
Show Bit Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods showsPrec :: Int -> Bit -> ShowS # show :: Bit -> String # showList :: [Bit] -> ShowS #
Generic Bit Source #
Instance details Defined in Clash.Sized.Internal.BitVector Associated Types type Rep Bit :: Type -> Type # Methods from :: Bit -> Rep Bit x # to :: Rep Bit x -> Bit #
Lift Bit Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods lift :: Bit -> Q Exp #
Bits Bit Source #
Instance details Defined in Clash.Sized.Internal.BitVector 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 Defined in Clash.Sized.Internal.BitVector Methods finiteBitSize :: Bit -> Int # countLeadingZeros :: Bit -> Int # countTrailingZeros :: Bit -> Int #
Default Bit Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods def :: Bit #
NFData Bit Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods rnf :: Bit -> () #
NFDataX Bit Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods deepErrorX :: String -> Bit Source # rnfX :: Bit -> () Source #
ShowX Bit Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods showsPrecX :: Int -> Bit -> ShowS Source # showX :: Bit -> String Source # showListX :: [Bit] -> ShowS Source #
BitPack Bit Source #
Instance details Defined in Clash.Class.BitPack 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 Defined in Clash.Signal.Bundle Associated Types type Unbundled dom Bit = (res :: Type) Source # Methods bundle :: forall (dom :: Domain). Unbundled dom Bit -> Signal dom Bit Source # unbundle :: forall (dom :: Domain). Signal dom Bit -> Unbundled dom Bit Source #
Bundle Bit Source #
Instance details Defined in Clash.Signal.Delayed.Bundle Associated Types type Unbundled dom d Bit = (res :: Type) Source # Methods bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d Bit -> DSignal dom d Bit Source # unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d Bit -> Unbundled dom d Bit Source #
type Rep Bit Source #
Instance details Defined in Clash.Sized.Internal.BitVector type Rep Bit = D1 ('MetaData "Bit" "Clash.Sized.Internal.BitVector" "clash-prelude-1.0.0-inplace" 'False) (C1 ('MetaCons "Bit" 'PrefixI 'True) (S1 ('MetaSel ('Just "unsafeMask#") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "unsafeToInteger#") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Integer)))
type BitSize Bit Source #
Instance details Defined in Clash.Class.BitPack type BitSize Bit = 1
type Unbundled dom Bit Source #
Instance details Defined in Clash.Signal.Bundle type Unbundled dom Bit = Signal dom Bit
type Unbundled dom d Bit Source #
Instance details Defined in Clash.Signal.Delayed.Bundle type Unbundled dom d Bit = DSignal dom d 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

Instances details

Resize BitVector Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods resize :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => BitVector a -> BitVector b Source # extend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => BitVector a -> BitVector (b + a) Source # zeroExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => BitVector a -> BitVector (b + a) Source # signExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => BitVector a -> BitVector (b + a) Source # truncateB :: forall (a :: Nat) (b :: Nat). KnownNat a => BitVector (a + b) -> BitVector a Source #
KnownNat n => Bounded (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods minBound :: BitVector n # maxBound :: BitVector n #
KnownNat n => Enum (BitVector n) Source #	The functions: `enumFrom`, `enumFromThen`, `enumFromTo`, and `enumFromThenTo`, are not synthesizable.
Instance details Defined in Clash.Sized.Internal.BitVector 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] #
KnownNat n => Eq (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods (==) :: BitVector n -> BitVector n -> Bool # (/=) :: BitVector n -> BitVector n -> Bool #
KnownNat n => Integral (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector 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 Defined in Clash.Sized.Internal.BitVector 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 :: forall r r'. (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 Defined in Clash.Sized.Internal.BitVector 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 #
KnownNat n => Ord (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector 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 Defined in Clash.Sized.Internal.BitVector Methods toRational :: BitVector n -> Rational #
KnownNat n => Show (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods showsPrec :: Int -> BitVector n -> ShowS # show :: BitVector n -> String # showList :: [BitVector n] -> ShowS #
Generic (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Associated Types type Rep (BitVector n) :: Type -> Type # Methods from :: BitVector n -> Rep (BitVector n) x # to :: Rep (BitVector n) x -> BitVector n #
KnownNat n => Lift (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods lift :: BitVector n -> Q Exp #
KnownNat n => Arbitrary (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods arbitrary :: Gen (BitVector n) # shrink :: BitVector n -> [BitVector n] #
KnownNat n => CoArbitrary (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods coarbitrary :: BitVector n -> Gen b -> Gen b #
KnownNat n => Bits (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector 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 Defined in Clash.Sized.Internal.BitVector Methods finiteBitSize :: BitVector n -> Int # countLeadingZeros :: BitVector n -> Int # countTrailingZeros :: BitVector n -> Int #
Default (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods def :: BitVector n #
NFData (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods rnf :: BitVector n -> () #
KnownNat n => Ixed (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods ix :: Index (BitVector n) -> Traversal' (BitVector n) (IxValue (BitVector n)) #
KnownNat n => SaturatingNum (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods satAdd :: SaturationMode -> BitVector n -> BitVector n -> BitVector n Source # satSub :: SaturationMode -> BitVector n -> BitVector n -> BitVector n Source # satMul :: SaturationMode -> BitVector n -> BitVector n -> BitVector n Source #
NFDataX (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods deepErrorX :: String -> BitVector n Source # rnfX :: BitVector n -> () Source #
KnownNat n => ShowX (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Methods showsPrecX :: Int -> BitVector n -> ShowS Source # showX :: BitVector n -> String Source # showListX :: [BitVector n] -> ShowS Source #
KnownNat n => BitPack (BitVector n) Source #
Instance details Defined in Clash.Class.BitPack 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 Defined in Clash.Signal.Bundle Associated Types type Unbundled dom (BitVector n) = (res :: Type) Source # Methods bundle :: forall (dom :: Domain). Unbundled dom (BitVector n) -> Signal dom (BitVector n) Source # unbundle :: forall (dom :: Domain). Signal dom (BitVector n) -> Unbundled dom (BitVector n) Source #
Bundle (BitVector n) Source #
Instance details Defined in Clash.Signal.Delayed.Bundle Associated Types type Unbundled dom d (BitVector n) = (res :: Type) Source # Methods bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (BitVector n) -> DSignal dom d (BitVector n) Source # unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (BitVector n) -> Unbundled dom d (BitVector n) Source #
(KnownNat m, KnownNat n) => ExtendingNum (BitVector m) (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector Associated Types type AResult (BitVector m) (BitVector n) Source # type MResult (BitVector m) (BitVector n) Source # Methods add :: BitVector m -> BitVector n -> AResult (BitVector m) (BitVector n) Source # sub :: BitVector m -> BitVector n -> AResult (BitVector m) (BitVector n) Source # mul :: BitVector m -> BitVector n -> MResult (BitVector m) (BitVector n) Source #
type Unbundled dom d (BitVector n) Source #
Instance details Defined in Clash.Signal.Delayed.Bundle type Unbundled dom d (BitVector n) = DSignal dom d (BitVector n)
type Unbundled dom (BitVector n) Source #
Instance details Defined in Clash.Signal.Bundle type Unbundled dom (BitVector n) = Signal dom (BitVector n)
type Rep (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector type Rep (BitVector n) = D1 ('MetaData "BitVector" "Clash.Sized.Internal.BitVector" "clash-prelude-1.0.0-inplace" 'False) (C1 ('MetaCons "BV" 'PrefixI 'True) (S1 ('MetaSel ('Just "unsafeMask") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "unsafeToInteger") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Integer)))
type Index (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector type Index (BitVector n) = Int
type IxValue (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector type IxValue (BitVector n) = Bit
type BitSize (BitVector n) Source #
Instance details Defined in Clash.Class.BitPack type BitSize (BitVector n) = n
type AResult (BitVector m) (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector type AResult (BitVector m) (BitVector n) = BitVector (Max m n + 1)
type MResult (BitVector m) (BitVector n) Source #
Instance details Defined in Clash.Sized.Internal.BitVector 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 :: forall n. 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

Also bLit can handle don't care bits:

>>> $$(bLit "1.0.") :: BitVector 4
1.0.

Concatenation

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

Concatenate two BitVectors

Pattern matching

bitPattern :: String -> Q Pat Source #

Template Haskell macro for generating a pattern matching on some bits of a value.

This macro compiles to an efficient view pattern that matches the bits of a given value against the bits specified in the pattern. The scrutinee can be any type that is an instance of the Num, Bits and Eq typeclasses.

The bit pattern is specified by a string which contains '0' or '1' for matching a bit, or '.' for bits which are not matched.

The following example matches a byte against two bit patterns where some bits are relevant and others are not:

  decode :: Unsigned 8 -> Maybe Bool
  decode $(bitPattern "00...110") = Just True
  decode $(bitPattern "10..0001") = Just False
  decode _ = Nothing