v/vlib/bitfield
jeffmikels 6e6d51a1c9
docs: add more documentation to each of the modules in vlib (#13043)
2022-01-07 13:28:50 +02:00
..
README.md docs: add more documentation to each of the modules in vlib (#13043) 2022-01-07 13:28:50 +02:00
bitfield.v bitfield,flag: document the remaining functions 2021-11-18 20:15:26 +02:00
bitfield_test.v bitfield: minor documentation and function tweaks (#10549) 2021-06-24 07:27:04 +03:00

README.md

Description:

bitfield is a module for manipulating arrays of bits, i.e. series of zeroes and ones spread across an array of storage units (unsigned 32-bit integers).

BitField Structure

Bit arrays are stored in data structures called 'BitField'. The structure is 'opaque', i.e. its internals are not available to the end user. This module provides API (functions and methods) for accessing and modifying bit arrays.