Ivory.Language.Bits

Documentation

bitOp :: forall a. IvoryExpr a => ExpOp -> a -> a -> a

class (Num a, IvoryExpr a) => IvoryBits a where

Methods

(.&) :: a -> a -> a

(.|) :: a -> a -> a

(.^) :: a -> a -> a

iComplement :: a -> a

iShiftL :: a -> a -> a

iShiftR :: a -> a -> a

Instances

IvoryBits Uint64

IvoryBits Uint32

IvoryBits Uint16

IvoryBits Uint8

class (IvoryBits a, IvoryBits b) => BitSplit a b | a -> b where

Extraction of the upper or lower half of a bit type into the next smallest bit type.

Methods

ubits :: a -> b

lbits :: a -> b

Instances

BitSplit Uint64 Uint32

BitSplit Uint32 Uint16

BitSplit Uint16 Uint8

class (IvoryBits a, IvoryBits b) => BitCast a b where

A narrowing cast from one bit type to another. This explicitly discards the upper bits of the input value to return a smaller type, and is only defined for unsigned integers.

Methods

bitCast :: a -> b

Instances

BitCast Uint64 Uint64

BitCast Uint64 Uint32

BitCast Uint64 Uint16

BitCast Uint64 Uint8

BitCast Uint32 Uint32

BitCast Uint32 Uint16

BitCast Uint32 Uint8

BitCast Uint16 Uint16

BitCast Uint16 Uint8

BitCast Uint8 Uint8

extractByte :: BitCast a Uint8 => a -> (Uint8, a)

Extract the least significant byte from an integer. This returns the two values (x & 0xFF, x >> 8), with the first value safely casted to an 8-bit integer.

This is convenient to use with a state monad and sets, such as:

 fst $ runState x $ do
   a <- sets extractByte
   b <- sets extractByte
   return (a, b)