bitmap

README

Bitmap

Yet another bitmap implementation written in go.

Installation

$ go get -v github.com/f1monkey/bitmap

Usage

func main() {
    var b bitmap.Bitmap

    b.IsEmpty() // true

    b.Set(0)
    b.Has(0) // true
    b.Remove(0)
    b.Has(0) // false

    b.Xor(1000)
    b.Has(1000) // true
    b.Xor(1000)
    b.Has(1000) // false

    b2 := b.Clone() // copy of "b"

    b2.Range(func(n uint32) bool {
        fmt.PrintLn(n)
        return true
    })

    // to string, from string
    var b3 bitmap.Bitmap
    b3.Set(1)
    b3.Set(100)
    b3.String() // "2|68719476736"
    b4, err := bitmap.FromString("2|68719476736")

    // Bitmap32 is backed by []uint32 slice
    // Everything else is all the same
    var b32 bitmap.Bitmap32
}

Documentation

Index

• type Bitmap
  • func FromString(str string) (Bitmap, error)
  • func (b *Bitmap) Clone() Bitmap
  • func (b *Bitmap) CountDiff(b2 Bitmap) int
  • func (b *Bitmap) Has(n uint32) bool
  • func (b *Bitmap) IsEmpty() bool
  • func (b *Bitmap) Range(f func(n uint32) bool)
  • func (b *Bitmap) Remove(n uint32)
  • func (b *Bitmap) Set(n uint32)
  • func (b *Bitmap) String() string
  • func (b *Bitmap) Xor(n uint32)
• type Bitmap32
  • func FromString32(str string) (Bitmap32, error)
  • func (b *Bitmap32) Clone() Bitmap32
  • func (b *Bitmap32) CountDiff(b2 Bitmap32) int
  • func (b *Bitmap32) Has(n uint32) bool
  • func (b *Bitmap32) IsEmpty() bool
  • func (b *Bitmap32) Range(f func(n uint32) bool)
  • func (b *Bitmap32) Remove(n uint32)
  • func (b *Bitmap32) Set(n uint32)
  • func (b *Bitmap32) String() string
  • func (b *Bitmap32) Xor(n uint32)

Types

type Bitmap

type Bitmap []uint64

func FromString

func FromString(str string) (Bitmap, error)

func (*Bitmap) Clone

func (b *Bitmap) Clone() Bitmap

Clone create a copy of the bitmap

func (*Bitmap) CountDiff

func (b *Bitmap) CountDiff(b2 Bitmap) int

CountDiff count different bits in two bitmaps

func (*Bitmap) Has

func (b *Bitmap) Has(n uint32) bool

Has check if n-th bit is set to 1

func (*Bitmap) IsEmpty

func (b *Bitmap) IsEmpty() bool

IsEmpty check if the bitmap has any bit set to 1

func (*Bitmap) Range

func (b *Bitmap) Range(f func(n uint32) bool)

Range call the passed callback with all bits set to 1. If the callback returns false, the method exits

func (*Bitmap) Remove

func (b *Bitmap) Remove(n uint32)

Remove set n-th bit to 0

func (*Bitmap) Set

func (b *Bitmap) Set(n uint32)

Set set n-th bit to 1

func (*Bitmap) String

func (b *Bitmap) String() string

func (*Bitmap) Xor

func (b *Bitmap) Xor(n uint32)

Xor invert n-th bit

type Bitmap32

type Bitmap32 []uint32

func FromString32

func FromString32(str string) (Bitmap32, error)

func (*Bitmap32) Clone

func (b *Bitmap32) Clone() Bitmap32

Clone create a copy of the bitmap

func (*Bitmap32) CountDiff

func (b *Bitmap32) CountDiff(b2 Bitmap32) int

CountDiff count different bits in two bitmaps

func (*Bitmap32) Has

func (b *Bitmap32) Has(n uint32) bool

Has check if n-th bit is set to 1

func (*Bitmap32) IsEmpty

func (b *Bitmap32) IsEmpty() bool

IsEmpty check if the bitmap has any bit set to 1

func (*Bitmap32) Range

func (b *Bitmap32) Range(f func(n uint32) bool)

Range call the passed callback with all bits set to 1. If the callback returns false, the method exits

func (*Bitmap32) Remove

func (b *Bitmap32) Remove(n uint32)

Remove set n-th bit to 0

func (*Bitmap32) Set

func (b *Bitmap32) Set(n uint32)

Set set n-th bit to 1

func (*Bitmap32) String

func (b *Bitmap32) String() string

func (*Bitmap32) Xor

func (b *Bitmap32) Xor(n uint32)

Xor invert n-th bit