Class BitSet

A memory-efficient Boolean array. Contains just the minimal operations needed for our Bloom filter implementation.

author: David Leppik

Hierarchy

BitSet

Index

Methods

Properties

Constructors

constructor

Methods

add

add(index: number): void

- Defined in src/bloom/bit-set.ts:64
Set the bit to true

Parameters
- index: number
  
  position of the bit, zero-indexed
Returns void

bitCount

bitCount(): number

- Defined in src/bloom/bit-set.ts:86
Returns the number of true bits.

Returns number

Static countBits

countBits(bits: number): number

- Defined in src/bloom/bit-set.ts:165
Returns the number of true bits in the number
bits
an unsigned 8-bit number

example
```
BitSet.countBits(0) // returns 0
BitSet.countBits(3) // returns 2
```
Parameters
- bits: number
Returns number

equals

equals(other: BitSet): boolean

- Defined in src/bloom/bit-set.ts:98
Returns true if the size and contents are identical.

Parameters
- other: BitSet
  
  another BitSet
Returns boolean

export

export(): { content: string; size: number }

- Defined in src/bloom/bit-set.ts:113
Returns a JSON-encodable object readable by import.

Returns { content: string; size: number }
- content: string
- size: number

has

has(index: number): boolean

- Defined in src/bloom/bit-set.ts:54
Returns the value of the bit at the given index

Parameters
- index: number
  
  position of the bit, zero-indexed
Returns boolean

Static highBit

highBit(bits: number): number

- Defined in src/bloom/bit-set.ts:146
Returns the index of the maximum bit in the number, or -1 for 0
bits
an unsigned 8-bit number
```
@example
BitSet.highBit(0) // returns -1
BitSet.highBit(5) // returns 2
```
Parameters
- bits: number
Returns number

Static import

import(data: { content: string; size: number }): BitSet

- Defined in src/bloom/bit-set.ts:124
Returns an object written by export.

Parameters
- data: { content: string; size: number }
  
  an object written by export
  - content: string
  - size: number
Returns BitSet

max

max(): number

- Defined in src/bloom/bit-set.ts:73
Returns the maximum true bit.

Returns number

Properties

array

array: Uint8Array

Readonly size

size: number

Constructors

constructor

new BitSet(size: number): BitSet

- Defined in src/bloom/bit-set.ts:44
Constructor. All bits are initially set to false.

Parameters
- size: number
  
  the number of bits that can be stored. (This is NOT required to be a multiple of 8.)
Returns BitSet

Generated using TypeDoc