NGL@1.0.0-beta.7 Home Manual Reference Source Gallery

import BitArray from 'ngl/src/utils/bitarray.js'

public class | source

BitArray

Bit array

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

Constructor Summary

Public Constructor
public	constructor(length: Integer, setAll: Boolean)

Member Summary

Public Members
public	length

Private Members
private	_words

Method Summary

Public Methods
public	clear(index: Integer): undefined Set value at index to false
public	clearAll(): BitArray Clear all bits of the array
public	clearBits(arguments: ...Integer): Boolean Clear bits at all given indices
public	clearRange(start: Integer, end: Integer): BitArray Clear bits of the given range
public	clone(): BitArray Clone this object
public	difference(otherBitarray: BitArray): BitArray Calculate difference betwen this and another bit array.
public	flip(index: Integer): undefined Flip value at index
public	flipAll(): BitArray Flip all the values in the array
public	forEach(callback: function(index: Integer, i: Integer)): undefined Iterate over all set bits in the array
public	get(index: Integer): Boolean Get value at index
public	getIntersectionSize(otherBitarray: BitArray): Integer Calculate the number of bits in common betwen this and another bit array.
public	getSize(): Integer How many set bits?
public	intersection(otherBitarray: BitArray): BitArray Calculate intersection betwen this and another bit array.
public	intersects(otherBitarray: BitArray): Boolean Test if there is any intersection betwen this and another bit array.
public	isAllClear(): Boolean Test if all bits in the array are clear
public	isAllSet(): Boolean Test if all bits in the array are set
public	isClear(arguments: ...Integer): Boolean Test if bits at all given indices are clear
public	isEqualTo(otherBitarray: BitArray): Boolean Test if two BitArrays are identical in all their values
public	isRangeClear(start: Integer, end: Integer): BitArray Test if bits in given range are clear
public	isRangeSet(start: Integer, end: Integer): BitArray Test if bits in given range are set
public	isSet(arguments: ...Integer): Boolean Test if bits at all given indices are set
public	makeIntersection(otherBitarray: BitArray): BitArray Calculate intersection betwen this and another bit array.
public	set(index: Integer): undefined Set value at index to true
public	setAll(): BitArray Set all bits of the array
public	setBits(arguments: ...Integer): Boolean Set bits at all given indices
public	setRange(start: Integer, end: Integer): BitArray Set bits of the given range
public	toArray(): Array Get an array with the set bits
public	toSeleString()
public	toString()
public	union(otherBitarray: BitArray): BitArray Calculate union betwen this and another bit array.

Private Methods
private	_assignRange()
private	_isRangeValue()

Public Constructors

public constructor(length: Integer, setAll: Boolean) source

Params:

Name	Type	Attribute	Description
length	Integer		array length
setAll	Boolean	optional	initialize with true

Public Members

public length source

Private Members

private _words source

Public Methods

public clear(index: Integer): undefined source

Set value at index to false

Params:

Name	Type	Attribute	Description
index	Integer		the index

Return:

public clearAll(): BitArray source

Clear all bits of the array

Return:

this object

public clearBits(arguments: ...Integer): Boolean source

Clear bits at all given indices

Params:

Name	Type	Attribute	Description
arguments	...Integer		indices

Return:

this object

public clearRange(start: Integer, end: Integer): BitArray source

Clear bits of the given range

Params:

Name	Type	Attribute	Description
start	Integer		start index
end	Integer		end index

Return:

this object

public clone(): BitArray source

Clone this object

Return:

the cloned object

public difference(otherBitarray: BitArray): BitArray source

Calculate difference betwen this and another bit array. Store result in this object.

Params:

Name	Type	Attribute	Description
otherBitarray	BitArray		the other bit array

Return:

this object

public flip(index: Integer): undefined source

Flip value at index

Params:

Name	Type	Attribute	Description
index	Integer		the index

Return:

public flipAll(): BitArray source

Flip all the values in the array

Return:

this object

public forEach(callback: function(index: Integer, i: Integer)): undefined source

Iterate over all set bits in the array

Params:

Name	Type	Attribute	Description
callback	function(index: Integer, i: Integer)		the callback

Return:

public get(index: Integer): Boolean source

Get value at index

Params:

Name	Type	Attribute	Description
index	Integer		the index

Return:

value

public getIntersectionSize(otherBitarray: BitArray): Integer source

Calculate the number of bits in common betwen this and another bit array.

Params:

Name	Type	Attribute	Description
otherBitarray	BitArray		the other bit array

Return:

size

public getSize(): Integer source

How many set bits?

Return:

number of set bits

public intersection(otherBitarray: BitArray): BitArray source

Calculate intersection betwen this and another bit array. Store result in this object.

Params:

Name	Type	Attribute	Description
otherBitarray	BitArray		the other bit array

Return:

this object

public intersects(otherBitarray: BitArray): Boolean source

Test if there is any intersection betwen this and another bit array.

Params:

Name	Type	Attribute	Description
otherBitarray	BitArray		the other bit array

Return:

test result

public isAllClear(): Boolean source

Test if all bits in the array are clear

Return:

test result

public isAllSet(): Boolean source

Test if all bits in the array are set

Return:

test result

public isClear(arguments: ...Integer): Boolean source

Test if bits at all given indices are clear

Params:

Name	Type	Attribute	Description
arguments	...Integer		indices

Return:

test result

public isEqualTo(otherBitarray: BitArray): Boolean source

Test if two BitArrays are identical in all their values

Params:

Name	Type	Attribute	Description
otherBitarray	BitArray		the other BitArray

Return:

test result

public isRangeClear(start: Integer, end: Integer): BitArray source

Test if bits in given range are clear

Params:

Name	Type	Attribute	Description
start	Integer		start index
end	Integer		end index

Return:

this object

public isRangeSet(start: Integer, end: Integer): BitArray source

Test if bits in given range are set

Params:

Name	Type	Attribute	Description
start	Integer		start index
end	Integer		end index

Return:

this object

public isSet(arguments: ...Integer): Boolean source

Test if bits at all given indices are set

Params:

Name	Type	Attribute	Description
arguments	...Integer		indices

Return:

test result

public makeIntersection(otherBitarray: BitArray): BitArray source

Calculate intersection betwen this and another bit array. Store result in a new bit array.

Params:

Name	Type	Attribute	Description
otherBitarray	BitArray		the other bit array

Return:

the new bit array

public set(index: Integer): undefined source

Set value at index to true

Params:

Name	Type	Attribute	Description
index	Integer		the index

Return:

public setAll(): BitArray source

Set all bits of the array

Return:

this object

public setBits(arguments: ...Integer): Boolean source

Set bits at all given indices

Params:

Name	Type	Attribute	Description
arguments	...Integer		indices

Return:

this object

public setRange(start: Integer, end: Integer): BitArray source

Set bits of the given range

Params:

Name	Type	Attribute	Description
start	Integer		start index
end	Integer		end index

Return:

this object

public toArray(): Array source

Get an array with the set bits

Return:

bit indices

public toSeleString() source

public toString() source

public union(otherBitarray: BitArray): BitArray source

Calculate union betwen this and another bit array. Store result in this object.

Params:

Name	Type	Attribute	Description
otherBitarray	BitArray		the other bit array

Return:

this object

Private Methods

private _assignRange() source

private _isRangeValue() source