Safe Haskell	Safe-Inferred
Language	Haskell2010

Clash.Num.Wrapping

Synopsis

newtype Wrapping a = Wrapping {
- fromWrapping :: a
}
toWrapping :: SaturatingNum a => a -> Wrapping a

Documentation

newtype Wrapping a Source #

A wrapping number type is one where all operations wrap between minBound and maxBound (and vice-versa) if the result goes out of bounds for the underlying type.

Numbers can be converted to wrap by default using toWrapping.

Constructors

Wrapping
Fields fromWrapping :: a

Instances

Instances details

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

toWrapping :: SaturatingNum a => a -> Wrapping a Source #