Copyright	(C) 2021-2026 QBayLogic B.V.
License	BSD2 (see the file LICENSE)
Maintainer	QBayLogic B.V. <devops@qbaylogic.com>
Safe Haskell	Safe-Inferred
Language	Haskell2010

Clash.Num.Zeroing

Description

Synopsis

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

Documentation

data Zeroing a Source #

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

Instances details

Arbitrary a => Arbitrary (Zeroing a) Source #
Instance details Defined in Clash.Num.Zeroing Methods arbitrary :: Gen (Zeroing a) # shrink :: Zeroing a -> [Zeroing a] #
Bits a => Bits (Zeroing a) Source #
Instance details 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) Source #
Instance details Defined in Clash.Num.Zeroing Methods finiteBitSize :: Zeroing a -> Int # countLeadingZeros :: Zeroing a -> Int # countTrailingZeros :: Zeroing a -> Int #
Bounded a => Bounded (Zeroing a) Source #
Instance details Defined in Clash.Num.Zeroing Methods minBound :: Zeroing a # maxBound :: Zeroing a #
(Enum a, SaturatingNum a) => Enum (Zeroing a) Source #
Instance details 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] #
(Bounded a, Ord a, SaturatingNum a) => Num (Zeroing a) Source #
Instance details 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 #
(Fractional a, Ord a, SaturatingNum a) => Fractional (Zeroing a) Source #
Instance details 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) Source #
Instance details 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 #
(Real a, SaturatingNum a) => Real (Zeroing a) Source #
Instance details Defined in Clash.Num.Zeroing Methods toRational :: Zeroing a -> Rational #
(RealFrac a, SaturatingNum a) => RealFrac (Zeroing a) Source #
Instance details 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) Source #
Instance details Defined in Clash.Num.Zeroing Methods showsPrec :: Int -> Zeroing a -> ShowS # show :: Zeroing a -> String # showList :: [Zeroing a] -> ShowS #
Binary a => Binary (Zeroing a) Source #
Instance details Defined in Clash.Num.Zeroing Methods put :: Zeroing a -> Put # get :: Get (Zeroing a) # putList :: [Zeroing a] -> Put #
BitPack a => BitPack (Zeroing a) Source #
Instance details Defined in Clash.Num.Zeroing Associated Types type BitSize (Zeroing a) :: Nat Source # Methods pack :: Zeroing a -> BitVector (BitSize (Zeroing a)) Source # unpack :: BitVector (BitSize (Zeroing a)) -> Zeroing a Source #
(Ord a, SaturatingNum a) => SaturatingNum (Zeroing a) Source #
Instance details Defined in Clash.Num.Zeroing Methods satAdd :: SaturationMode -> Zeroing a -> Zeroing a -> Zeroing a Source # satSub :: SaturationMode -> Zeroing a -> Zeroing a -> Zeroing a Source # satMul :: SaturationMode -> Zeroing a -> Zeroing a -> Zeroing a Source # satSucc :: SaturationMode -> Zeroing a -> Zeroing a Source # satPred :: SaturationMode -> Zeroing a -> Zeroing a Source #
Parity a => Parity (Zeroing a) Source #
Instance details Defined in Clash.Num.Zeroing Methods even :: Zeroing a -> Bool Source # odd :: Zeroing a -> Bool Source #
NFDataX a => NFDataX (Zeroing a) Source #
Instance details Defined in Clash.Num.Zeroing Methods deepErrorX :: String -> Zeroing a Source # hasUndefined :: Zeroing a -> Bool Source # ensureSpine :: Zeroing a -> Zeroing a Source # rnfX :: Zeroing a -> () Source #
ShowX a => ShowX (Zeroing a) Source #
Instance details Defined in Clash.Num.Zeroing Methods showsPrecX :: Int -> Zeroing a -> ShowS Source # showX :: Zeroing a -> String Source # showListX :: [Zeroing a] -> ShowS Source #
NFData a => NFData (Zeroing a) Source #
Instance details Defined in Clash.Num.Zeroing Methods rnf :: Zeroing a -> () #
Eq a => Eq (Zeroing a) Source #
Instance details Defined in Clash.Num.Zeroing Methods (==) :: Zeroing a -> Zeroing a -> Bool # (/=) :: Zeroing a -> Zeroing a -> Bool #
Ord a => Ord (Zeroing a) Source #
Instance details 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 #
Hashable a => Hashable (Zeroing a) Source #
Instance details Defined in Clash.Num.Zeroing Methods hashWithSalt :: Int -> Zeroing a -> Int # hash :: Zeroing a -> Int #
Resize f => Resize (Compose Zeroing f) Source #
Instance details Defined in Clash.Num.Zeroing Methods resize :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Compose Zeroing f a -> Compose Zeroing f b Source # extend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Compose Zeroing f a -> Compose Zeroing f (b + a) Source # zeroExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Compose Zeroing f a -> Compose Zeroing f (b + a) Source # signExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Compose Zeroing f a -> Compose Zeroing f (b + a) Source # truncateB :: forall (a :: Nat) (b :: Natural). KnownNat a => Compose Zeroing f (a + b) -> Compose Zeroing f a Source #
type BitSize (Zeroing a) Source #
Instance details Defined in Clash.Num.Zeroing type BitSize (Zeroing a) = BitSize a

fromZeroing :: Zeroing a -> a Source #

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