BloomFilter

class BloomFilter : GeneratedMessage, BloomFilterOrBuilder
Defines a structure that is operable as a 1-to-n-layer Bloom filter. NIST (the National Institute of Standards and
Technology) defines a *"Bloom filter"* as a "data structure with a probabilistic algorithm to quickly test membership
in a large set using multiple hash functions into a single array of bits."

In essence, a Bloom filter is a very compact set of data, which operates kind of like a cheese cloth. For each unique
data fingerprint applied to the filter, you can imagine throwing colored die at the cheese cloth - what you end up
with is some blend of colors, which is entirely unique and ephemeral, having been constituted entirely by the colors
you chose, and the exact parameters of how you threw them. Albeit a contrived example, one could then imagine simply
examining the result of your work to determine the presence of different colors.

Bloom filters work the same way. Since their invention in by Burton Howard Bloom in 1970, many exotic forms of Bloom
filters have shown up, a few of which this structure supports. For example, one may choose to enhance regular filters
with the count of items considered in the filter, making it a *Counting Bloom filter*. Or, one may choose to combine
multiple filters into one effective filter, which is referred to as a *Layered Bloom filter*.
Protobuf type elide.structs.BloomFilter

Types

Link copied to clipboard
class Builder : GeneratedMessage.Builder<BuilderT> , BloomFilterOrBuilder
Defines a structure that is operable as a 1-to-n-layer Bloom filter. NIST (the National Institute of Standards and
Technology) defines a *"Bloom filter"* as a "data structure with a probabilistic algorithm to quickly test membership
in a large set using multiple hash functions into a single array of bits."

In essence, a Bloom filter is a very compact set of data, which operates kind of like a cheese cloth. For each unique
data fingerprint applied to the filter, you can imagine throwing colored die at the cheese cloth - what you end up
with is some blend of colors, which is entirely unique and ephemeral, having been constituted entirely by the colors
you chose, and the exact parameters of how you threw them. Albeit a contrived example, one could then imagine simply
examining the result of your work to determine the presence of different colors.

Bloom filters work the same way. Since their invention in by Burton Howard Bloom in 1970, many exotic forms of Bloom
filters have shown up, a few of which this structure supports. For example, one may choose to enhance regular filters
with the count of items considered in the filter, making it a *Counting Bloom filter*. Or, one may choose to combine
multiple filters into one effective filter, which is referred to as a *Layered Bloom filter*.
Protobuf type elide.structs.BloomFilter
Link copied to clipboard
Specifies a layer in a multi-layer Bloom filter. If no more than 1 layer is specified, the filter is a simple
single-layer bit set (also known as a regular Bloom filter).
Protobuf type elide.structs.BloomFilter.FilterLayer
Link copied to clipboard
interface FilterLayerOrBuilder : MessageOrBuilder

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
open fun equals(obj: Any): Boolean
Link copied to clipboard
Link copied to clipboard
Hash algorithm in use for this Bloom filter. This must be considered an immutable value for a constituted filter,
otherwise the underlying data may be rendered unusable.
.elide.std.HashAlgorithm algorithm = 1;
Link copied to clipboard
Hash algorithm in use for this Bloom filter. This must be considered an immutable value for a constituted filter,
otherwise the underlying data may be rendered unusable.
.elide.std.HashAlgorithm algorithm = 1;
Link copied to clipboard
open fun getAllFields(): Map<Descriptors.FieldDescriptor, Any>
Link copied to clipboard
open fun getCount(): Long
Number of items in the filter, across all layers.
uint64 count = 3;
Link copied to clipboard
Link copied to clipboard
abstract fun getDefaultInstanceForType(): MessageLite
Link copied to clipboard
fun getDescriptor(): Descriptors.Descriptor
Link copied to clipboard
open fun getDescriptorForType(): Descriptors.Descriptor
Link copied to clipboard
open fun getField(field: Descriptors.FieldDescriptor): Any
Link copied to clipboard
Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.
repeated .elide.structs.BloomFilter.FilterLayer layer = 5;
Link copied to clipboard
open fun getLayerCount(): Int
Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.
repeated .elide.structs.BloomFilter.FilterLayer layer = 5;
Link copied to clipboard
Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.
repeated .elide.structs.BloomFilter.FilterLayer layer = 5;
Link copied to clipboard
Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.
repeated .elide.structs.BloomFilter.FilterLayer layer = 5;
Link copied to clipboard
Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.
repeated .elide.structs.BloomFilter.FilterLayer layer = 5;
Link copied to clipboard
open fun getLimit(): Long
Limit setting to enforce for this Bloom filter, before re-calculating contents. Optional.
uint64 limit = 4;
Link copied to clipboard
open fun getOneofFieldDescriptor(oneof: Descriptors.OneofDescriptor): Descriptors.FieldDescriptor
Link copied to clipboard
abstract fun getParserForType(): Parser<out Message>
abstract fun getParserForType(): Parser<out MessageLite>
open fun getParserForType(): Parser<BloomFilter>
Link copied to clipboard
open fun getRepeatedField(field: Descriptors.FieldDescriptor, index: Int): Any
Link copied to clipboard
open fun getRepeatedFieldCount(field: Descriptors.FieldDescriptor): Int
Link copied to clipboard
open fun getRounds(): Int
Number of hash rounds to apply when adding data to this filter.
uint32 rounds = 2;
Link copied to clipboard
Link copied to clipboard
open fun getUnknownFields(): UnknownFieldSet
Link copied to clipboard
open fun hasField(field: Descriptors.FieldDescriptor): Boolean
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
open fun hasOneof(oneof: Descriptors.OneofDescriptor): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun <ContainingT : Message?, T> newFileScopedGeneratedExtension(singularType: Class<out Any>, defaultInstance: Message): GeneratedMessage.GeneratedExtension<ContainingT, T>
Link copied to clipboard
open fun <ContainingT : Message?, T> newMessageScopedGeneratedExtension(scope: Message, descriptorIndex: Int, singularType: Class<out Any>, defaultInstance: Message): GeneratedMessage.GeneratedExtension<ContainingT, T>
Link copied to clipboard
open fun parseDelimitedFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): BloomFilter
Link copied to clipboard
open fun parseFrom(data: Array<Byte>): BloomFilter
open fun parseFrom(data: ByteString): BloomFilter
open fun parseFrom(input: CodedInputStream): BloomFilter
open fun parseFrom(data: Array<Byte>, extensionRegistry: ExtensionRegistryLite): BloomFilter
open fun parseFrom(data: ByteString, extensionRegistry: ExtensionRegistryLite): BloomFilter
open fun parseFrom(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): BloomFilter
open fun parseFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): BloomFilter
open fun parseFrom(data: ByteBuffer, extensionRegistry: ExtensionRegistryLite): BloomFilter
Link copied to clipboard
open fun parser(): Parser<BloomFilter>
Link copied to clipboard
Link copied to clipboard
open fun toByteArray(): Array<Byte>
Link copied to clipboard
open fun toByteString(): ByteString
Link copied to clipboard
Link copied to clipboard
open fun writeDelimitedTo(output: OutputStream)
Link copied to clipboard
open fun writeTo(output: CodedOutputStream)