bit-us

Библиотека для удобной работы с битовыми структурами

Рабочее название библиотеки bit-us (Bit utilities and structures)

Установка из репозитория

1. git clone https://github.com/shining-mind/cs-frontend.git
2. cd cs-frontend
3. npm i
4. cd src/coursework-01/bit-us
5. npm run build
6. npm pack
7. Перейти в директорию проекта в который надо установить пакет
8. npm i /path/to/package/bit-us-0.1.0.tgz

Чтение бинарных данных:

• UintLSBReader - чтение бинарного потока в LSB порядке (реализация ReadBits из спецификации webp), подробнее

Структуры:

BitVector - битовый вектор с поддержкой 8, 16, 32 битовых слов

const vec = new BitVector(3)
vec.push(1) // 1
vec.push(1) // 2
vec.push(0) // 3
vec.set(2, 0)
vec.get(2) // 0
vec.set(2, 1)
vec.get(2) // 1
vec.set(0, 0)
vec.get(0) // 0

Array.from(vec) // [0, 1, 1]

API

Свойства

• capacity - аллоцированный размер
• length - количество бит в векторе
• byteLength - аллоцированные байты

Методы

• constructor(capacity, wordSize) - в конструктор передается исходный размер вектора и опциональный параметр размер битового слова
• push(value): number - добавить бит в вектор
• pop(): Bit
• set(n, value): void - задать значение N-го бита
• get(n): Bit - получить значение N-го бита
• toBlob(): Blob - преобразовать вектор в Blob. Первые 4 байта выделены под длину вектора, остальные - под данные. Доступно только для вектора из 8 битных слов.

Битовые маски (bit-field)

const userPermissions = new BitFieldFactory('read', 'write', 'edit');
const bob = userPermissions.create('read', 'write');

bob.has('read', 'write') // true
bob.has('read', 'write', 'edit') // false
bob.any('read', 'write', 'edit') // true

API

Класс: BitFieldFactory

Методы

• create(...flags) - создать битовую маску с данными флагами
• getFlagValue(flag) - получить числовое значение для флага

Класс: BitField

Методы

• has(...flags) - проверить заданы ли все флаги в маске
• can(...flags) - синоним has
• any(...flags) - проверить есть ли какой-либо из флагов в маске
• valueOf() - получить числовое значение примененных флагов

Вспомогательные функции:

• takeBitsMSB(int, n, k) - взять первые N бит начиная со старшего бита из числа размером K бит
• skipBitsMSB(int, n, k) - пропустить первые N бит начиная со старшего бита из числа размером K бит
• takeBits(int, n) - взять N бит начиная с младшего бита из числа
• skipBits(int, n, k) - пропустить N бит начиная с младшего бита из числа размером K бит