Clash.Num.Zeroing

Documentation

data Zeroing a

A zeroing number type is one where all operations return zero if they go out of bounds for the underlying type.

Numbers can be converted to zero by default using toZeroing.

Instances

Bounded a => Bounded (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

minBound :: Zeroing a

maxBound :: Zeroing a

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

Defined in Clash.Num.Zeroing

Methods

succ :: Zeroing a -> Zeroing a

pred :: Zeroing a -> Zeroing a

toEnum :: Int -> Zeroing a

fromEnum :: Zeroing a -> Int

enumFrom :: Zeroing a -> [Zeroing a]

enumFromThen :: Zeroing a -> Zeroing a -> [Zeroing a]

enumFromTo :: Zeroing a -> Zeroing a -> [Zeroing a]

enumFromThenTo :: Zeroing a -> Zeroing a -> Zeroing a -> [Zeroing a]

Eq a => Eq (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

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

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

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

Defined in Clash.Num.Zeroing

Methods

(/) :: Zeroing a -> Zeroing a -> Zeroing a

recip :: Zeroing a -> Zeroing a

fromRational :: Rational -> Zeroing a

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

Defined in Clash.Num.Zeroing

Methods

quot :: Zeroing a -> Zeroing a -> Zeroing a

rem :: Zeroing a -> Zeroing a -> Zeroing a

div :: Zeroing a -> Zeroing a -> Zeroing a

mod :: Zeroing a -> Zeroing a -> Zeroing a

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

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

toInteger :: Zeroing a -> Integer

(Bounded a, Ord a, SaturatingNum a) => Num (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

(+) :: Zeroing a -> Zeroing a -> Zeroing a

(-) :: Zeroing a -> Zeroing a -> Zeroing a

(*) :: Zeroing a -> Zeroing a -> Zeroing a

negate :: Zeroing a -> Zeroing a

abs :: Zeroing a -> Zeroing a

signum :: Zeroing a -> Zeroing a

fromInteger :: Integer -> Zeroing a

Ord a => Ord (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

compare :: Zeroing a -> Zeroing a -> Ordering

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

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

(>) :: Zeroing a -> Zeroing a -> Bool

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

max :: Zeroing a -> Zeroing a -> Zeroing a

min :: Zeroing a -> Zeroing a -> Zeroing a

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

Defined in Clash.Num.Zeroing

Methods

toRational :: Zeroing a -> Rational

(RealFrac a, SaturatingNum a) => RealFrac (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

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

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

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

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

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

Show a => Show (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

showsPrec :: Int -> Zeroing a -> ShowS

show :: Zeroing a -> String

showList :: [Zeroing a] -> ShowS

Arbitrary a => Arbitrary (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

arbitrary :: Gen (Zeroing a)

shrink :: Zeroing a -> [Zeroing a]

Bits a => Bits (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

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

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

xor :: Zeroing a -> Zeroing a -> Zeroing a

complement :: Zeroing a -> Zeroing a

shift :: Zeroing a -> Int -> Zeroing a

rotate :: Zeroing a -> Int -> Zeroing a

zeroBits :: Zeroing a

bit :: Int -> Zeroing a

setBit :: Zeroing a -> Int -> Zeroing a

clearBit :: Zeroing a -> Int -> Zeroing a

complementBit :: Zeroing a -> Int -> Zeroing a

testBit :: Zeroing a -> Int -> Bool

bitSizeMaybe :: Zeroing a -> Maybe Int

bitSize :: Zeroing a -> Int

isSigned :: Zeroing a -> Bool

shiftL :: Zeroing a -> Int -> Zeroing a

unsafeShiftL :: Zeroing a -> Int -> Zeroing a

shiftR :: Zeroing a -> Int -> Zeroing a

unsafeShiftR :: Zeroing a -> Int -> Zeroing a

rotateL :: Zeroing a -> Int -> Zeroing a

rotateR :: Zeroing a -> Int -> Zeroing a

popCount :: Zeroing a -> Int

FiniteBits a => FiniteBits (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

finiteBitSize :: Zeroing a -> Int

countLeadingZeros :: Zeroing a -> Int

countTrailingZeros :: Zeroing a -> Int

Binary a => Binary (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

put :: Zeroing a -> Put

get :: Get (Zeroing a)

putList :: [Zeroing a] -> Put

NFData a => NFData (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

rnf :: Zeroing a -> ()

Hashable a => Hashable (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

hashWithSalt :: Int -> Zeroing a -> Int

hash :: Zeroing a -> Int

NFDataX a => NFDataX (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

deepErrorX :: String -> Zeroing a

hasUndefined :: Zeroing a -> Bool

ensureSpine :: Zeroing a -> Zeroing a

rnfX :: Zeroing a -> ()

ShowX a => ShowX (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

showsPrecX :: Int -> Zeroing a -> ShowS

showX :: Zeroing a -> String

showListX :: [Zeroing a] -> ShowS

BitPack a => BitPack (Zeroing a)

Defined in Clash.Num.Zeroing

Associated Types

type BitSize (Zeroing a) :: Nat

Methods

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

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

Parity a => Parity (Zeroing a)

Defined in Clash.Num.Zeroing

Methods

even :: Zeroing a -> Bool

odd :: Zeroing a -> Bool

Resize f => Resize (Compose Zeroing f)

Defined in Clash.Num.Zeroing

Methods

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

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

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

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

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

type BitSize (Zeroing a)

Defined in Clash.Num.Zeroing

type BitSize (Zeroing a) = BitSize a

fromZeroing :: Zeroing a -> a

toZeroing :: SaturatingNum a => a -> Zeroing a