Clash.Num.Erroring

Documentation

data Erroring a

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

Bounded a => Bounded (Erroring a)

Defined in Clash.Num.Erroring

Methods

minBound :: Erroring a

maxBound :: Erroring a

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

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]

Eq a => Eq (Erroring a)

Defined in Clash.Num.Erroring

Methods

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

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

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

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)

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

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

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

Ord a => Ord (Erroring a)

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

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

Defined in Clash.Num.Erroring

Methods

toRational :: Erroring a -> Rational

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

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)

Defined in Clash.Num.Erroring

Methods

showsPrec :: Int -> Erroring a -> ShowS

show :: Erroring a -> String

showList :: [Erroring a] -> ShowS

Arbitrary a => Arbitrary (Erroring a)

Defined in Clash.Num.Erroring

Methods

arbitrary :: Gen (Erroring a)

shrink :: Erroring a -> [Erroring a]

Bits a => Bits (Erroring a)

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)

Defined in Clash.Num.Erroring

Methods

finiteBitSize :: Erroring a -> Int

countLeadingZeros :: Erroring a -> Int

countTrailingZeros :: Erroring a -> Int

Binary a => Binary (Erroring a)

Defined in Clash.Num.Erroring

Methods

put :: Erroring a -> Put

get :: Get (Erroring a)

putList :: [Erroring a] -> Put

NFData a => NFData (Erroring a)

Defined in Clash.Num.Erroring

Methods

rnf :: Erroring a -> ()

Hashable a => Hashable (Erroring a)

Defined in Clash.Num.Erroring

Methods

hashWithSalt :: Int -> Erroring a -> Int

hash :: Erroring a -> Int

NFDataX a => NFDataX (Erroring a)

Defined in Clash.Num.Erroring

Methods

deepErrorX :: String -> Erroring a

hasUndefined :: Erroring a -> Bool

ensureSpine :: Erroring a -> Erroring a

rnfX :: Erroring a -> ()

ShowX a => ShowX (Erroring a)

Defined in Clash.Num.Erroring

Methods

showsPrecX :: Int -> Erroring a -> ShowS

showX :: Erroring a -> String

showListX :: [Erroring a] -> ShowS

BitPack a => BitPack (Erroring a)

Defined in Clash.Num.Erroring

Associated Types

type BitSize (Erroring a) :: Nat

Methods

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

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

Parity a => Parity (Erroring a)

Defined in Clash.Num.Erroring

Methods

even :: Erroring a -> Bool

odd :: Erroring a -> Bool

Resize f => Resize (Compose Erroring f)

Defined in Clash.Num.Erroring

Methods

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

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

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

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

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

type BitSize (Erroring a)

Defined in Clash.Num.Erroring

type BitSize (Erroring a) = BitSize a

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