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.Erroring

Description

Synopsis

data Erroring a
fromErroring :: Erroring a -> a
toErroring :: SaturatingNum a => a -> Erroring a

Documentation

data Erroring a Source #

An erroring number type is one where all operations return a XExecption if they would go out of bounds for the underlying type.

Numbers can be converted to error by default using toErroring.

Instances

Instances details

Arbitrary a => Arbitrary (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods arbitrary :: Gen (Erroring a) # shrink :: Erroring a -> [Erroring a] #
Bits a => Bits (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods (.&.) :: Erroring a -> Erroring a -> Erroring a # (.\|.) :: Erroring a -> Erroring a -> Erroring a # xor :: Erroring a -> Erroring a -> Erroring a # complement :: Erroring a -> Erroring a # shift :: Erroring a -> Int -> Erroring a # rotate :: Erroring a -> Int -> Erroring a # zeroBits :: Erroring a # bit :: Int -> Erroring a # setBit :: Erroring a -> Int -> Erroring a # clearBit :: Erroring a -> Int -> Erroring a # complementBit :: Erroring a -> Int -> Erroring a # testBit :: Erroring a -> Int -> Bool # bitSizeMaybe :: Erroring a -> Maybe Int # bitSize :: Erroring a -> Int # isSigned :: Erroring a -> Bool # shiftL :: Erroring a -> Int -> Erroring a # unsafeShiftL :: Erroring a -> Int -> Erroring a # shiftR :: Erroring a -> Int -> Erroring a # unsafeShiftR :: Erroring a -> Int -> Erroring a # rotateL :: Erroring a -> Int -> Erroring a # rotateR :: Erroring a -> Int -> Erroring a # popCount :: Erroring a -> Int #
FiniteBits a => FiniteBits (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods finiteBitSize :: Erroring a -> Int # countLeadingZeros :: Erroring a -> Int # countTrailingZeros :: Erroring a -> Int #
Bounded a => Bounded (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods minBound :: Erroring a # maxBound :: Erroring a #
(Enum a, SaturatingNum a) => Enum (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods succ :: Erroring a -> Erroring a # pred :: Erroring a -> Erroring a # toEnum :: Int -> Erroring a # fromEnum :: Erroring a -> Int # enumFrom :: Erroring a -> [Erroring a] # enumFromThen :: Erroring a -> Erroring a -> [Erroring a] # enumFromTo :: Erroring a -> Erroring a -> [Erroring a] # enumFromThenTo :: Erroring a -> Erroring a -> Erroring a -> [Erroring a] #
(Bounded a, Ord a, SaturatingNum a) => Num (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods (+) :: Erroring a -> Erroring a -> Erroring a # (-) :: Erroring a -> Erroring a -> Erroring a # (*) :: Erroring a -> Erroring a -> Erroring a # negate :: Erroring a -> Erroring a # abs :: Erroring a -> Erroring a # signum :: Erroring a -> Erroring a # fromInteger :: Integer -> Erroring a #
(Fractional a, Ord a, SaturatingNum a) => Fractional (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods (/) :: Erroring a -> Erroring a -> Erroring a # recip :: Erroring a -> Erroring a # fromRational :: Rational -> Erroring a #
(Integral a, SaturatingNum a) => Integral (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods quot :: Erroring a -> Erroring a -> Erroring a # rem :: Erroring a -> Erroring a -> Erroring a # div :: Erroring a -> Erroring a -> Erroring a # mod :: Erroring a -> Erroring a -> Erroring a # quotRem :: Erroring a -> Erroring a -> (Erroring a, Erroring a) # divMod :: Erroring a -> Erroring a -> (Erroring a, Erroring a) # toInteger :: Erroring a -> Integer #
(Real a, SaturatingNum a) => Real (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods toRational :: Erroring a -> Rational #
(RealFrac a, SaturatingNum a) => RealFrac (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods properFraction :: Integral b => Erroring a -> (b, Erroring a) # truncate :: Integral b => Erroring a -> b # round :: Integral b => Erroring a -> b # ceiling :: Integral b => Erroring a -> b # floor :: Integral b => Erroring a -> b #
Show a => Show (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods showsPrec :: Int -> Erroring a -> ShowS # show :: Erroring a -> String # showList :: [Erroring a] -> ShowS #
Binary a => Binary (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods put :: Erroring a -> Put # get :: Get (Erroring a) # putList :: [Erroring a] -> Put #
BitPack a => BitPack (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Associated Types type BitSize (Erroring a) :: Nat Source # Methods pack :: Erroring a -> BitVector (BitSize (Erroring a)) Source # unpack :: BitVector (BitSize (Erroring a)) -> Erroring a Source #
(Ord a, SaturatingNum a) => SaturatingNum (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods satAdd :: SaturationMode -> Erroring a -> Erroring a -> Erroring a Source # satSub :: SaturationMode -> Erroring a -> Erroring a -> Erroring a Source # satMul :: SaturationMode -> Erroring a -> Erroring a -> Erroring a Source # satSucc :: SaturationMode -> Erroring a -> Erroring a Source # satPred :: SaturationMode -> Erroring a -> Erroring a Source #
Parity a => Parity (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods even :: Erroring a -> Bool Source # odd :: Erroring a -> Bool Source #
NFDataX a => NFDataX (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods deepErrorX :: String -> Erroring a Source # hasUndefined :: Erroring a -> Bool Source # ensureSpine :: Erroring a -> Erroring a Source # rnfX :: Erroring a -> () Source #
ShowX a => ShowX (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods showsPrecX :: Int -> Erroring a -> ShowS Source # showX :: Erroring a -> String Source # showListX :: [Erroring a] -> ShowS Source #
NFData a => NFData (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods rnf :: Erroring a -> () #
Eq a => Eq (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods (==) :: Erroring a -> Erroring a -> Bool # (/=) :: Erroring a -> Erroring a -> Bool #
Ord a => Ord (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods compare :: Erroring a -> Erroring a -> Ordering # (<) :: Erroring a -> Erroring a -> Bool # (<=) :: Erroring a -> Erroring a -> Bool # (>) :: Erroring a -> Erroring a -> Bool # (>=) :: Erroring a -> Erroring a -> Bool # max :: Erroring a -> Erroring a -> Erroring a # min :: Erroring a -> Erroring a -> Erroring a #
Hashable a => Hashable (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring Methods hashWithSalt :: Int -> Erroring a -> Int # hash :: Erroring a -> Int #
Resize f => Resize (Compose Erroring f) Source #
Instance details Defined in Clash.Num.Erroring Methods resize :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Compose Erroring f a -> Compose Erroring f b Source # extend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Compose Erroring f a -> Compose Erroring f (b + a) Source # zeroExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Compose Erroring f a -> Compose Erroring f (b + a) Source # signExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Compose Erroring f a -> Compose Erroring f (b + a) Source # truncateB :: forall (a :: Nat) (b :: Natural). KnownNat a => Compose Erroring f (a + b) -> Compose Erroring f a Source #
type BitSize (Erroring a) Source #
Instance details Defined in Clash.Num.Erroring type BitSize (Erroring a) = BitSize a

fromErroring :: Erroring a -> a Source #

toErroring :: SaturatingNum a => a -> Erroring a Source #