ro2

Documentation

Index

• Constants
• Variables
• func Apply(ra *Bitmap, filter roaring.BitmapFilter) error
• func DecodeContainer(value []byte) *roaring.Container
• func EncodeContainer(c *roaring.Container) []byte
• func LastValue(value []byte) uint16
• func ReadDistinctBSI(ra Reader, shard uint64, filterBitmap *Bitmap) *roaring.Bitmap
• func ReadMutex(ra Reader, shard uint64, filterBitmap *Bitmap, ...)
• func ReadSum(ra Reader, match *Bitmap) (count int32, total int64)
• func WriteBSI(ra *Bitmap, id uint64, svalue int64)
• func WriteBool(ra *Bitmap, id uint64, value bool)
• func WriteMutex(ra *Bitmap, id uint64, value uint64)
• type Bitmap
  • func Existence(tx OffsetRanger, shard uint64) *Bitmap
  • func Range(tx OffsetRanger, op OP, shard, bitDepth uint64, predicate, end int64) *Bitmap
  • func ReadFalse(ra Reader, shard uint64, match *Bitmap) *Bitmap
  • func ReadTrue(ra Reader, shard uint64, match *Bitmap) *Bitmap
  • func Row(ra OffsetRanger, shard, rowID uint64) *Bitmap
• type BitmapRowsUnion
• type ContainerType
• type Merger
  • func (m *Merger) Finish(includesBase bool) ([]byte, io.Closer, error)
  • func (m *Merger) MergeNewer(value []byte) error
  • func (m *Merger) MergeOlder(value []byte) error
• type OP
• type OffsetRanger
• type Reader

Constants

const (
	// ArrayMaxSize represents the maximum size of array containers.
	// This is sligtly less than roaring to accommodate the page header.
	ArrayMaxSize = 4079

	// RLEMaxSize represents the maximum size of run length encoded containers.
	RLEMaxSize = 2039
)

Variables

var Merge = &pebble.Merger{
	Name: "pilosa.RoaringBitmap",
	Merge: func(key, value []byte) (pebble.ValueMerger, error) {
		co := DecodeContainer(value).Clone()
		return (*Merger)(co), nil
	},
}

var NewBitmap = roaring.NewBitmap

var NewBitmapBitmapFilter = roaring.NewBitmapBitmapFilter

var NewBitmapRowsUnion = roaring.NewBitmapRowsUnion

Functions

func Apply

func Apply(ra *Bitmap, filter roaring.BitmapFilter) error

func DecodeContainer

func DecodeContainer(value []byte) *roaring.Container

func EncodeContainer

func EncodeContainer(c *roaring.Container) []byte

func LastValue

func LastValue(value []byte) uint16

func ReadDistinctBSI

func ReadDistinctBSI(ra Reader, shard uint64, filterBitmap *Bitmap) *roaring.Bitmap

func ReadMutex

func ReadMutex(ra Reader, shard uint64, filterBitmap *Bitmap, match func(row uint64, ra *Bitmap))

func ReadSum

func ReadSum(ra Reader, match *Bitmap) (count int32, total int64)

func WriteBSI

func WriteBSI(ra *Bitmap, id uint64, svalue int64)

func WriteBool

func WriteBool(ra *Bitmap, id uint64, value bool)

func WriteMutex

func WriteMutex(ra *Bitmap, id uint64, value uint64)

Types

type Bitmap

type Bitmap = roaring.Bitmap

func Existence

func Existence(tx OffsetRanger, shard uint64) *Bitmap

func Range

func Range(tx OffsetRanger, op OP, shard, bitDepth uint64, predicate, end int64) *Bitmap

Range returns bitmaps with a bsiGroup value encoding matching the predicate.

func ReadFalse

func ReadFalse(ra Reader, shard uint64, match *Bitmap) *Bitmap

func ReadTrue

func ReadTrue(ra Reader, shard uint64, match *Bitmap) *Bitmap

func Row

func Row(ra OffsetRanger, shard, rowID uint64) *Bitmap

type BitmapRowsUnion

type BitmapRowsUnion = roaring.BitmapRowsUnion

type ContainerType

type ContainerType int

const (
	ContainerTypeArray ContainerType = 1 + iota
	ContainerTypeRLE
	ContainerTypeBitmap
)

Container types.

type Merger

type Merger roaring.Container

func (*Merger) Finish

func (m *Merger) Finish(includesBase bool) ([]byte, io.Closer, error)

func (*Merger) MergeNewer

func (m *Merger) MergeNewer(value []byte) error

func (*Merger) MergeOlder

func (m *Merger) MergeOlder(value []byte) error

type OP

type OP byte

const (
	EQ  OP = 1 + iota // ==
	NEQ               // !=
	LT                // <
	LTE               // <=
	GT                // >
	GTE               // >=

	BETWEEN // ><  (this is like a <= x <= b)
)

type OffsetRanger

type OffsetRanger interface {
	OffsetRange(offset, start, end uint64) *Bitmap
}

type Reader

type Reader interface {
	Seek(key uint64) bool
	Valid() bool
	Next() bool
	Value() (uint64, *roaring.Container)
	Max() uint64
	OffsetRange(offset, start, end uint64) *Bitmap
	ApplyFilter(key uint64, filter roaring.BitmapFilter) (err error)
}