Safe Haskell	None
Language	Haskell2010

Clash.Num.Saturating

Synopsis

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

Documentation

data Saturating a Source #

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

Instances details

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

fromSaturating :: Saturating a -> a Source #

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