# bit-vector

> Simple, fast bit vectors for javascript. Useful in place of objects where performance is extremely important and your keys are all iteger convertible values)

Latest version **0.1.6** (published 2016-01-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install bit-vector
pnpm add bit-vector
yarn add bit-vector
bun add bit-vector
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2016-01-10 |
| First published | 2015-11-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Maintainers | ashaffer88 |

## Links

- npm: https://www.npmjs.com/package/bit-vector
- Repository: https://github.com/ashaffer/bit-vector
- Homepage: https://github.com/ashaffer/bit-vector#readme
- Issues: https://github.com/ashaffer/bit-vector/issues
- npm.io page: https://npm.io/package/bit-vector

## Recent versions

- 0.1.6 (latest) — 2016-01-10
- 0.1.4 — 2016-01-10
- 0.1.5 — 2016-01-05
- 0.1.3 — 2016-01-05
- 0.1.2 — 2016-01-04
- 0.1.1 — 2015-11-04
- 0.1.0 — 2015-11-04

## README

# bit-vector

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

Simple, fast bit vectors for javascript.  Useful in place of object maps where performance is extremely important and your keys are all integers or integer convertible values that lie within a relatively narrow range.

## Installation

    $ npm install bit-vector

## Usage

This package exports four functions:

  * `createBv(sizeInBits)` - Creates a bit vector with the number of bits you want.  Returns an array or typed array (depending on your environment) of length: `Math.ceil(sizeInBits / 32)`.
  * `setBit(bv, idx)` - Set the bit at `idx` position in the vector
  * `clearBit(bv, idx)` - Clear the bit at `idx` position in the vector
  * `getBit(bv, idx)` - Retrieve the bit as a boolean value at `idx` position in the vector

That's it for now.

## Performance

On v8 this is about twice as fast as the equivalent operation using an object.  Here's the [jsperf](http://jsperf.com/bit-vector-vs-object/2).  It is obviously also substantially more memory-efficient.  On v8 in particular it should be substantially faster when you need to frequently delete keys, since this puts v8 objects into 'dictionary mode' which is substantially slower.

  * Chrome - ~2x faster than objects
  * Safari - 2-3x faster
  * Firefox - 40x faster

## License

The MIT License

Copyright © 2015, Weo.io <info@weo.io>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---
_Source: https://npm.io/package/bit-vector · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._