BitSet.js is a infinite Bit-Array implementation in JavaScript. That means that if you invert a bit vector, the leading ones get remembered. As far as I can tell, BitSet.js is the only library which has this feature. It is also heavily benchmarked against other implementations and is the fastest implementation to date.
NOTE: As of version v4.0.0, BitSet.js is mutable, which means that the object gets changed by method invocations. In order to work on explicit copies, use clone()
.
var bs = new BitSet;
bs.set(128, 1); // Set bit at position 128
console.log(bs.toString(16)); // Print out a hex dump with one bit set
var bs = new BitSet;
bs
.flip(0, 62)
.flip(29, 35);
var str = bs.toString();
if (str === "111111111111111111111111111000000011111111111111111111111111111") {
console.log("YES!");
}
var bs = new BitSet;
bs.setRange(10, 18, 1); // Set a 1 between 10 and 18, inclusive
If you want to store user permissions in your database and use BitSet for the bit twiddling, you can start with the following Linux-style snippet:
var P_READ = 2; // Bit pos
var P_WRITE = 1;
var P_EXEC = 0;
var user = new BitSet;
user.set(P_READ); // Give read perms
user.set(P_WRITE); // Give write perms
var group = new BitSet(P_READ);
var world = new BitSet(P_EXEC);
console.log("0" + user.toString(8) + group.toString(8) + world.toString(8));
npm install --save bitset.js
or
bower install bitset.js
<script src="bitset.js"></script>
<script>
console.log(BitSet("111"));
</script>
<script src="require.js"></script>
<script>
requirejs(['bitset.js'],
function(BitSet) {
console.log(BitSet("1111"));
});
</script>
The parser accepts the following types of values in either function
Strings
- Binary strings "010101"
- Binary strings with prefix "0b100101"
- Hexadecimal strings with prefix "0xaffe"
Arrays
- The values of the array are the indizes to be set to 1
Uint8Array
- A binary representation in 8 bit form
Number
- A binary value
BitSet
- A BitSet object, which get copied over
The data type Mixed can be either a BitSet object, a String or an integer representing a native bitset with 31 bits.
Sets value 0 or 1 to index ndx
of the betset
Gets the value at index ndx
Helper function for set, to set an entire range to a given value
Sets a portion of a given bitset to zero
- If no param is given, the whole bitset gets cleared
- If one param is given, the bit at this index gets cleared
- If two params are given, the range is cleared
Extracts a portion of a given bitset as a new bitset
- If no param is given, the bitset is getting cloned
- If one param is given, the index is used as offset
- If two params are given, the range is returned as new BitSet
Toggles a portion of a given bitset
- If no param is given, the bitset is inverted
- If one param is given, the bit at the index is toggled
- If two params are given, the bits in the given range are toggled
Calculates the bitwise not
Calculates the bitwise and between two bitsets
Calculates the bitwise or between two bitsets
Calculates the bitwise xor between two bitsets
Calculates the bitwise andNot between two bitsets (this is not the nand operation!)
Clones the actual object
Returns an array with all indexes set in the bitset
Returns a string representation with respect to the base
Calculates the number of bits set
Calculates the most significant bit (the left most)
Calculates the number of trailing zeros (zeros on the right)
Calculates the least significant bit (the right most)
Checks if the bitset has all bits set to zero
Checks if two bitsets are the same
Alternative constructor to pass with a binary string
Alternative constructor to pass a hex string
As every library I publish, bitset.js is also built to be as small as possible after compressing it with Google Closure Compiler in advanced mode. Thus the coding style orientates a little on maxing-out the compression rate. Please make sure you keep this style if you plan to extend the library.
Gulp is optional for minifying with Google Closure Compiler. After cloning the Git repository, do:
npm install
gulp
Testing the source against the shipped test suite is as easy as
npm test