bloomfilter

Documentation

Overview

Licensed to the LF AI & Data foundation under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• Variables
• func Locations(data []byte, k uint, bfType BFType) []uint64
• type BFType
  • func BFTypeFromString(name string) BFType
  • func (t BFType) String() string
• type BloomFilterInterface
  • func NewBloomFilterWithType(capacity uint, fp float64, typeName string) BloomFilterInterface
  • func UnmarshalJSON(data []byte, bfType BFType) (BloomFilterInterface, error)

Constants

const (
	UnsupportedBFName = "Unsupported BloomFilter"
	BlockBFName       = "BlockedBloomFilter"
	BasicBFName       = "BasicBloomFilter"
	AlwaysTrueBFName  = "AlwaysTrueBloomFilter"
)

Variables

var AlwaysTrueBloomFilter = &alwaysTrueBloomFilter{}

Functions

func Locations

func Locations(data []byte, k uint, bfType BFType) []uint64

Types

type BFType

type BFType int

const (
	UnsupportedBF BFType = iota + 1
	AlwaysTrueBF         // empty bloom filter
	BasicBF
	BlockedBF
)

func BFTypeFromString

func BFTypeFromString(name string) BFType

func (BFType) String

func (t BFType) String() string

type BloomFilterInterface

type BloomFilterInterface interface {
	Type() BFType
	Cap() uint
	K() uint
	Add(data []byte)
	AddString(data string)
	Test(data []byte) bool
	TestString(data string) bool
	TestLocations(locs []uint64) bool
	BatchTestLocations(locs [][]uint64, hit []bool) []bool
	MarshalJSON() ([]byte, error)
	UnmarshalJSON(data []byte) error
}

func NewBloomFilterWithType

func NewBloomFilterWithType(capacity uint, fp float64, typeName string) BloomFilterInterface

func UnmarshalJSON

func UnmarshalJSON(data []byte, bfType BFType) (BloomFilterInterface, error)