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	DataKinds MagicHash TypeOperators ExplicitNamespaces

Clash.Sized.Index

Description

Synopsis

data Index (n :: Nat)
bv2i :: KnownNat n => BitVector n -> Index (2 ^ n)

Documentation

data Index (n :: Nat) Source #

Arbitrary-bounded unsigned integer represented by ceil(log_2(n)) bits.

Given an upper bound n, an Index n number has a range of: [0 .. n-1]

>>> maxBound :: Index 8
7
>>> minBound :: Index 8
0
>>> read (show (maxBound :: Index 8)) :: Index 8
7
>>> 1 + 2 :: Index 8
3
>>> 2 + 6 :: Index 8
*** Exception: Clash.Sized.Index: result 8 is out of bounds: [0..7]
...
>>> 1 - 3 :: Index 8
*** Exception: Clash.Sized.Index: result -2 is out of bounds: [0..7]
...
>>> 2 * 3 :: Index 8
6
>>> 2 * 4 :: Index 8
*** Exception: Clash.Sized.Index: result 8 is out of bounds: [0..7]
...

Instances

Resize Index Source #
Instance details Methods resize :: (KnownNat a, KnownNat b) => Index a -> Index b Source # extend :: (KnownNat a, KnownNat b) => Index a -> Index (b + a) Source # zeroExtend :: (KnownNat a, KnownNat b) => Index a -> Index (b + a) Source # signExtend :: (KnownNat a, KnownNat b) => Index a -> Index (b + a) Source # truncateB :: KnownNat a => Index (a + b) -> Index a Source #
KnownNat n => Bounded (Index n) Source #
Instance details Methods minBound :: Index n # maxBound :: Index n #
KnownNat n => Enum (Index n) Source #	The functions: `enumFrom`, `enumFromThen`, `enumFromTo`, and `enumFromThenTo`, are not synthesisable.
Instance details Methods succ :: Index n -> Index n # pred :: Index n -> Index n # toEnum :: Int -> Index n # fromEnum :: Index n -> Int # enumFrom :: Index n -> [Index n] # enumFromThen :: Index n -> Index n -> [Index n] # enumFromTo :: Index n -> Index n -> [Index n] # enumFromThenTo :: Index n -> Index n -> Index n -> [Index n] #
Eq (Index n) Source #
Instance details Methods (==) :: Index n -> Index n -> Bool # (/=) :: Index n -> Index n -> Bool #
KnownNat n => Integral (Index n) Source #
Instance details Methods quot :: Index n -> Index n -> Index n # rem :: Index n -> Index n -> Index n # div :: Index n -> Index n -> Index n # mod :: Index n -> Index n -> Index n # quotRem :: Index n -> Index n -> (Index n, Index n) # divMod :: Index n -> Index n -> (Index n, Index n) # toInteger :: Index n -> Integer #
KnownNat n => Data (Index n) Source #
Instance details Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Index n -> c (Index n) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Index n) # toConstr :: Index n -> Constr # dataTypeOf :: Index n -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Index n)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Index n)) # gmapT :: (forall b. Data b => b -> b) -> Index n -> Index n # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Index n -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Index n -> r # gmapQ :: (forall d. Data d => d -> u) -> Index n -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Index n -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Index n -> m (Index n) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Index n -> m (Index n) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Index n -> m (Index n) #
KnownNat n => Num (Index n) Source #	Operators report an error on overflow and underflow
Instance details Methods (+) :: Index n -> Index n -> Index n # (-) :: Index n -> Index n -> Index n # (*) :: Index n -> Index n -> Index n # negate :: Index n -> Index n # abs :: Index n -> Index n # signum :: Index n -> Index n # fromInteger :: Integer -> Index n #
Ord (Index n) Source #
Instance details Methods compare :: Index n -> Index n -> Ordering # (<) :: Index n -> Index n -> Bool # (<=) :: Index n -> Index n -> Bool # (>) :: Index n -> Index n -> Bool # (>=) :: Index n -> Index n -> Bool # max :: Index n -> Index n -> Index n # min :: Index n -> Index n -> Index n #
KnownNat n => Read (Index n) Source #	None of the `Read` class' methods are synthesisable.
Instance details Methods readsPrec :: Int -> ReadS (Index n) # readList :: ReadS [Index n] # readPrec :: ReadPrec (Index n) # readListPrec :: ReadPrec [Index n] #
KnownNat n => Real (Index n) Source #
Instance details Methods toRational :: Index n -> Rational #
Show (Index n) Source #
Instance details Methods showsPrec :: Int -> Index n -> ShowS # show :: Index n -> String # showList :: [Index n] -> ShowS #
KnownNat n => Lift (Index n) Source #
Instance details Methods lift :: Index n -> Q Exp #
KnownNat n => Arbitrary (Index n) Source #
Instance details Methods arbitrary :: Gen (Index n) # shrink :: Index n -> [Index n] #
KnownNat n => CoArbitrary (Index n) Source #
Instance details Methods coarbitrary :: Index n -> Gen b -> Gen b #
KnownNat n => Default (Index n) Source #
Instance details Methods def :: Index n #
NFData (Index n) Source #
Instance details Methods rnf :: Index n -> () #
(KnownNat n, 1 <= n) => SaturatingNum (Index n) Source #
Instance details Methods satPlus :: SaturationMode -> Index n -> Index n -> Index n Source # satMin :: SaturationMode -> Index n -> Index n -> Index n Source # satMult :: SaturationMode -> Index n -> Index n -> Index n Source #
ShowX (Index n) Source #
Instance details Methods showsPrecX :: Int -> Index n -> ShowS Source # showX :: Index n -> String Source # showListX :: [Index n] -> ShowS Source #
KnownNat n => BitPack (Index n) Source #
Instance details Associated Types type BitSize (Index n) :: Nat Source # Methods pack :: Index n -> BitVector (BitSize (Index n)) Source # unpack :: BitVector (BitSize (Index n)) -> Index n Source #
Bundle (Index n) Source #
Instance details Associated Types type Unbundled domain (Index n) = (res :: *) Source # Methods bundle :: Unbundled domain (Index n) -> Signal domain (Index n) Source # unbundle :: Signal domain (Index n) -> Unbundled domain (Index n) Source #
ExtendingNum (Index m) (Index n) Source #
Instance details Associated Types type AResult (Index m) (Index n) :: * Source # type MResult (Index m) (Index n) :: * Source # Methods plus :: Index m -> Index n -> AResult (Index m) (Index n) Source # minus :: Index m -> Index n -> AResult (Index m) (Index n) Source # times :: Index m -> Index n -> MResult (Index m) (Index n) Source #
type Unbundled domain (Index n) Source #
Instance details type Unbundled domain (Index n) = Signal domain (Index n)
type BitSize (Index n) Source #
Instance details type BitSize (Index n) = CLog 2 n
type AResult (Index m) (Index n) Source #
Instance details type AResult (Index m) (Index n) = Index ((m + n) - 1)
type MResult (Index m) (Index n) Source #
Instance details type MResult (Index m) (Index n) = Index (((m - 1) * (n - 1)) + 1)

bv2i :: KnownNat n => BitVector n -> Index (2 ^ n) Source #

An alternative implementation of unpack for the Index data type; for when you know the size of the BitVector and want to determine the size of the Index.

That is, the type of unpack is:

unpack :: BitVector (CLog 2 n) -> Index n

And is useful when you know the size of the Index, and want to get a value from a BitVector that is large enough (CLog 2 n) enough to hold an Index. Note that unpack can fail at run-time when the value inside the BitVector is higher than 'n-1'.

bv2i on the other hand will never fail at run-time, because the BitVector argument determines the size.