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

Clash.Sized.Unsigned

Description

Synopsis

data Unsigned (n :: Nat)

Documentation

data Unsigned (n :: Nat) Source #

Arbitrary-width unsigned integer represented by n bits

Given n bits, an Unsigned n number has a range of: [0 .. 2^n-1]

NB: The Num operators perform wrap-around on overflow. If you want saturation on overflow, check out the SaturatingNum class.

>>> maxBound :: Unsigned 3
7
>>> minBound :: Unsigned 3
0
>>> read (show (maxBound :: Unsigned 3)) :: Unsigned 3
7
>>> 1 + 2 :: Unsigned 3
3
>>> 2 + 6 :: Unsigned 3
0
>>> 1 - 3 :: Unsigned 3
6
>>> 2 * 3 :: Unsigned 3
6
>>> 2 * 4 :: Unsigned 3
0
>>> (2 :: Unsigned 3) `times` (4 :: Unsigned 3) :: Unsigned 6
8
>>> (2 :: Unsigned 3) `plus` (6 :: Unsigned 3) :: Unsigned 4
8
>>> satPlus SatSymmetric 2 6 :: Unsigned 3
7
>>> satMin SatSymmetric 2 3 :: Unsigned 3
0

Instances

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