BitSet

A TypeScript implementation of a BitSet data structure.

Installation

You can install bitkit via npm:

npm install bitkit

Usage

import BitSet from 'bitkit';

// Create a BitSet with a specified size
const bitset = new BitSet(100);

// Set bits
bitset.set(5);
bitset.set(10);
bitset.set(20);

// Check if a bit is set
console.log(bitset.get(5)); // Output: true
console.log(bitset.get(15)); // Output: false

// Clear a bit
bitset.clear(5);

// Flip a bit
bitset.flip(10);

// Perform logical AND, OR, XOR operations with another BitSet
const otherBitset = new BitSet(100);
otherBitset.set(10);
otherBitset.set(20);

bitset.and(otherBitset);
bitset.or(otherBitset);
bitset.xor(otherBitset);

// Check if BitSet is empty
console.log(bitset.isEmpty()); // Output: false

// Check if BitSet intersects with another BitSet
console.log(bitset.intersects(otherBitset)); // Output: true

// Clear all bits
bitset.clearAll();

// Set all bits
bitset.setAll();

// Convert BitSet to string representation
console.log(bitset.toString());

API

BitSet(size: number)

• size: The size of the BitSet.

set(index: number)

Sets the bit at the specified index.

get(index: number): boolean

Gets the value of the bit at the specified index.

clear(index: number)

Clears the bit at the specified index.

flip(index: number)

Flips the bit at the specified index.

clearAll()

Clears all bits.

setAll()

Sets all bits.

isEmpty(): boolean

Checks if the BitSet is empty.

and(other: BitSet)

Performs a logical AND operation with another BitSet.

or(other: BitSet)

Performs a logical OR operation with another BitSet.

xor(other: BitSet)

Performs a logical XOR operation with another BitSet.

intersects(other: BitSet): boolean

Checks if the BitSet intersects with another BitSet.

toString(): string

Converts the BitSet to a string representation.

License

This package is licensed under the MIT License.