CLaSH.Sized.Signed

Documentation

data Signed n

Arbitrary-width signed integer represented by n bits, including the sign bit.

Uses standard 2-complements representation. Meaning that, given n bits, a Signed n number has a range of: [-(2^(n-1)) .. 2^(n-1)-1]

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

>>> maxBound :: Signed 3
3
>>> minBound :: Signed 3
-4
>>> 1 + 2 :: Signed 3
3
>>> 2 + 3 :: Signed 3
-3
>>> (-2) + (-3) :: Signed 3
3
>>> 2 * 3 :: Signed 4
6
>>> 2 * 4 :: Signed 4
-8
>>> (2 :: Signed 3) `times` (4 :: Signed 4) :: Signed 7
8
>>> (2 :: Signed 3) `plus` (3 :: Signed 3) :: Signed 4
5
>>> (-2 :: Signed 3) `plus` (-3 :: Signed 3) :: Signed 4
-5
>>> satPlus SatSymmetric 2 3 :: Signed 3
3
>>> satPlus SatSymmetric (-2) (-3) :: Signed 3
-3

Instances

Resize Signed

KnownNat n => Bounded (Signed n)

KnownNat n => Enum (Signed n)

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

Eq (Signed n)

KnownNat n => Integral (Signed n)

KnownNat n => Num (Signed n)

Operators do wrap-around on overflow

Ord (Signed n)

KnownNat n => Real (Signed n)

Show (Signed n)

KnownNat n => Arbitrary (Signed n)

KnownNat n => CoArbitrary (Signed n)

KnownNat n => Bits (Signed n)

KnownNat n => FiniteBits (Signed n)

KnownNat n => Default (Signed n)

KnownNat n => Ixed (Signed n)

KnownNat n => Lift (Signed n)

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

KnownNat n => BitPack (Signed n)

Bundle (Signed n)

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

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

type Index (Signed n) = Int

type IxValue (Signed n) = Bit

type BitSize (Signed n) = n

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

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