Clash.Num.Saturating

Documentation

data Saturating a

A saturating number type is one where all operations saturate at the bounds of the underlying type, i.e. operations which overflow return maxBound and operations that underflow return minBound.

Numbers can be converted to saturate by default using toSaturating.

Instances

Bounded a => Bounded (Saturating a)

Defined in Clash.Num.Saturating

Methods

minBound :: Saturating a

maxBound :: Saturating a

(Enum a, SaturatingNum a) => Enum (Saturating a)

Defined in Clash.Num.Saturating

Methods

succ :: Saturating a -> Saturating a

pred :: Saturating a -> Saturating a

toEnum :: Int -> Saturating a

fromEnum :: Saturating a -> Int

enumFrom :: Saturating a -> [Saturating a]

enumFromThen :: Saturating a -> Saturating a -> [Saturating a]

enumFromTo :: Saturating a -> Saturating a -> [Saturating a]

enumFromThenTo :: Saturating a -> Saturating a -> Saturating a -> [Saturating a]

Eq a => Eq (Saturating a)

Defined in Clash.Num.Saturating

Methods

(==) :: Saturating a -> Saturating a -> Bool

(/=) :: Saturating a -> Saturating a -> Bool

(Fractional a, Ord a, SaturatingNum a) => Fractional (Saturating a)

Defined in Clash.Num.Saturating

Methods

(/) :: Saturating a -> Saturating a -> Saturating a

recip :: Saturating a -> Saturating a

fromRational :: Rational -> Saturating a

(Integral a, SaturatingNum a) => Integral (Saturating a)

Defined in Clash.Num.Saturating

Methods

quot :: Saturating a -> Saturating a -> Saturating a

rem :: Saturating a -> Saturating a -> Saturating a

div :: Saturating a -> Saturating a -> Saturating a

mod :: Saturating a -> Saturating a -> Saturating a

quotRem :: Saturating a -> Saturating a -> (Saturating a, Saturating a)

divMod :: Saturating a -> Saturating a -> (Saturating a, Saturating a)

toInteger :: Saturating a -> Integer

(Ord a, SaturatingNum a) => Num (Saturating a)

Defined in Clash.Num.Saturating

Methods

(+) :: Saturating a -> Saturating a -> Saturating a

(-) :: Saturating a -> Saturating a -> Saturating a

(*) :: Saturating a -> Saturating a -> Saturating a

negate :: Saturating a -> Saturating a

abs :: Saturating a -> Saturating a

signum :: Saturating a -> Saturating a

fromInteger :: Integer -> Saturating a

Ord a => Ord (Saturating a)

Defined in Clash.Num.Saturating

Methods

compare :: Saturating a -> Saturating a -> Ordering

(<) :: Saturating a -> Saturating a -> Bool

(<=) :: Saturating a -> Saturating a -> Bool

(>) :: Saturating a -> Saturating a -> Bool

(>=) :: Saturating a -> Saturating a -> Bool

max :: Saturating a -> Saturating a -> Saturating a

min :: Saturating a -> Saturating a -> Saturating a

(Real a, SaturatingNum a) => Real (Saturating a)

Defined in Clash.Num.Saturating

Methods

toRational :: Saturating a -> Rational

(Ord a, RealFrac a, SaturatingNum a) => RealFrac (Saturating a)

Defined in Clash.Num.Saturating

Methods

properFraction :: Integral b => Saturating a -> (b, Saturating a)

truncate :: Integral b => Saturating a -> b

round :: Integral b => Saturating a -> b

ceiling :: Integral b => Saturating a -> b

floor :: Integral b => Saturating a -> b

Show a => Show (Saturating a)

Defined in Clash.Num.Saturating

Methods

showsPrec :: Int -> Saturating a -> ShowS

show :: Saturating a -> String

showList :: [Saturating a] -> ShowS

Arbitrary a => Arbitrary (Saturating a)

Defined in Clash.Num.Saturating

