Modulebasement-0.0.16Haskell2010

Basement.Bits

Synopsis

classclass BitOps bits where

operation over bits

(.&.) :: bits -> bits -> bitsinfixl 7
(.|.) :: bits -> bits -> bitsinfixl 5
(.^.) :: bits -> bits -> bitsinfixl 6
(.<<.) :: bits -> CountOf Bool -> bitsinfixl 8
(.>>.) :: bits -> CountOf Bool -> bitsinfixl 8
bit :: Offset Bool -> bits
construct a bit set with the bit at the given index set.
isBitSet :: bits -> Offset Bool -> Bool
test the bit at the given index is set
setBit :: bits -> Offset Bool -> bits
set the bit at the given index
clearBit :: bits -> Offset Bool -> bits
clear the bit at the given index

Instances13BitOps, …

classclass FiniteBitsOps bits where

operation over finite bits

numberOfBits :: bits -> CountOf Bool
get the number of bits in the given object
rotateL :: bits -> CountOf Bool -> bitsinfixl 8
rotate the given bit set.
rotateR :: bits -> CountOf Bool -> bitsinfixl 8
rotate the given bit set.
popCount :: bits -> CountOf Bool
count of number of bit set to 1 in the given bit set.
bitFlip :: bits -> bits
reverse all bits in the argument
countLeadingZeros :: bits -> CountOf Bool
count of the number of leading zeros
countTrailingZeros :: bits -> CountOf Bool
count of the number of trailing zeros

Instances13FiniteBitsOps, …

FiniteBitsOps Word128Defined in basement-0.0.16 · Basement.Bits
FiniteBitsOps Word256Defined in basement-0.0.16 · Basement.Bits
FiniteBitsOps Int16Defined in basement-0.0.16 · Basement.Bits
FiniteBitsOps Int32Defined in basement-0.0.16 · Basement.Bits
FiniteBitsOps Int64Defined in basement-0.0.16 · Basement.Bits
FiniteBitsOps Int8Defined in basement-0.0.16 · Basement.Bits
FiniteBitsOps BoolDefined in basement-0.0.16 · Basement.Bits
FiniteBitsOps WordDefined in basement-0.0.16 · Basement.Bits
FiniteBitsOps Word16Defined in basement-0.0.16 · Basement.Bits
FiniteBitsOps Word32Defined in basement-0.0.16 · Basement.Bits
FiniteBitsOps Word64Defined in basement-0.0.16 · Basement.Bits
FiniteBitsOps Word8Defined in basement-0.0.16 · Basement.Bits
(SizeValid n, NatWithinBound (CountOf Bool) n) => FiniteBitsOps (Bits n)Defined in basement-0.0.16 · Basement.Bits

newtypenewtype Bits (n :: Nat)

Bool set of n bits.

Instances12Bounded, Enum, Eq, Ord, Show, BitOps, …

SizeValid n => Bounded (Bits n)Defined in basement-0.0.16 · Basement.Bits
SizeValid n => Enum (Bits n)Defined in basement-0.0.16 · Basement.Bits
Eq (Bits n)Defined in basement-0.0.16 · Basement.Bits
Ord (Bits n)Defined in basement-0.0.16 · Basement.Bits
Show (Bits n)Defined in basement-0.0.16 · Basement.Bits
SizeValid n => BitOps (Bits n)Defined in basement-0.0.16 · Basement.Bits
(SizeValid n, NatWithinBound (CountOf Bool) n) => FiniteBitsOps (Bits n)Defined in basement-0.0.16 · Basement.Bits
SizeValid n => Additive (Bits n)Defined in basement-0.0.16 · Basement.Bits
SizeValid n => IDivisible (Bits n)Defined in basement-0.0.16 · Basement.Bits
SizeValid n => Multiplicative (Bits n)Defined in basement-0.0.16 · Basement.Bits
SizeValid n => Subtractive (Bits n)Defined in basement-0.0.16 · Basement.Bits
type Difference (Bits n) = Bits nDefined in basement-0.0.16 · Basement.Bits

valuetoBits :: SizeValid n => Natural -> Bits n

convert the given Natural into a Bits of size n

if bits that are not within the boundaries of the 'Bits n' will be truncated.

valueallOne :: SizeValid n => Bits n

construct a Bits with all bits set.

this function is equivalet to maxBound