BooleanArray

A high-performance boolean array (a.k.a. BitSet, BitField, etc.) implementation backed by Uint32Array for efficient memory usage and fast bitwise operations.

See jsr.io/@phughesmcr/booleanarray for complete documentation.

Installation

Node

npx jsr add @phughesmcr/booleanarray

import { BooleanArray } from "@phughesmcr/booleanarray";

Deno

deno add jsr:@phughesmcr/booleanarray

import { BooleanArray } from "@phughesmcr/booleanarray";

Bun

bunx jsr add @phughesmcr/booleanarray

import { BooleanArray } from "@phughesmcr/booleanarray";

Usage

deno task example will run a complete example.

// Create a boolean array with 1000 bits
const bits = new BooleanArray(1000);

// Set individual bits
bits.setBool(42, true);
bits.setBool(142, true);

// Get bit values
console.log(bits.getBool(42)); // true
console.log(bits.getBool(43)); // false

// Set ranges
bits.setRange(100, 50, true); // Set 50 bits starting at index 100

// Perform bitwise operations
const other = new BooleanArray(1000);
const result = BooleanArray.and(bits, other);

// Get population count
console.log(bits.getPopulationCount()); // Number of set bits

// Iterate over set bits
for (const index of bits.truthyIndices()) {
  console.log(index); // Prints indices of set bits
}

Benchmarks

deno bench will run a benchmark suite.

• Runtime: Deno 2.1.4 (x86_64-pc-windows-msvc)
• CPU: AMD Ryzen 9 9900X

Contributing

Contributions are welcome. The aim of the project is performance - both in terms of speed and GC allocation pressure.

Please run deno test and deno task prep to run the tests before committing.

License

BooleanArray is released under the MIT license. See LICENSE for further details.

© 2024 The BooleanArray Authors. All rights reserved.

See AUTHORS.md for author details.