66 lines
2.5 KiB
Markdown
66 lines
2.5 KiB
Markdown
# bitset
|
|
|
|
*Go language library to map between non-negative integers and boolean values*
|
|
|
|
[](https://github.com/willf/bitset/tree/master)
|
|
[](https://travis-ci.org/willf/bitset)
|
|
[](https://github.com/willf/bitset/tree/develop)
|
|
[](https://travis-ci.org/willf/bitset?branch=develop)
|
|
|
|
|
|
|
|
## Description
|
|
|
|
Package bitset implements bitsets, a mapping between non-negative integers and boolean values.
|
|
It should be more efficient than map[uint] bool.
|
|
|
|
It provides methods for setting, clearing, flipping, and testing individual integers.
|
|
|
|
But it also provides set intersection, union, difference, complement, and symmetric operations, as well as tests to check whether any, all, or no bits are set, and querying a bitset's current length and number of postive bits.
|
|
|
|
BitSets are expanded to the size of the largest set bit; the memory allocation is approximately Max bits, where Max is the largest set bit. BitSets are never shrunk. On creation, a hint can be given for the number of bits that will be used.
|
|
|
|
Many of the methods, including Set, Clear, and Flip, return a BitSet pointer, which allows for chaining.
|
|
|
|
### Example use:
|
|
|
|
import "bitset"
|
|
var b BitSet
|
|
b.Set(10).Set(11)
|
|
if b.Test(1000) {
|
|
b.Clear(1000)
|
|
}
|
|
for i,e := v.NextSet(0); e; i,e = v.NextSet(i + 1) {
|
|
frmt.Println("The following bit is set:",i);
|
|
}
|
|
if B.Intersection(bitset.New(100).Set(10)).Count() > 1 {
|
|
fmt.Println("Intersection works.")
|
|
}
|
|
|
|
As an alternative to BitSets, one should check out the 'big' package, which provides a (less set-theoretical) view of bitsets.
|
|
|
|
Discussions golang-nuts Google Group:
|
|
|
|
* [Revised BitSet](https://groups.google.com/forum/#!topic/golang-nuts/5i3l0CXDiBg)
|
|
* [simple bitset?](https://groups.google.com/d/topic/golang-nuts/7n1VkRTlBf4/discussion)
|
|
|
|
Godoc documentation is at: https://godoc.org/github.com/willf/bitset
|
|
|
|
|
|
## Getting started
|
|
|
|
This application is written in the go language, please refer to the guides in https://golang.org for getting started.
|
|
|
|
This project include a Makefile that allows you to test and build the project with simple commands.
|
|
To see all available options:
|
|
```bash
|
|
make help
|
|
```
|
|
|
|
## Running all tests
|
|
|
|
Before committing the code, please check if it passes all tests using
|
|
```bash
|
|
make qa
|
|
```
|