Copyright	(C) 2025-2026 QBayLogic B.V.
License	BSD2 (see the file LICENSE)
Maintainer	QBayLogic B.V. <devops@qbaylogic.com>
Safe Haskell	None
Language	Haskell2010

Clash.Shockwaves.BitList

Contents

Modifying BitLists
Using BitList with BitVector
Using BitList as a number
Rest

Description

Various functions for dealing with dynamically sized binary representations of data.

Synopsis

data BitList
take :: Int -> BitList -> BitList
drop :: Int -> BitList -> BitList
split :: Int -> BitList -> (BitList, BitList)
concat :: BitList -> BitList -> BitList
slice :: (Int, Int) -> BitList -> BitList
length :: BitList -> Int
bvToBl :: forall (n :: Nat). KnownNat n => BitVector n -> BitList
blToBv :: forall (n :: Nat). KnownNat n => BitList -> BitVector n
pack :: BitPack a => a -> BitList
unpack :: BitPack a => BitList -> a
toInteger :: BitList -> Maybe Integer
hasUndefined :: BitList -> Bool

Documentation

data BitList Source #

A type like BitVector, but with a dynamic size. It is meant to make type-independent handling of binary representations possible.

Instances

Instances details

ToJSON BitList Source #
Instance details Defined in Clash.Shockwaves.Internal.BitList Methods toJSON :: BitList -> Value # toEncoding :: BitList -> Encoding # toJSONList :: [BitList] -> Value # toEncodingList :: [BitList] -> Encoding # omitField :: BitList -> Bool #
ToJSONKey BitList Source #
Instance details Defined in Clash.Shockwaves.Internal.BitList Methods toJSONKey :: ToJSONKeyFunction BitList # toJSONKeyList :: ToJSONKeyFunction [BitList] #
Semigroup BitList Source #
Instance details Defined in Clash.Shockwaves.Internal.BitList Methods (<>) :: BitList -> BitList -> BitList # sconcat :: NonEmpty BitList -> BitList # stimes :: Integral b => b -> BitList -> BitList #
Bits BitList Source #
Instance details Defined in Clash.Shockwaves.Internal.BitList Methods (.&.) :: BitList -> BitList -> BitList # (.\|.) :: BitList -> BitList -> BitList # xor :: BitList -> BitList -> BitList # complement :: BitList -> BitList # shift :: BitList -> Int -> BitList # rotate :: BitList -> Int -> BitList # zeroBits :: BitList # bit :: Int -> BitList # setBit :: BitList -> Int -> BitList # clearBit :: BitList -> Int -> BitList # complementBit :: BitList -> Int -> BitList # testBit :: BitList -> Int -> Bool # bitSizeMaybe :: BitList -> Maybe Int # bitSize :: BitList -> Int # isSigned :: BitList -> Bool # shiftL :: BitList -> Int -> BitList # unsafeShiftL :: BitList -> Int -> BitList # shiftR :: BitList -> Int -> BitList # unsafeShiftR :: BitList -> Int -> BitList # rotateL :: BitList -> Int -> BitList # rotateR :: BitList -> Int -> BitList # popCount :: BitList -> Int #
IsString BitList Source #	When converting from a string, `0` and `1` are interpreted as bits, and `_` is treated as a spacer (is ignored). Any other characters are interpreted as undefined bits.
Instance details Defined in Clash.Shockwaves.Internal.BitList Methods fromString :: String -> BitList #
Show BitList Source #
Instance details Defined in Clash.Shockwaves.Internal.BitList Methods showsPrec :: Int -> BitList -> ShowS # show :: BitList -> String # showList :: [BitList] -> ShowS #
Eq BitList Source #
Instance details Defined in Clash.Shockwaves.Internal.BitList Methods (==) :: BitList -> BitList -> Bool # (/=) :: BitList -> BitList -> Bool #
Ord BitList Source #
Instance details Defined in Clash.Shockwaves.Internal.BitList Methods compare :: BitList -> BitList -> Ordering # (<) :: BitList -> BitList -> Bool # (<=) :: BitList -> BitList -> Bool # (>) :: BitList -> BitList -> Bool # (>=) :: BitList -> BitList -> Bool # max :: BitList -> BitList -> BitList # min :: BitList -> BitList -> BitList #