Class BitArray

Bit array

Based heavily on https://github.com/lemire/FastBitSet.js which is licensed under the Apache License, Version 2.0.

Hierarchy

BitArray

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BitArray(length: number, setAll?: undefined | true | false): BitArray

- Defined in src/utils/bitarray.ts:28
Parameters
- length: number
  
  array length
- Optional setAll: undefined | true | false
Returns BitArray

Properties

Private _words

_words: Uint32Array

length

length: number

Methods

_assignRange

_assignRange(start: number, end: number, value: boolean): undefined | this

- Defined in src/utils/bitarray.ts:78
Parameters
- start: number
- end: number
- value: boolean
Returns undefined | this

_isRangeValue

_isRangeValue(start: number, end: number, value: boolean): undefined | true | false

- Defined in src/utils/bitarray.ts:202
Parameters
- start: number
- end: number
- value: boolean
Returns undefined | true | false

clear

clear(index: number): void

- Defined in src/utils/bitarray.ts:65
Set value at index to false

Parameters
- index: number
  
  the index
Returns void

clearAll

clearAll(): undefined | this

- Defined in src/utils/bitarray.ts:183
Clear all bits of the array

Returns undefined | this

this object

clearBits

clearBits(...indices: number[]): this

- Defined in src/utils/bitarray.ts:161
Clear bits at all given indices

Parameters
- Rest ...indices: number[]
Returns this

this object

clearRange

clearRange(start: number, end: number): undefined | this

- Defined in src/utils/bitarray.ts:137
Clear bits of the given range

Parameters
- start: number
  
  start index
- end: number
  
  end index
Returns undefined | this

this object

clone

clone(): any

- Defined in src/utils/bitarray.ts:491
Clone this object

Returns any

the cloned object

difference

difference(otherBitarray: BitArray): this

- Defined in src/utils/bitarray.ts:333
Calculate difference betwen this and another bit array. Store result in this object.

Parameters
- otherBitarray: BitArray
  
  the other bit array
Returns this

this object

flip

flip(index: number): void

- Defined in src/utils/bitarray.ts:74
Flip value at index

Parameters
- index: number
  
  the index
Returns void

flipAll

flipAll(): this

- Defined in src/utils/bitarray.ts:191
Flip all the values in the array

Returns this

this object

forEach

forEach(callback: function): void

- Defined in src/utils/bitarray.ts:442
Iterate over all set bits in the array

Parameters
- callback: function
  
  the callback
  - - (index: number, i: number): any
    - Parameters
      - index: number
      - i: number
      Returns any
Returns void

get

get(index: number): boolean

- Defined in src/utils/bitarray.ts:47
Get value at index

Parameters
- index: number
  
  the index
Returns boolean

value

getIntersectionSize

getIntersectionSize(otherBitarray: BitArray): number

- Defined in src/utils/bitarray.ts:406
Calculate the number of bits in common betwen this and another bit array.

Parameters
- otherBitarray: BitArray
  
  the other bit array
Returns number

size

getSize

getSize(): number

- Defined in src/utils/bitarray.ts:317
How many set bits?

Returns number

number of set bits

intersection

intersection(otherBitarray: BitArray): this

- Defined in src/utils/bitarray.ts:371
Calculate intersection betwen this and another bit array. Store result in this object.

Parameters
- otherBitarray: BitArray
  
  the other bit array
Returns this

this object

intersects

intersects(otherBitarray: BitArray): boolean

- Defined in src/utils/bitarray.ts:389
Test if there is any intersection betwen this and another bit array.

Parameters
- otherBitarray: BitArray
  
  the other bit array
Returns boolean

test result

isAllClear

isAllClear(): undefined | true | false

- Defined in src/utils/bitarray.ts:262
Test if all bits in the array are clear

Returns undefined | true | false

test result

isAllSet

isAllSet(): undefined | true | false

- Defined in src/utils/bitarray.ts:254
Test if all bits in the array are set

Returns undefined | true | false

test result

isClear

isClear(...indices: number[]): boolean

- Defined in src/utils/bitarray.ts:286
Test if bits at all given indices are clear

Parameters
- Rest ...indices: number[]
Returns boolean

test result

isEqualTo

isEqualTo(otherBitarray: BitArray): boolean

- Defined in src/utils/bitarray.ts:301
Test if two BitArrays are identical in all their values

Parameters
- otherBitarray: BitArray
  
  the other BitArray
Returns boolean

test result

isRangeClear

isRangeClear(start: number, end: number): undefined | true | false

- Defined in src/utils/bitarray.ts:246
Test if bits in given range are clear

Parameters
- start: number
  
  start index
- end: number
  
  end index
Returns undefined | true | false

this object

isRangeSet

isRangeSet(start: number, end: number): undefined | true | false

- Defined in src/utils/bitarray.ts:236
Test if bits in given range are set

Parameters
- start: number
  
  start index
- end: number
  
  end index
Returns undefined | true | false

this object

isSet

isSet(...indices: number[]): boolean

- Defined in src/utils/bitarray.ts:271
Test if bits at all given indices are set

Parameters
- Rest ...indices: number[]
Returns boolean

test result

makeIntersection

makeIntersection(otherBitarray: BitArray): any

- Defined in src/utils/bitarray.ts:423
Calculate intersection betwen this and another bit array. Store result in a new bit array.

Parameters
- otherBitarray: BitArray
  
  the other bit array
Returns any

the new bit array

set

set(index: number): void

- Defined in src/utils/bitarray.ts:56
Set value at index to true

Parameters
- index: number
  
  the index
Returns void

setAll

setAll(): undefined | this

- Defined in src/utils/bitarray.ts:175
Set all bits of the array

Returns undefined | this

this object

setBits

setBits(...indices: number[]): this

- Defined in src/utils/bitarray.ts:146
Set bits at all given indices

Parameters
- Rest ...indices: number[]
Returns this

this object

setRange

setRange(start: number, end: number): undefined | this

- Defined in src/utils/bitarray.ts:127
Set bits of the given range

Parameters
- start: number
  
  start index
- end: number
  
  end index
Returns undefined | this

this object

toArray

toArray(): any[]

- Defined in src/utils/bitarray.ts:462
Get an array with the set bits

Returns any[]

bit indices

toSeleString

toSeleString(): string

- Defined in src/utils/bitarray.ts:482
Returns string

toString

toString(): string

- Defined in src/utils/bitarray.ts:478
Returns string

union

union(otherBitarray: BitArray): this

- Defined in src/utils/bitarray.ts:352
Calculate union betwen this and another bit array. Store result in this object.

Parameters
- otherBitarray: BitArray
  
  the other bit array
Returns this

this object

Generated using TypeDoc