bitmaskjs
v0.1.2
Published
A small package to convert integers to bit arrays and back, with some utilities
Downloads
57
Readme
#Bitmask.js A small package to convert integers to bit arrays and back, with some utilities
##Installation
Install with bower install bitmask
, then add the bitmask.min.js
script to your page. If you're using NodeJS, you can require
it instead!
##Usage Create a Bitmask object by passing either an integer value or a bit array to the constructor:
// Either
var myBitmask = new Bitmask(15);
// Or
var myBitmask = new Bitmask([1,1,1,1])
The constructor also accepts a second parameter that allows you to specifiy the padding (the length of the bit array). This value defaults to 8.
At any point you can retrieve the current value in its integer or array form, regardless of how you called the constructor, by using:
myBitmask.getInteger() // 15
myBitmask.getBits() // [1,1,1,1,0,0,0,0]
##Instance Methods
getInteger()
- returns the integer value of the current instancegetBits()
- returns the bit array representation of the current instancehasBit(index)
- returns true if the bit at the specified index is setsetBit(index, value)
- sets the bit at the specified index tovalue
(true
orfalse
)toggleBit(index)
- toggles the bit at the specified indexlShift(n)
- shifts the bit array to the left byn
positions (default is 1)rShift(n)
- shifts the bit array to the right byn
positions (default is 1)
The following methods are chainable: setBit
, toggleBit
, lShift
, rShift
.
##Contributing
You can edit the source in src/bitmask.js
and build it using grunt
. Remember to do an npm install
beforehand to install all the dev dependencies!