Haskus.Format.Binary.Bits.Finite

Types with finite bit count

Documentation

class FiniteBits a where

Type representable by a fixed amount of bits

Minimal complete definition

zeroBits, countLeadingZeros, countTrailingZeros

Associated Types

type BitSize a :: Nat

Number of bits

Methods

bitSize :: (Integral i, KnownNat (BitSize a)) => a -> i

Number of bits (the value is ignored)

zeroBits :: a

All bits set to 0

oneBits :: a

All bits set to 1

oneBits :: Bitwise a => a

All bits set to 1

countLeadingZeros :: a -> Word

Count number of zero bits preceding the most significant set bit

countTrailingZeros :: a -> Word

Count number of zero bits following the least significant set bit

Instances

FiniteBits Int

Defined in Haskus.Format.Binary.Bits.Finite

Associated Types

type BitSize Int :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize Int)) => Int -> i

zeroBits :: Int

oneBits :: Int

countLeadingZeros :: Int -> Word

countTrailingZeros :: Int -> Word

FiniteBits Int8

Defined in Haskus.Format.Binary.Bits.Finite

Associated Types

type BitSize Int8 :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize Int8)) => Int8 -> i

zeroBits :: Int8

oneBits :: Int8

countLeadingZeros :: Int8 -> Word

countTrailingZeros :: Int8 -> Word

FiniteBits Int16

Defined in Haskus.Format.Binary.Bits.Finite

Associated Types

type BitSize Int16 :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize Int16)) => Int16 -> i

zeroBits :: Int16

oneBits :: Int16

countLeadingZeros :: Int16 -> Word

countTrailingZeros :: Int16 -> Word

FiniteBits Int32

Defined in Haskus.Format.Binary.Bits.Finite

Associated Types

type BitSize Int32 :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize Int32)) => Int32 -> i

zeroBits :: Int32

oneBits :: Int32

countLeadingZeros :: Int32 -> Word

countTrailingZeros :: Int32 -> Word

FiniteBits Int64

Defined in Haskus.Format.Binary.Bits.Finite

Associated Types

type BitSize Int64 :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize Int64)) => Int64 -> i

zeroBits :: Int64

oneBits :: Int64

countLeadingZeros :: Int64 -> Word

countTrailingZeros :: Int64 -> Word

FiniteBits Word

Defined in Haskus.Format.Binary.Bits.Finite

Associated Types

type BitSize Word :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize Word)) => Word -> i

zeroBits :: Word

oneBits :: Word

countLeadingZeros :: Word -> Word

countTrailingZeros :: Word -> Word

FiniteBits Word8

Defined in Haskus.Format.Binary.Bits.Finite

Associated Types

type BitSize Word8 :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize Word8)) => Word8 -> i

zeroBits :: Word8

oneBits :: Word8

countLeadingZeros :: Word8 -> Word

countTrailingZeros :: Word8 -> Word

FiniteBits Word16

Defined in Haskus.Format.Binary.Bits.Finite

Associated Types

type BitSize Word16 :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize Word16)) => Word16 -> i

zeroBits :: Word16

oneBits :: Word16

countLeadingZeros :: Word16 -> Word

countTrailingZeros :: Word16 -> Word

FiniteBits Word32

Defined in Haskus.Format.Binary.Bits.Finite

Associated Types

type BitSize Word32 :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize Word32)) => Word32 -> i

zeroBits :: Word32

oneBits :: Word32

countLeadingZeros :: Word32 -> Word

countTrailingZeros :: Word32 -> Word

FiniteBits Word64

Defined in Haskus.Format.Binary.Bits.Finite

Associated Types

type BitSize Word64 :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize Word64)) => Word64 -> i

zeroBits :: Word64

oneBits :: Word64

countLeadingZeros :: Word64 -> Word

countTrailingZeros :: Word64 -> Word

FiniteBits a => FiniteBits (AsLittleEndian a)

Defined in Haskus.Format.Binary.Endianness

Associated Types

type BitSize (AsLittleEndian a) :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize (AsLittleEndian a))) => AsLittleEndian a -> i

zeroBits :: AsLittleEndian a

oneBits :: AsLittleEndian a

countLeadingZeros :: AsLittleEndian a -> Word

countTrailingZeros :: AsLittleEndian a -> Word

FiniteBits a => FiniteBits (AsBigEndian a)

Defined in Haskus.Format.Binary.Endianness

Associated Types

type BitSize (AsBigEndian a) :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize (AsBigEndian a))) => AsBigEndian a -> i

zeroBits :: AsBigEndian a

oneBits :: AsBigEndian a

countLeadingZeros :: AsBigEndian a -> Word

countTrailingZeros :: AsBigEndian a -> Word

(KnownNat (BitSize a), FiniteBits a, KnownNat n, Storable a) => FiniteBits (Vector n a)

Defined in Haskus.Format.Binary.Vector

Associated Types

type BitSize (Vector n a) :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize (Vector n a))) => Vector n a -> i

zeroBits :: Vector n a

oneBits :: Vector n a

countLeadingZeros :: Vector n a -> Word

countTrailingZeros :: Vector n a -> Word