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 Bitmap
  • func Sub(left, right *Bitmap) *Bitmap
  • func (me *Bitmap) Add(is ...int)
  • func (me *Bitmap) AddRange(begin, end int)
  • func (me *Bitmap) Clear()
  • func (me *Bitmap) Contains(i int) bool
  • func (me Bitmap) Copy() (ret Bitmap)
  • func (me *Bitmap) FlipRange(begin, end int)
  • func (me *Bitmap) Get(bit int) bool
  • func (me *Bitmap) Iter(f func(interface{}) bool)
  • func (me Bitmap) IterTyped(f func(int) bool) bool
  • func (me *Bitmap) Len() int
  • func (me *Bitmap) Remove(i int)
  • func (me *Bitmap) RemoveRange(begin, end int) *Bitmap
  • func (me *Bitmap) Set(bit int, value bool)
  • func (me *Bitmap) Sub(other *Bitmap)
  • func (me Bitmap) ToSortedSlice() (ret []int)
  • func (me *Bitmap) Union(other *Bitmap)
• type Iter
  • func (me *Iter) Next() bool
  • func (me *Iter) Stop()
  • func (me *Iter) Value() interface{}
  • func (me *Iter) ValueInt() int

Constants

const MaxInt = -1

Types

type Bitmap

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

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

func Sub

func Sub(left, right *Bitmap) *Bitmap

func (*Bitmap) Add

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

func (*Bitmap) AddRange

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

func (*Bitmap) Clear

func (me *Bitmap) Clear()

func (*Bitmap) Contains

func (me *Bitmap) Contains(i int) bool

func (Bitmap) Copy

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

func (*Bitmap) FlipRange

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

func (*Bitmap) Get

func (me *Bitmap) Get(bit int) bool

func (*Bitmap) Iter

func (me *Bitmap) Iter(f func(interface{}) bool)

func (Bitmap) IterTyped

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

func (*Bitmap) Len

func (me *Bitmap) Len() int

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

func (*Bitmap) Remove

func (me *Bitmap) Remove(i int)

func (*Bitmap) RemoveRange

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

func (*Bitmap) Set

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

func (*Bitmap) Sub

func (me *Bitmap) Sub(other *Bitmap)

func (Bitmap) ToSortedSlice

func (me Bitmap) ToSortedSlice() (ret []int)

func (*Bitmap) Union

func (me *Bitmap) Union(other *Bitmap)

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