Clash.Sized.Signed

Documentation

data Signed (n :: Nat)

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
>>> read (show (minBound :: Signed 3)) :: 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

Defined in Clash.Sized.Internal.Signed

Methods

resize :: (KnownNat a, KnownNat b) => Signed a -> Signed b

extend :: (KnownNat a, KnownNat b) => Signed a -> Signed (b + a)

zeroExtend :: (KnownNat a, KnownNat b) => Signed a -> Signed (b + a)

signExtend :: (KnownNat a, KnownNat b) => Signed a -> Signed (b + a)

truncateB :: KnownNat a => Signed (a + b) -> Signed a

KnownNat n => Bounded (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

minBound :: Signed n

maxBound :: Signed n

KnownNat n => Enum (Signed n)

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

Defined in Clash.Sized.Internal.Signed

Methods

succ :: Signed n -> Signed n

pred :: Signed n -> Signed n

toEnum :: Int -> Signed n

fromEnum :: Signed n -> Int

enumFrom :: Signed n -> [Signed n]

enumFromThen :: Signed n -> Signed n -> [Signed n]

enumFromTo :: Signed n -> Signed n -> [Signed n]

enumFromThenTo :: Signed n -> Signed n -> Signed n -> [Signed n]

Eq (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

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

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

KnownNat n => Integral (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

quot :: Signed n -> Signed n -> Signed n

rem :: Signed n -> Signed n -> Signed n

div :: Signed n -> Signed n -> Signed n

mod :: Signed n -> Signed n -> Signed n

quotRem :: Signed n -> Signed n -> (Signed n, Signed n)

divMod :: Signed n -> Signed n -> (Signed n, Signed n)

toInteger :: Signed n -> Integer

KnownNat n => Data (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Signed n -> c (Signed n)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Signed n)

toConstr :: Signed n -> Constr

dataTypeOf :: Signed n -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Signed n))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Signed n))

gmapT :: (forall b. Data b => b -> b) -> Signed n -> Signed n

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Signed n -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Signed n -> r

gmapQ :: (forall d. Data d => d -> u) -> Signed n -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Signed n -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Signed n -> m (Signed n)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Signed n -> m (Signed n)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Signed n -> m (Signed n)

KnownNat n => Num (Signed n)

Operators do wrap-around on overflow

Defined in Clash.Sized.Internal.Signed

Methods

(+) :: Signed n -> Signed n -> Signed n

(-) :: Signed n -> Signed n -> Signed n

(*) :: Signed n -> Signed n -> Signed n

negate :: Signed n -> Signed n

abs :: Signed n -> Signed n

signum :: Signed n -> Signed n

fromInteger :: Integer -> Signed n

Ord (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

compare :: Signed n -> Signed n -> Ordering

(<) :: Signed n -> Signed n -> Bool

(<=) :: Signed n -> Signed n -> Bool

(>) :: Signed n -> Signed n -> Bool

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

max :: Signed n -> Signed n -> Signed n

min :: Signed n -> Signed n -> Signed n

KnownNat n => Read (Signed n)

None of the Read class' methods are synthesisable.

Defined in Clash.Sized.Internal.Signed

Methods

readsPrec :: Int -> ReadS (Signed n)

readList :: ReadS [Signed n]

readPrec :: ReadPrec (Signed n)

readListPrec :: ReadPrec [Signed n]

KnownNat n => Real (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

toRational :: Signed n -> Rational

Show (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

showsPrec :: Int -> Signed n -> ShowS

show :: Signed n -> String

showList :: [Signed n] -> ShowS

KnownNat n => Lift (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

lift :: Signed n -> Q Exp

KnownNat n => Bits (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

(.&.) :: Signed n -> Signed n -> Signed n

(.|.) :: Signed n -> Signed n -> Signed n

xor :: Signed n -> Signed n -> Signed n

complement :: Signed n -> Signed n

shift :: Signed n -> Int -> Signed n

rotate :: Signed n -> Int -> Signed n

zeroBits :: Signed n

bit :: Int -> Signed n

setBit :: Signed n -> Int -> Signed n

clearBit :: Signed n -> Int -> Signed n

complementBit :: Signed n -> Int -> Signed n

testBit :: Signed n -> Int -> Bool

bitSizeMaybe :: Signed n -> Maybe Int

bitSize :: Signed n -> Int

isSigned :: Signed n -> Bool

shiftL :: Signed n -> Int -> Signed n

unsafeShiftL :: Signed n -> Int -> Signed n

shiftR :: Signed n -> Int -> Signed n

unsafeShiftR :: Signed n -> Int -> Signed n

rotateL :: Signed n -> Int -> Signed n

rotateR :: Signed n -> Int -> Signed n

popCount :: Signed n -> Int

KnownNat n => FiniteBits (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

finiteBitSize :: Signed n -> Int

countLeadingZeros :: Signed n -> Int

countTrailingZeros :: Signed n -> Int

NFData (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

rnf :: Signed n -> ()

KnownNat n => SaturatingNum (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

satPlus :: SaturationMode -> Signed n -> Signed n -> Signed n

satMin :: SaturationMode -> Signed n -> Signed n -> Signed n

satMult :: SaturationMode -> Signed n -> Signed n -> Signed n

ShowX (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

showsPrecX :: Int -> Signed n -> ShowS

showX :: Signed n -> String

showListX :: [Signed n] -> ShowS

KnownNat n => Ixed (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

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

KnownNat n => Default (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

def :: Signed n

KnownNat n => Arbitrary (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

arbitrary :: Gen (Signed n)

shrink :: Signed n -> [Signed n]

KnownNat n => CoArbitrary (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

coarbitrary :: Signed n -> Gen b -> Gen b

KnownNat n => BitPack (Signed n)

Defined in Clash.Sized.Internal.Signed

Associated Types

type BitSize (Signed n) :: Nat

Methods

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

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

Bundle (Signed n)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (Signed n) = (res :: *)

Methods

bundle :: Unbundled domain (Signed n) -> Signal domain (Signed n)

unbundle :: Signal domain (Signed n) -> Unbundled domain (Signed n)

ExtendingNum (Signed m) (Signed n)

Defined in Clash.Sized.Internal.Signed

Associated Types

type AResult (Signed m) (Signed n) :: *

type MResult (Signed m) (Signed n) :: *

Methods

plus :: Signed m -> Signed n -> AResult (Signed m) (Signed n)

minus :: Signed m -> Signed n -> AResult (Signed m) (Signed n)

times :: Signed m -> Signed n -> MResult (Signed m) (Signed n)

type Unbundled domain (Signed n)

Defined in Clash.Signal.Bundle

type Unbundled domain (Signed n) = Signal domain (Signed n)

type Index (Signed n)

Defined in Clash.Sized.Internal.Signed

type Index (Signed n) = Int

type IxValue (Signed n)

Defined in Clash.Sized.Internal.Signed

type IxValue (Signed n) = Bit

type BitSize (Signed n)

Defined in Clash.Sized.Internal.Signed

type BitSize (Signed n) = n

type AResult (Signed m) (Signed n)

Defined in Clash.Sized.Internal.Signed

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

type MResult (Signed m) (Signed n)

Defined in Clash.Sized.Internal.Signed

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