Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.SatInt

Description

Adapted from SafeInt to perform saturating arithmetic (i.e. returning max or min bounds) instead of throwing on overflow.

This is not quite as fast as using Int or Int64 directly, but we need the safety.

Synopsis

data SatInt
unsafeToSatInt ∷ Int → SatInt
fromSatInt ∷ ∀ a. Num a ⇒ SatInt → a
dividedBy ∷ SatInt → Natural → SatInt

Documentation

data SatInt Source #

Instances

Instances details

FromJSON SatInt Source #
Instance details Defined in Data.SatInt Methods parseJSON ∷ Value → Parser SatInt parseJSONList ∷ Value → Parser [SatInt] omittedField ∷ Maybe SatInt
ToJSON SatInt Source #
Instance details Defined in Data.SatInt Methods toJSON ∷ SatInt → Value toEncoding ∷ SatInt → Encoding toJSONList ∷ [SatInt] → Value toEncodingList ∷ [SatInt] → Encoding omitField ∷ SatInt → Bool
Bits SatInt Source #
Instance details Defined in Data.SatInt Methods (.&.) ∷ SatInt → SatInt → SatInt Source # (.\|.) ∷ SatInt → SatInt → SatInt Source # xor ∷ SatInt → SatInt → SatInt Source # complement ∷ SatInt → SatInt Source # shift ∷ SatInt → Int → SatInt Source # rotate ∷ SatInt → Int → SatInt Source # zeroBits ∷ SatInt Source # bit ∷ Int → SatInt Source # setBit ∷ SatInt → Int → SatInt Source # clearBit ∷ SatInt → Int → SatInt Source # complementBit ∷ SatInt → Int → SatInt Source # testBit ∷ SatInt → Int → Bool Source # bitSizeMaybe ∷ SatInt → Maybe Int Source # bitSize ∷ SatInt → Int Source # isSigned ∷ SatInt → Bool Source # shiftL ∷ SatInt → Int → SatInt Source # unsafeShiftL ∷ SatInt → Int → SatInt Source # shiftR ∷ SatInt → Int → SatInt Source # unsafeShiftR ∷ SatInt → Int → SatInt Source # rotateL ∷ SatInt → Int → SatInt Source # rotateR ∷ SatInt → Int → SatInt Source # popCount ∷ SatInt → Int Source #
FiniteBits SatInt Source #
Instance details Defined in Data.SatInt Methods finiteBitSize ∷ SatInt → Int Source # countLeadingZeros ∷ SatInt → Int Source # countTrailingZeros ∷ SatInt → Int Source #
Bounded SatInt Source #
Instance details Defined in Data.SatInt Methods minBound ∷ SatInt Source # maxBound ∷ SatInt Source #
Generic SatInt Source #
Instance details Defined in Data.SatInt Associated Types type Rep SatInt ∷ Type → Type Source # Methods from ∷ SatInt → Rep SatInt x Source # to ∷ Rep SatInt x → SatInt Source #
Num SatInt Source #	In the `Num` instance, we plug in our own addition, multiplication and subtraction function that perform overflow-checking.
Instance details Defined in Data.SatInt Methods (+) ∷ SatInt → SatInt → SatInt Source # (-) ∷ SatInt → SatInt → SatInt Source # (*) ∷ SatInt → SatInt → SatInt Source # negate ∷ SatInt → SatInt Source # abs ∷ SatInt → SatInt Source # signum ∷ SatInt → SatInt Source # fromInteger ∷ Integer → SatInt Source #
Read SatInt Source #
Instance details Defined in Data.SatInt Methods readsPrec ∷ Int → ReadS SatInt Source # readList ∷ ReadS [SatInt] Source # readPrec ∷ ReadPrec SatInt Source # readListPrec ∷ ReadPrec [SatInt] Source #
Show SatInt Source #
Instance details Defined in Data.SatInt Methods showsPrec ∷ Int → SatInt → ShowS Source # show ∷ SatInt → String Source # showList ∷ [SatInt] → ShowS Source #
FromField SatInt Source #
Instance details Defined in Data.SatInt Methods parseField ∷ Field → Parser SatInt
NFData SatInt Source #
Instance details Defined in Data.SatInt Methods rnf ∷ SatInt → () Source #
Eq SatInt Source #
Instance details Defined in Data.SatInt Methods (==) ∷ SatInt → SatInt → Bool Source # (/=) ∷ SatInt → SatInt → Bool Source #
Ord SatInt Source #
Instance details Defined in Data.SatInt Methods compare ∷ SatInt → SatInt → Ordering Source # (<) ∷ SatInt → SatInt → Bool Source # (<=) ∷ SatInt → SatInt → Bool Source # (>) ∷ SatInt → SatInt → Bool Source # (>=) ∷ SatInt → SatInt → Bool Source # max ∷ SatInt → SatInt → SatInt Source # min ∷ SatInt → SatInt → SatInt Source #
NoThunks SatInt Source #
Instance details Defined in Data.SatInt Methods noThunks ∷ Context → SatInt → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → SatInt → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy SatInt → String Source #
Prim SatInt Source #
Instance details Defined in Data.SatInt Methods sizeOfType# ∷ Proxy SatInt → Int# Source # sizeOf# ∷ SatInt → Int# Source # alignmentOfType# ∷ Proxy SatInt → Int# Source # alignment# ∷ SatInt → Int# Source # indexByteArray# ∷ ByteArray# → Int# → SatInt Source # readByteArray# ∷ MutableByteArray# s → Int# → State# s → (# State# s, SatInt #) Source # writeByteArray# ∷ MutableByteArray# s → Int# → SatInt → State# s → State# s Source # setByteArray# ∷ MutableByteArray# s → Int# → Int# → SatInt → State# s → State# s Source # indexOffAddr# ∷ Addr# → Int# → SatInt Source # readOffAddr# ∷ Addr# → Int# → State# s → (# State# s, SatInt #) Source # writeOffAddr# ∷ Addr# → Int# → SatInt → State# s → State# s Source # setOffAddr# ∷ Addr# → Int# → Int# → SatInt → State# s → State# s Source #
Serialise SatInt Source #
Instance details Defined in Data.SatInt Methods encode ∷ SatInt → Encoding Source # decode ∷ Decoder s SatInt Source # encodeList ∷ [SatInt] → Encoding Source # decodeList ∷ Decoder s [SatInt] Source #
Lift SatInt Source #
Instance details Defined in Data.SatInt Methods lift ∷ Quote m ⇒ SatInt → m Exp Source # liftTyped ∷ ∀ (m ∷ Type → Type). Quote m ⇒ SatInt → Code m SatInt Source #
type Rep SatInt Source #
Instance details Defined in Data.SatInt type Rep SatInt = D1 ('MetaData "SatInt" "Data.SatInt" "plutus-core-1.46.0.0-inplace-satint" 'True) (C1 ('MetaCons "SI" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSatInt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

unsafeToSatInt ∷ Int → SatInt Source #

Wrap an Int as a SatInt. This is unsafe because the Int can be a result of an arbitrary potentially underflowing/overflowing operation.

fromSatInt ∷ ∀ a. Num a ⇒ SatInt → a Source #

An optimized version of fromIntegral . unSatInt.

dividedBy ∷ SatInt → Natural → SatInt Source #

Divide a SatInt by a natural number. If the natural number is zero, return maxBound; if we're at the maximum or minimum value then leave the input unaltered. This should never throw.