Methods

arbitrary :: Gen (Saturating a)

shrink :: Saturating a -> [Saturating a]

Bits a => Bits (Saturating a)

Defined in Clash.Num.Saturating

Methods

(.&.) :: Saturating a -> Saturating a -> Saturating a

(.|.) :: Saturating a -> Saturating a -> Saturating a

xor :: Saturating a -> Saturating a -> Saturating a

complement :: Saturating a -> Saturating a

shift :: Saturating a -> Int -> Saturating a

rotate :: Saturating a -> Int -> Saturating a

zeroBits :: Saturating a

bit :: Int -> Saturating a

setBit :: Saturating a -> Int -> Saturating a

clearBit :: Saturating a -> Int -> Saturating a

complementBit :: Saturating a -> Int -> Saturating a

testBit :: Saturating a -> Int -> Bool

bitSizeMaybe :: Saturating a -> Maybe Int

bitSize :: Saturating a -> Int

isSigned :: Saturating a -> Bool

shiftL :: Saturating a -> Int -> Saturating a

unsafeShiftL :: Saturating a -> Int -> Saturating a

shiftR :: Saturating a -> Int -> Saturating a

unsafeShiftR :: Saturating a -> Int -> Saturating a

rotateL :: Saturating a -> Int -> Saturating a

rotateR :: Saturating a -> Int -> Saturating a

popCount :: Saturating a -> Int

FiniteBits a => FiniteBits (Saturating a)

Defined in Clash.Num.Saturating

Methods

finiteBitSize :: Saturating a -> Int

countLeadingZeros :: Saturating a -> Int

countTrailingZeros :: Saturating a -> Int

Binary a => Binary (Saturating a)

Defined in Clash.Num.Saturating

Methods

put :: Saturating a -> Put

get :: Get (Saturating a)

putList :: [Saturating a] -> Put

NFData a => NFData (Saturating a)

Defined in Clash.Num.Saturating

Methods

rnf :: Saturating a -> ()

Hashable a => Hashable (Saturating a)

Defined in Clash.Num.Saturating

Methods

hashWithSalt :: Int -> Saturating a -> Int

hash :: Saturating a -> Int

NFDataX a => NFDataX (Saturating a)

Defined in Clash.Num.Saturating

Methods

deepErrorX :: String -> Saturating a

hasUndefined :: Saturating a -> Bool

ensureSpine :: Saturating a -> Saturating a

rnfX :: Saturating a -> ()

ShowX a => ShowX (Saturating a)

Defined in Clash.Num.Saturating

Methods

showsPrecX :: Int -> Saturating a -> ShowS

showX :: Saturating a -> String

showListX :: [Saturating a] -> ShowS

BitPack a => BitPack (Saturating a)

Defined in Clash.Num.Saturating

Associated Types

type BitSize (Saturating a) :: Nat

Methods

pack :: Saturating a -> BitVector (BitSize (Saturating a))

unpack :: BitVector (BitSize (Saturating a)) -> Saturating a

Parity a => Parity (Saturating a)

Defined in Clash.Num.Saturating

Methods

even :: Saturating a -> Bool

odd :: Saturating a -> Bool

Resize f => Resize (Compose Saturating f)

Defined in Clash.Num.Saturating

Methods

resize :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Compose Saturating f a -> Compose Saturating f b

extend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Compose Saturating f a -> Compose Saturating f (b + a)

zeroExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Compose Saturating f a -> Compose Saturating f (b + a)

signExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Compose Saturating f a -> Compose Saturating f (b + a)

truncateB :: forall (a :: Nat) (b :: Nat). KnownNat a => Compose Saturating f (a + b) -> Compose Saturating f a

type BitSize (Saturating a)

Defined in Clash.Num.Saturating

type BitSize (Saturating a) = BitSize a

fromSaturating :: Saturating a -> a

toSaturating :: SaturatingNum a => a -> Saturating a