Clash.Sized.Internal.Unsigned

Datatypes

newtype Unsigned (n :: Nat)

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

Unsigned has the type role

>>> :i Unsigned
type role Unsigned nominal
...

as it is not safe to coerce between different width Unsigned. To change the width, use the functions in the Resize class.

Constructors

U

The constructor, U, and the field, unsafeToNatural, are not synthesizable.

Fields

• unsafeToNatural :: Natural

Instances

Resize Unsigned

Defined in Clash.Sized.Internal.Unsigned

Methods

resize :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Unsigned a -> Unsigned b

extend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Unsigned a -> Unsigned (b + a)

zeroExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Unsigned a -> Unsigned (b + a)

signExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Unsigned a -> Unsigned (b + a)

truncateB :: forall (a :: Nat) (b :: Nat). KnownNat a => Unsigned (a + b) -> Unsigned a

KnownNat n => Lift (Unsigned n :: Type)

Defined in Clash.Sized.Internal.Unsigned

Methods

lift :: Unsigned n -> Q Exp

liftTyped :: Unsigned n -> Q (TExp (Unsigned n))

KnownNat n => Bounded (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

minBound :: Unsigned n

maxBound :: Unsigned n

KnownNat n => Enum (Unsigned n)

The functions: enumFrom, enumFromThen, enumFromTo, and enumFromThenTo, are not synthesizable.

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)

Defined in Clash.Sized.Internal.Unsigned

Methods

(==) :: Unsigned n -> Unsigned n -> Bool

(/=) :: Unsigned n -> Unsigned n -> Bool

KnownNat n => Integral (Unsigned n)

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)

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)

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)

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)

None of the Read class' methods are synthesizable.

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)

Defined in Clash.Sized.Internal.Unsigned

Methods

toRational :: Unsigned n -> Rational

