CLaSH.Sized.Unsigned

Documentation

data 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

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)