BitSet

Stores a bit pattern to quickly test if an index is enabled / disabled.

This class can store up to 32 different values in the range [0; 31].

Usage 

1const bitset = new BitSet();
2bitset.enable(10); // Enable bit at index `10`.
3console.log(bitset.enabled(10)); // Prints 'true'.

TypeScript 

The set can be typed over an enum:

1enum Tag {
2    First = 0,
3    Second = 1,
4}
5
6const bitset = new BitSet<Tag>();
7bitset.enable(Tag.First);

• BitSet
  • .constructor<T>() ⇒ BitSet
  • .disable(…bits) ⇒ BitSet
  • .disableAll() ⇒ BitSet
  • .enable(…bits) ⇒ BitSet
  • .enableAll() ⇒ BitSet
  • .enabled(bit) ⇒ boolean

.constructor<T>() ⇒ BitSet 

.disable(…bits: T[][]) ⇒ BitSet 

Disable the bit at the given index.

Returns: Reference to self (for method chaining).

.disableAll() ⇒ BitSet 

Disable all bits.

Returns: Reference to self (for method chaining).

.enable(…bits: T[][]) ⇒ BitSet 

Enable the bit at the given index.

Returns: Reference to self (for method chaining).

.enableAll() ⇒ BitSet 

Enable all bits.

Returns: Reference to self (for method chaining).

.enabled(bit: T) ⇒ boolean 

Checker whether the bit is set or not.

Returns: true if it’s enabled, false otherwise.