https://github.com/karpeleslab/bitmap

Bitmap manipulation in Go
https://github.com/karpeleslab/bitmap

bitmap bitset golang

Last synced: 9 months ago
JSON representation

Bitmap manipulation in Go

• Host: GitHub
• URL: https://github.com/karpeleslab/bitmap
• Owner: KarpelesLab
• Created: 2019-12-29T14:57:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-12-29T16:59:05.000Z (over 6 years ago)
• Last Synced: 2025-07-01T00:09:02.362Z (12 months ago)
• Topics: bitmap, bitset, golang
• Language: Go
• Size: 8.79 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/KarpelesLab/bitmap.svg)](https://travis-ci.org/KarpelesLab/bitmap)

[![GoDoc](https://godoc.org/github.com/KarpelesLab/bitmap?status.svg)](https://godoc.org/github.com/KarpelesLab/bitmap)

[![Coverage Status](https://coveralls.io/repos/github/KarpelesLab/bitmap/badge.svg?branch=master)](https://coveralls.io/github/KarpelesLab/bitmap?branch=master)

# Bitmap

Simple bitmaps in Go.

Provides the following methods on bitmap objects:

* Get(bit int)

* Set(bit int, value bool)

* Toggle(bit)

* GetAtomic(bit int)

* SetAtomic(bit int, value bool)

* ToggleAtomic(bit int)

## Example

```Go

	m := bitmap.New(127)

	m.Set(42, true)

	if m.Get(42) {

		// OK

	}

```

# Why?

There are already a few bitmap implementations in Go available out there, however they have some shortfalls and/or are too complex for what a bitmap should do.

* [boljen's go-bitmap](https://godoc.org/github.com/boljen/go-bitmap) has separate implementations for Bitmap/Concurrent/Threadsafe, and complexifies a lot what should be very simple.

* [ShawnMilo's bitmap](https://www.godoc.org/github.com/ShawnMilo/bitmap) has a nice feel but lacks atomic methods and adds string methods using json/gzip/base64 (?)

* [Roaring Bitmaps](https://godoc.org/github.com/RoaringBitmap/roaring) are simply too complex for what I need bitmaps for. You should however definitely use that if you store more than 200k bits or so in total.