Copyright	(C) 2013-2016 University of Twente 2016 Myrtle Software Ltd
License	BSD2 (see the file LICENSE)
Maintainer	Christiaan Baaij <christiaan.baaij@gmail.com>
Safe Haskell	Unsafe
Language	Haskell2010
Extensions	UndecidableInstances MonoLocalBinds TemplateHaskell TemplateHaskellQuotes ScopedTypeVariables TypeFamilies DataKinds DeriveDataTypeable DeriveGeneric DeriveAnyClass ConstrainedClassMethods MultiParamTypeClasses MagicHash KindSignatures TypeOperators ExplicitNamespaces ExplicitForAll TypeApplications

Clash.Sized.Internal.Unsigned

Contents

Datatypes
Accessors
- Length information
Type classes

Description

Synopsis

newtype Unsigned (n :: Nat) = U {
- unsafeToInteger :: Integer
}
size# :: KnownNat n => Unsigned n -> Int
pack# :: Unsigned n -> BitVector n
unpack# :: KnownNat n => BitVector n -> Unsigned n
eq# :: Unsigned n -> Unsigned n -> Bool
neq# :: Unsigned n -> Unsigned n -> Bool
lt# :: Unsigned n -> Unsigned n -> Bool
ge# :: Unsigned n -> Unsigned n -> Bool
gt# :: Unsigned n -> Unsigned n -> Bool
le# :: Unsigned n -> Unsigned n -> Bool
enumFrom# :: KnownNat n => Unsigned n -> [Unsigned n]
enumFromThen# :: KnownNat n => Unsigned n -> Unsigned n -> [Unsigned n]
enumFromTo# :: Unsigned n -> Unsigned n -> [Unsigned n]
enumFromThenTo# :: Unsigned n -> Unsigned n -> Unsigned n -> [Unsigned n]
minBound# :: Unsigned n
maxBound# :: forall n. KnownNat n => Unsigned n
(+#) :: forall n. KnownNat n => Unsigned n -> Unsigned n -> Unsigned n
(-#) :: forall n. KnownNat n => Unsigned n -> Unsigned n -> Unsigned n
(*#) :: forall n. KnownNat n => Unsigned n -> Unsigned n -> Unsigned n
negate# :: forall n. KnownNat n => Unsigned n -> Unsigned n
fromInteger# :: KnownNat n => Integer -> Unsigned n
plus# :: Unsigned m -> Unsigned n -> Unsigned (Max m n + 1)
minus# :: forall m n. (KnownNat m, KnownNat n) => Unsigned m -> Unsigned n -> Unsigned (Max m n + 1)
times# :: Unsigned m -> Unsigned n -> Unsigned (m + n)
quot# :: Unsigned n -> Unsigned n -> Unsigned n
rem# :: Unsigned n -> Unsigned n -> Unsigned n
toInteger# :: Unsigned n -> Integer
and# :: Unsigned n -> Unsigned n -> Unsigned n
or# :: Unsigned n -> Unsigned n -> Unsigned n
xor# :: Unsigned n -> Unsigned n -> Unsigned n
complement# :: KnownNat n => Unsigned n -> Unsigned n
shiftL# :: KnownNat n => Unsigned n -> Int -> Unsigned n
shiftR# :: KnownNat n => Unsigned n -> Int -> Unsigned n
rotateL# :: KnownNat n => Unsigned n -> Int -> Unsigned n
rotateR# :: KnownNat n => Unsigned n -> Int -> Unsigned n
resize# :: forall n m. KnownNat m => Unsigned n -> Unsigned m

Datatypes

newtype 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) `mul` (4 :: Unsigned 3) :: Unsigned 6
8
>>> (2 :: Unsigned 3) `add` (6 :: Unsigned 3) :: Unsigned 4
8
>>> satAdd SatSymmetric 2 6 :: Unsigned 3
7
>>> satSub SatSymmetric 2 3 :: Unsigned 3
0

Constructors

U	The constructor, `U`, and the field, `unsafeToInteger`, are not synthesizable.
Fields unsafeToInteger :: Integer

Instances

Instances details

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