Numeric.SDNV

Documentation

data SDNV a

Instances

Eq (SDNV a)

Binary (SDNV a)

encodeSDNV :: (Bits a, Integral a) => a -> SDNV a

Encode a value into SDNV. Please note that encoding of variable length negative values such as of type Integer results in sign lost.

decodeSDNV :: (Bits a, Integral a) => SDNV a -> a

Decode SDNV into an integral value. This function doesn't check SDNV integrity and size, and in certain cases may produce incorrect results. See safeDecodeSDNV.

safeDecodeSDNV :: (Bits a, Integral a) => SDNV a -> Maybe a

Decode SDNV into an intergral value. This function uses isValidSDNV to detect incorrectly encoded SDNV, and to check for overflow in case of finite size types.

isValidSDNV :: forall a. (Bits a, Integral a) => SDNV a -> Bool

Check SDNV correctness. Returns True if SDNV is correctly encoded and decoding will not result in an overflow for finite datatypes.