Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::BloomFilter (v1.0.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#bits

def bits() -> ::Google::Cloud::Firestore::V1::BitSequence
Returns

#bits=

def bits=(value) -> ::Google::Cloud::Firestore::V1::BitSequence
Parameter
Returns

#hash_count

def hash_count() -> ::Integer
Returns
  • (::Integer) — The number of hashes used by the algorithm.

#hash_count=

def hash_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The number of hashes used by the algorithm.
Returns
  • (::Integer) — The number of hashes used by the algorithm.