Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class DefaultBloomFilterFactory

    Default policy is to allocate a bitset with 10% saturation given a unique term per document. Bits are set via MurmurHash2 hashing function.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Inheritance
    object
    BloomFilterFactory
    DefaultBloomFilterFactory
    Inherited Members
    BloomFilterFactory.Downsize(FieldInfo, FuzzySet)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Codecs.Bloom
    Assembly: Lucene.Net.Codecs.dll
    Syntax
    public class DefaultBloomFilterFactory : BloomFilterFactory

    Methods

    GetSetForField(SegmentWriteState, FieldInfo)

    Default policy is to allocate a bitset with 10% saturation given a unique term per document. Bits are set via MurmurHash2 hashing function.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Declaration
    public override FuzzySet GetSetForField(SegmentWriteState state, FieldInfo info)
    Parameters
    Type Name Description
    SegmentWriteState state

    The content to be indexed.

    FieldInfo info

    The field requiring a BloomFilter.

    Returns
    Type Description
    FuzzySet

    An appropriately sized set or null if no BloomFiltering required.

    Overrides
    BloomFilterFactory.GetSetForField(SegmentWriteState, FieldInfo)

    IsSaturated(FuzzySet, FieldInfo)

    Used to determine if the given filter has reached saturation and should be retired i.e. not saved any more.

    Declaration
    public override bool IsSaturated(FuzzySet bloomFilter, FieldInfo fieldInfo)
    Parameters
    Type Name Description
    FuzzySet bloomFilter

    The bloomFilter being tested.

    FieldInfo fieldInfo

    The field with which this filter is associated.

    Returns
    Type Description
    bool

    true if the set has reached saturation and should be retired.

    Overrides
    BloomFilterFactory.IsSaturated(FuzzySet, FieldInfo)
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.