CLaSH.Sized.Internal.Unsigned

Datatypes

newtype Unsigned n

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

Constructors

U

The constructor, U, and the field, unsafeToInteger, are not synthesisable.

Fields

unsafeToInteger :: Integer

Instances

Resize Unsigned

KnownNat n => Bounded (Unsigned n)

KnownNat n => Enum (Unsigned n)

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

Eq (Unsigned n)

KnownNat n => Integral (Unsigned n)

Typeable Nat n => Data (Unsigned n)

KnownNat n => Num (Unsigned n)

Ord (Unsigned n)

KnownNat n => Read (Unsigned n)

None of the Read class' methods are synthesisable.

KnownNat n => Real (Unsigned n)

Show (Unsigned n)

KnownNat n => Arbitrary (Unsigned n)

KnownNat n => CoArbitrary (Unsigned n)

(KnownNat n, KnownNat ((+) n 1), KnownNat ((+) n 2)) => Bits (Unsigned n)

(KnownNat n, KnownNat ((+) n 1), KnownNat ((+) n 2)) => FiniteBits (Unsigned n)

Default (Unsigned n)

KnownNat n => Ixed (Unsigned n)

KnownNat n => Lift (Unsigned n)

(KnownNat n, KnownNat ((+) 1 n), KnownNat ((+) n n)) => SaturatingNum (Unsigned n)

BitPack (Unsigned n)

Bundle (Unsigned n)

(KnownNat ((+) 1 (Max m n)), KnownNat ((+) m n)) => ExtendingNum (Unsigned m) (Unsigned n)

type Unbundled' clk (Unsigned n) = Signal' clk (Unsigned n)

type Index (Unsigned n) = Int

type IxValue (Unsigned n) = Bit

type BitSize (Unsigned n) = n

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

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

Accessors

Length information

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

Type classes

BitConvert

pack# :: Unsigned n -> BitVector n

unpack# :: 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 synthesisable)

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

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

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

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

Bounded

minBound# :: Unsigned n

maxBound# :: KnownNat n => Unsigned n

Num

(+#) :: KnownNat n => Unsigned n -> Unsigned n -> Unsigned n

(-#) :: KnownNat n => Unsigned n -> Unsigned n -> Unsigned n

(*#) :: KnownNat n => Unsigned n -> Unsigned n -> Unsigned n

negate# :: KnownNat n => Unsigned n -> Unsigned n

fromInteger# :: KnownNat n => Integer -> Unsigned n

ExtendingNum

plus# :: KnownNat (1 + Max m n) => Unsigned m -> Unsigned n -> Unsigned (1 + Max m n)

minus# :: KnownNat (1 + Max m n) => Unsigned m -> Unsigned n -> Unsigned (1 + Max m n)

times# :: KnownNat (m + n) => 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# :: 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

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