Class EliasFanoDocIdSet

A DocIdSet in Elias-Fano encoding.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Inheritance
System.Object
DocIdSet
EliasFanoDocIdSet
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Util.Packed
Assembly: Lucene.Net.dll
Syntax
public class EliasFanoDocIdSet : DocIdSet

Constructors

| Improve this Doc View Source

EliasFanoDocIdSet(Int32, Int32)

Construct an EliasFanoDocIdSet. For efficient encoding, the parameters should be chosen as low as possible.

Declaration
public EliasFanoDocIdSet(int numValues, int upperBound)
Parameters
Type Name Description
System.Int32 numValues

At least the number of document ids that will be encoded.

System.Int32 upperBound

At least the highest document id that will be encoded.

Properties

| Improve this Doc View Source

IsCacheable

This DocIdSet implementation is cacheable.

Declaration
public override bool IsCacheable { get; }
Property Value
Type Description
System.Boolean

true

Overrides

Methods

| Improve this Doc View Source

EncodeFromDisi(DocIdSetIterator)

Encode the document ids from a DocIdSetIterator.

Declaration
public virtual void EncodeFromDisi(DocIdSetIterator disi)
Parameters
Type Name Description
DocIdSetIterator disi

This DocIdSetIterator should provide document ids that are consistent with numValues and upperBound as provided to the constructor.

| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
System.Object other
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()
| Improve this Doc View Source

GetIterator()

Provides a DocIdSetIterator to access encoded document ids.

Declaration
public override DocIdSetIterator GetIterator()
Returns
Type Description
DocIdSetIterator
Overrides
| Improve this Doc View Source

SufficientlySmallerThanBitSet(Int64, Int64)

Provide an indication that is better to use an EliasFanoDocIdSet than a FixedBitSet to encode document identifiers.

Declaration
public static bool SufficientlySmallerThanBitSet(long numValues, long upperBound)
Parameters
Type Name Description
System.Int64 numValues

The number of document identifiers that is to be encoded. Should be non negative.

System.Int64 upperBound

The maximum possible value for a document identifier. Should be at least numValues.

Returns
Type Description
System.Boolean

See SufficientlySmallerThanBitSet(Int64, Int64)