Show (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

showsPrec :: Int -> Unsigned n -> ShowS

show :: Unsigned n -> String

showList :: [Unsigned n] -> ShowS

KnownNat n => Ix (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

range :: (Unsigned n, Unsigned n) -> [Unsigned n]

index :: (Unsigned n, Unsigned n) -> Unsigned n -> Int

unsafeIndex :: (Unsigned n, Unsigned n) -> Unsigned n -> Int

inRange :: (Unsigned n, Unsigned n) -> Unsigned n -> Bool

rangeSize :: (Unsigned n, Unsigned n) -> Int

unsafeRangeSize :: (Unsigned n, Unsigned n) -> Int

Generic (Unsigned n)

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 => Arbitrary (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

arbitrary :: Gen (Unsigned n)

shrink :: Unsigned n -> [Unsigned n]

KnownNat n => CoArbitrary (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

coarbitrary :: Unsigned n -> Gen b -> Gen b

KnownNat n => PrintfArg (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

formatArg :: Unsigned n -> FieldFormatter

parseFormat :: Unsigned n -> ModifierParser

KnownNat n => Bits (Unsigned n)

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)

Defined in Clash.Sized.Internal.Unsigned

Methods

finiteBitSize :: Unsigned n -> Int

countLeadingZeros :: Unsigned n -> Int

countTrailingZeros :: Unsigned n -> Int

Default (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

def :: Unsigned n

NFData (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

rnf :: Unsigned n -> ()

KnownNat n => Ixed (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

ix :: Index (Unsigned n) -> Traversal' (Unsigned n) (IxValue (Unsigned n))

KnownNat n => SaturatingNum (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

satAdd :: SaturationMode -> Unsigned n -> Unsigned n -> Unsigned n

satSub :: SaturationMode -> Unsigned n -> Unsigned n -> Unsigned n

satMul :: SaturationMode -> Unsigned n -> Unsigned n -> Unsigned n

satSucc :: SaturationMode -> Unsigned n -> Unsigned n

satPred :: SaturationMode -> Unsigned n -> Unsigned n

NFDataX (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

deepErrorX :: String -> Unsigned n

hasUndefined :: Unsigned n -> Bool

ensureSpine :: Unsigned n -> Unsigned n

rnfX :: Unsigned n -> ()

ShowX (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

showsPrecX :: Int -> Unsigned n -> ShowS

showX :: Unsigned n -> String

showListX :: [Unsigned n] -> ShowS

KnownNat n => BitPack (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Associated Types

type BitSize (Unsigned n) :: Nat

Methods

pack :: Unsigned n -> BitVector (BitSize (Unsigned n))

unpack :: BitVector (BitSize (Unsigned n)) -> Unsigned n

KnownNat n => Parity (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

even :: Unsigned n -> Bool

odd :: Unsigned n -> Bool

Bundle (Unsigned n)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled dom (Unsigned n) = (res :: Type)

Methods

bundle :: forall (dom :: Domain). Unbundled dom (Unsigned n) -> Signal dom (Unsigned n)

unbundle :: forall (dom :: Domain). Signal dom (Unsigned n) -> Unbundled dom (Unsigned n)

Bundle (Unsigned n)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (Unsigned n) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (Unsigned n) -> DSignal dom d (Unsigned n)

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (Unsigned n) -> Unbundled dom d (Unsigned n)

AutoReg (Unsigned n)

Defined in Clash.Class.AutoReg.Internal

Methods

autoReg :: forall (dom :: Domain). (HasCallStack, KnownDomain dom) => Clock dom -> Reset dom -> Enable dom -> Unsigned n -> Signal dom (Unsigned n) -> Signal dom (Unsigned n)

KnownNat m => Exp (Unsigned m)

Defined in Clash.Class.Exp

Associated Types

type ExpResult (Unsigned m) n

Methods

(^) :: forall (n :: Nat). Unsigned m -> SNat n -> ExpResult (Unsigned m) n

(KnownNat m, KnownNat n) => ExtendingNum (Unsigned m) (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Associated Types

type AResult (Unsigned m) (Unsigned n)

type MResult (Unsigned m) (Unsigned n)

Methods

add :: Unsigned m -> Unsigned n -> AResult (Unsigned m) (Unsigned n)

sub :: Unsigned m -> Unsigned n -> AResult (Unsigned m) (Unsigned n)

mul :: Unsigned m -> Unsigned n -> MResult (Unsigned m) (Unsigned n)

type Unbundled dom d (Unsigned n)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d (Unsigned n) = DSignal dom d (Unsigned n)

type Unbundled dom (Unsigned n)

Defined in Clash.Signal.Bundle

type Unbundled dom (Unsigned n) = Signal dom (Unsigned n)

type Rep (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

type Rep (Unsigned n) = D1 ('MetaData "Unsigned" "Clash.Sized.Internal.Unsigned" "clash-prelude-1.3.0-inplace" 'True) (C1 ('MetaCons "U" 'PrefixI 'True) (S1 ('MetaSel ('Just "unsafeToNatural") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

type Index (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

type Index (Unsigned n) = Int

type IxValue (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

type IxValue (Unsigned n) = Bit

type BitSize (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

type BitSize (Unsigned n) = n

type ExpResult (Unsigned m) n

Defined in Clash.Class.Exp

type ExpResult (Unsigned m) n = Unsigned (Max 1 (m * n))

type AResult (Unsigned m) (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

type AResult (Unsigned m) (Unsigned n) = Unsigned (Max m n + 1)

type MResult (Unsigned m) (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

type MResult (Unsigned m) (Unsigned n) = Unsigned (m + n)

Accessors

Length information

size# :: KnownNat n => Unsigned n -> Int

Type classes

BitPack

pack# :: Unsigned n -> BitVector n

unpack# :: KnownNat n => BitVector n -> Unsigned n

Eq

eq# :: Unsigned n -> Unsigned n -> Bool

neq# :: Unsigned n -> Unsigned n -> Bool

Ord

lt# :: Unsigned n -> Unsigned n -> Bool

ge# :: Unsigned n -> Unsigned n -> Bool

gt# :: Unsigned n -> Unsigned n -> Bool

le# :: Unsigned n -> Unsigned n -> Bool

Enum (not synthesizable)

enumFrom# :: forall n. KnownNat n => Unsigned n -> [Unsigned n]

enumFromThen# :: forall n. KnownNat n => Unsigned n -> Unsigned n -> [Unsigned n]

enumFromTo# :: forall n. KnownNat n => Unsigned n -> Unsigned n -> [Unsigned n]

enumFromThenTo# :: forall n. KnownNat n => Unsigned n -> Unsigned n -> Unsigned n -> [Unsigned n]

Bounded

minBound# :: Unsigned n

maxBound# :: forall n. KnownNat n => Unsigned n

Num

(+#) :: 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# :: forall n. KnownNat n => Integer -> Unsigned n

ExtendingNum

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)

Integral

quot# :: Unsigned n -> Unsigned n -> Unsigned n

rem# :: Unsigned n -> Unsigned n -> Unsigned n

toInteger# :: Unsigned n -> Integer

Bits

and# :: Unsigned n -> Unsigned n -> Unsigned n

or# :: Unsigned n -> Unsigned n -> Unsigned n

xor# :: Unsigned n -> Unsigned n -> Unsigned n

complement# :: forall n. KnownNat n => Unsigned n -> Unsigned n

shiftL# :: forall n. KnownNat n => Unsigned n -> Int -> Unsigned n

shiftR# :: forall n. KnownNat n => Unsigned n -> Int -> Unsigned n

rotateL# :: forall n. KnownNat n => Unsigned n -> Int -> Unsigned n

rotateR# :: forall n. KnownNat n => Unsigned n -> Int -> Unsigned n

Resize

resize# :: forall n m. KnownNat m => Unsigned n -> Unsigned m

Conversions

unsignedToWord :: Unsigned 64 -> Word

unsigned8toWord8 :: Unsigned 8 -> Word8

unsigned16toWord16 :: Unsigned 16 -> Word16

unsigned32toWord32 :: Unsigned 32 -> Word32