Firestore v1 API - Class BloomFilter (3.9.0)

public sealed class BloomFilter : IMessage<BloomFilter>, IEquatable<BloomFilter>, IDeepCloneable<BloomFilter>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class BloomFilter.

A bloom filter (https://en.wikipedia.org/wiki/Bloom_filter).

The bloom filter hashes the entries with MD5 and treats the resulting 128-bit hash as 2 distinct 64-bit hash values, interpreted as unsigned integers using 2's complement encoding.

These two hash values, named h1 and h2, are then used to compute the hash_count hash values using the formula, starting at i=0:

h(i) = h1 + (i * h2)

These resulting values are then taken modulo the number of bits in the bloom filter to get the bits of the bloom filter to test for the given entry.

Inheritance

object > BloomFilter

Implements

IMessage BloomFilter, IEquatable BloomFilter, IDeepCloneable BloomFilter, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

BloomFilter()

public BloomFilter()

BloomFilter(BloomFilter)

public BloomFilter(BloomFilter other)

Parameter
Name	Description
`other`	`BloomFilter`

Properties

Bits

public BitSequence Bits { get; set; }

The bloom filter data.

Property Value
Type	Description
`BitSequence`

HashCount

public int HashCount { get; set; }

The number of hashes used by the algorithm.

Property Value
Type	Description
`int`