Reference documentation and code samples for the Cloud Firestore V1 Client 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.
Generated from protobuf message google.firestore.v1.BloomFilter
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ bits |
Google\Cloud\Firestore\V1\BitSequence
The bloom filter data. |
↳ hash_count |
int
The number of hashes used by the algorithm. |
getBits
The bloom filter data.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\BitSequence|null | |
hasBits
clearBits
setBits
The bloom filter data.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\BitSequence
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHashCount
The number of hashes used by the algorithm.
| Returns | |
|---|---|
| Type | Description |
int | |
setHashCount
The number of hashes used by the algorithm.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |