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

Clash.Num.Overflowing

Description

Synopsis

data Overflowing a
fromOverflowing :: Overflowing a -> a
hasOverflowed :: Overflowing a -> Bool
toOverflowing :: a -> Overflowing a
clearOverflow :: Overflowing a -> Overflowing a

Documentation

data Overflowing a Source #

An overflowing number behaves similarly to a Wrapping number, but also includes an overflow status flag which can be used to more easily check if an overflow has occurred.

Numbers can be converted to be Overflowing using toOverflowing.

Instances

Instances details

Bounded a => Bounded (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods minBound :: Overflowing a # maxBound :: Overflowing a #
(Enum a, Eq a, SaturatingNum a) => Enum (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods succ :: Overflowing a -> Overflowing a # pred :: Overflowing a -> Overflowing a # toEnum :: Int -> Overflowing a # fromEnum :: Overflowing a -> Int # enumFrom :: Overflowing a -> [Overflowing a] # enumFromThen :: Overflowing a -> Overflowing a -> [Overflowing a] # enumFromTo :: Overflowing a -> Overflowing a -> [Overflowing a] # enumFromThenTo :: Overflowing a -> Overflowing a -> Overflowing a -> [Overflowing a] #
Eq a => Eq (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods (==) :: Overflowing a -> Overflowing a -> Bool # (/=) :: Overflowing a -> Overflowing a -> Bool #
(Fractional a, Ord a, SaturatingNum a) => Fractional (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods (/) :: Overflowing a -> Overflowing a -> Overflowing a # recip :: Overflowing a -> Overflowing a # fromRational :: Rational -> Overflowing a #
(Integral a, SaturatingNum a) => Integral (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods quot :: Overflowing a -> Overflowing a -> Overflowing a # rem :: Overflowing a -> Overflowing a -> Overflowing a # div :: Overflowing a -> Overflowing a -> Overflowing a # mod :: Overflowing a -> Overflowing a -> Overflowing a # quotRem :: Overflowing a -> Overflowing a -> (Overflowing a, Overflowing a) # divMod :: Overflowing a -> Overflowing a -> (Overflowing a, Overflowing a) # toInteger :: Overflowing a -> Integer #
(Bounded a, Ord a, SaturatingNum a) => Num (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods (+) :: Overflowing a -> Overflowing a -> Overflowing a # (-) :: Overflowing a -> Overflowing a -> Overflowing a # (*) :: Overflowing a -> Overflowing a -> Overflowing a # negate :: Overflowing a -> Overflowing a # abs :: Overflowing a -> Overflowing a # signum :: Overflowing a -> Overflowing a # fromInteger :: Integer -> Overflowing a #
Ord a => Ord (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods compare :: Overflowing a -> Overflowing a -> Ordering # (<) :: Overflowing a -> Overflowing a -> Bool # (<=) :: Overflowing a -> Overflowing a -> Bool # (>) :: Overflowing a -> Overflowing a -> Bool # (>=) :: Overflowing a -> Overflowing a -> Bool # max :: Overflowing a -> Overflowing a -> Overflowing a # min :: Overflowing a -> Overflowing a -> Overflowing a #
(Real a, SaturatingNum a) => Real (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods toRational :: Overflowing a -> Rational #
(RealFrac a, SaturatingNum a) => RealFrac (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods properFraction :: Integral b => Overflowing a -> (b, Overflowing a) # truncate :: Integral b => Overflowing a -> b # round :: Integral b => Overflowing a -> b # ceiling :: Integral b => Overflowing a -> b # floor :: Integral b => Overflowing a -> b #
Show a => Show (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods showsPrec :: Int -> Overflowing a -> ShowS # show :: Overflowing a -> String # showList :: [Overflowing a] -> ShowS #
Generic (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Associated Types type Rep (Overflowing a) :: Type -> Type # Methods from :: Overflowing a -> Rep (Overflowing a) x # to :: Rep (Overflowing a) x -> Overflowing a #
Binary a => Binary (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods put :: Overflowing a -> Put # get :: Get (Overflowing a) # putList :: [Overflowing a] -> Put #
NFData a => NFData (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods rnf :: Overflowing a -> () #
Hashable a => Hashable (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods hashWithSalt :: Int -> Overflowing a -> Int # hash :: Overflowing a -> Int #
NFDataX a => NFDataX (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods deepErrorX :: String -> Overflowing a Source # hasUndefined :: Overflowing a -> Bool Source # ensureSpine :: Overflowing a -> Overflowing a Source # rnfX :: Overflowing a -> () Source #
ShowX a => ShowX (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods showsPrecX :: Int -> Overflowing a -> ShowS Source # showX :: Overflowing a -> String Source # showListX :: [Overflowing a] -> ShowS Source #
(BitPack a, KnownNat (BitSize a + 1)) => BitPack (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Associated Types type BitSize (Overflowing a) :: Nat Source # Methods pack :: Overflowing a -> BitVector (BitSize (Overflowing a)) Source # unpack :: BitVector (BitSize (Overflowing a)) -> Overflowing a Source #
Parity a => Parity (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing Methods even :: Overflowing a -> Bool Source # odd :: Overflowing a -> Bool Source #
type Rep (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing type Rep (Overflowing a) = D1 ('MetaData "Overflowing" "Clash.Num.Overflowing" "clash-prelude-1.8.0-inplace" 'False) (C1 ('MetaCons "Overflowing" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromOverflowing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "hasOverflowed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))
type BitSize (Overflowing a) Source #
Instance details Defined in Clash.Num.Overflowing type BitSize (Overflowing a) = BitSize a + 1

fromOverflowing :: Overflowing a -> a Source #

Retrieve the value

hasOverflowed :: Overflowing a -> Bool Source #

True when a computation has overflowed

toOverflowing :: a -> Overflowing a Source #

clearOverflow :: Overflowing a -> Overflowing a Source #

Reset the overflow status flag to False.