chris
746868d720
git-subtree-dir: main-site git-subtree-mainline: 4d1daa39101c0a85ca6d916f1c31139faf39632a git-subtree-split: 5cefb4d1618bc54ae0e86830421a8c911900302c
63 lines
1.7 KiB
Markdown
63 lines
1.7 KiB
Markdown
# sparse-bitfield
|
|
|
|
Bitfield implementation that allocates a series of 1kb buffers to support sparse bitfields
|
|
without allocating a massive buffer. If you want to simple implementation of a flat bitfield
|
|
see the [bitfield](https://github.com/fb55/bitfield) module.
|
|
|
|
This module is mostly useful if you need a big bitfield where you won't nessecarily set every bit.
|
|
|
|
```
|
|
npm install sparse-bitfield
|
|
```
|
|
|
|
[](http://travis-ci.org/mafintosh/sparse-bitfield)
|
|
|
|
## Usage
|
|
|
|
``` js
|
|
var bitfield = require('sparse-bitfield')
|
|
var bits = bitfield()
|
|
|
|
bits.set(0, true) // set first bit
|
|
bits.set(1, true) // set second bit
|
|
bits.set(1000000000000, true) // set the 1.000.000.000.000th bit
|
|
```
|
|
|
|
Running the above example will allocate two 1kb buffers internally.
|
|
Each 1kb buffer can hold information about 8192 bits so the first one will be used to store information about the first two bits and the second will be used to store the 1.000.000.000.000th bit.
|
|
|
|
## API
|
|
|
|
#### `var bits = bitfield([options])`
|
|
|
|
Create a new bitfield. Options include
|
|
|
|
``` js
|
|
{
|
|
pageSize: 1024, // how big should the partial buffers be
|
|
buffer: anExistingBitfield,
|
|
trackUpdates: false // track when pages are being updated in the pager
|
|
}
|
|
```
|
|
|
|
#### `bits.set(index, value)`
|
|
|
|
Set a bit to true or false.
|
|
|
|
#### `bits.get(index)`
|
|
|
|
Get the value of a bit.
|
|
|
|
#### `bits.pages`
|
|
|
|
A [memory-pager](https://github.com/mafintosh/memory-pager) instance that is managing the underlying memory.
|
|
If you set `trackUpdates` to true in the constructor you can use `.lastUpdate()` on this instance to get the last updated memory page.
|
|
|
|
#### `var buffer = bits.toBuffer()`
|
|
|
|
Get a single buffer representing the entire bitfield.
|
|
|
|
## License
|
|
|
|
MIT
|