bitpacking 0.0.1

Bit-packing and unpacking integer fields

bitpacking

Bit-packing and unpacking integer fields.

Installation

bitpacking is available on pypi:

pip install bitpacking

Example

Basic usage example (can be found in examples/pack_unpack.py):

from bitpacking import bitpack, bitunpack

ints = [
    1, 2, 0, 0,
    3, 0, 0, 0,
    0, 0, 0, 0,
    4, 0, 0, 0,
    0, 0, 0, 0,
    0, 5, 0, 6,
]

chunks = list(bitpack(fields=ints, field_width=3, chunk_width=64))
print(f"Bit-packed chunks: {chunks}")

fields = list(bitunpack(chunks=chunks, chunk_width=64, field_width=3))
print(f"Unpacked fields: {fields}")

Output:

Bit-packed chunks: [9223372311732695057, 194]
Unpacked fields: [1, 2, 0, 0, 3, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 6, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

Notice that the fields list has more entries than the initial ints list. This is because the leading zeros in the last chunk (194) are unpacked into "empty" fields.