bitmap

Documentation

Overview

Package bitmap provides a []bool/bitmap implementation with standardized iteration. Bitmaps are the equivalent of []bool, with improved compression for runs of similar values, and faster operations on ranges and the like.

Index

• Constants
• type BitIndex
• type BitRange
• type Bitmap
  • func Flip(bm Bitmap, start, end BitRange) Bitmap
  • func Sub(left, right Bitmap) Bitmap
  • func (me *Bitmap) Add(is ...BitIndex)
  • func (me *Bitmap) AddRange(begin, end BitRange)
  • func (me *Bitmap) Clear()
  • func (me Bitmap) Contains(i BitIndex) bool
  • func (me Bitmap) Copy() (ret Bitmap)
  • func (me *Bitmap) FlipRange(begin, end BitRange)
  • func (me Bitmap) Get(bit BitIndex) bool
  • func (me Bitmap) IsEmpty() bool
  • func (me Bitmap) Iter(cb iter.Callback)
  • func (me Bitmap) IterTyped(f func(int) bool) bool
  • func (me Bitmap) Len() BitRange
  • func (me *Bitmap) Remove(i BitIndex) bool
  • func (me *Bitmap) RemoveRange(begin, end BitRange) *Bitmap
  • func (me *Bitmap) Set(bit BitIndex, value bool)
  • func (me *Bitmap) Sub(other Bitmap)
  • func (me Bitmap) ToSortedSlice() []BitIndex
  • func (me *Bitmap) Union(other Bitmap)
• type Interface
• type Iter
  • func (me *Iter) Next() bool
  • func (me *Iter) Stop()
  • func (me *Iter) Value() interface{}
  • func (me *Iter) ValueInt() int

Constants

const (
	MaxInt BitIndex = roaring.MaxUint32
	ToEnd  BitRange = roaring.MaxRange
)

Types

type BitIndex

type BitIndex = uint32

type BitRange

type BitRange = uint64

type Bitmap

type Bitmap struct {
	RB *roaring.Bitmap
}

Bitmaps store the existence of values in [0,math.MaxUint32] more efficiently than []bool. The empty value starts with no bits set.

func Flip

func Flip(bm Bitmap, start, end BitRange) Bitmap

func Sub

func Sub(left, right Bitmap) Bitmap

func (*Bitmap) Add

func (me *Bitmap) Add(is ...BitIndex)

func (*Bitmap) AddRange

func (me *Bitmap) AddRange(begin, end BitRange)

func (*Bitmap) Clear

func (me *Bitmap) Clear()

func (Bitmap) Contains

func (me Bitmap) Contains(i BitIndex) bool

func (Bitmap) Copy

func (me Bitmap) Copy() (ret Bitmap)

func (*Bitmap) FlipRange

func (me *Bitmap) FlipRange(begin, end BitRange)

func (Bitmap) Get

func (me Bitmap) Get(bit BitIndex) bool

func (Bitmap) IsEmpty

func (me Bitmap) IsEmpty() bool

func (Bitmap) Iter

func (me Bitmap) Iter(cb iter.Callback)

func (Bitmap) IterTyped

func (me Bitmap) IterTyped(f func(int) bool) bool

Returns true if all values were traversed without early termination.

func (Bitmap) Len

func (me Bitmap) Len() BitRange

The number of set bits in the bitmap. Also known as cardinality.

func (*Bitmap) Remove

func (me *Bitmap) Remove(i BitIndex) bool

func (*Bitmap) RemoveRange

func (me *Bitmap) RemoveRange(begin, end BitRange) *Bitmap

func (*Bitmap) Set

func (me *Bitmap) Set(bit BitIndex, value bool)

func (*Bitmap) Sub

func (me *Bitmap) Sub(other Bitmap)

func (Bitmap) ToSortedSlice

func (me Bitmap) ToSortedSlice() []BitIndex

func (*Bitmap) Union

func (me *Bitmap) Union(other Bitmap)

type Interface

type Interface interface {
	Len() int
}

type Iter

type Iter struct {
	// contains filtered or unexported fields
}

func (*Iter) Next

func (me *Iter) Next() bool

func (*Iter) Stop

func (me *Iter) Stop()

func (*Iter) Value

func (me *Iter) Value() interface{}

func (*Iter) ValueInt

func (me *Iter) ValueInt() int