BitPool

A high-performance BitPool implementation backed by Uint32Array for efficient memory usage and fast bitwise operations.

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

Installation

Node

npx jsr add @phughesmcr/bitpool

import { BitPool } from "@phughesmcr/bitpool";

Deno

deno add jsr:@phughesmcr/bitpool

import { BitPool } from "@phughesmcr/bitpool";

Bun

bunx jsr add @phughesmcr/bitpool

import { BitPool } from "@phughesmcr/bitpool";

Usage

deno task example will run a complete example.

const pool = new BitPool(1000); // 0 - 999

const entity_1 = pool.acquire();
const entity_2 = pool.acquire();

console.log(pool.isOccupied(entity_1));
console.log(pool.isOccupied(entity_2));
console.log(pool.isOccupied(999));

pool.release(entity_1);
pool.release(entity_2);

console.log(pool.isOccupied(entity_1));
console.log(pool.isOccupied(entity_2));
console.log(pool.isOccupied(999));

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

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

© 2024 The BitPool Authors. All rights reserved.

See AUTHORS.md for author details.