Class EliasFanoDecoder

A decoder for an EliasFanoEncoder.

@lucene.internal

Inheritance
System.Object
EliasFanoDecoder
Assembly: DistributedLucene.Net.dll
Syntax
public class EliasFanoDecoder : object

Constructors

Name Description
EliasFanoDecoder(EliasFanoEncoder)

Construct a decoder for a given EliasFanoEncoder. The decoding index is set to just before the first encoded value.

Fields

Name Description
NO_MORE_VALUES

Properties

Name Description
EliasFanoEncoder
NumEncoded

The number of values encoded by the encoder.

Methods

Name Description
AdvanceToIndex(Int64)

Advance the decoding index to a given index. and return true iff it is available.

See also CurrentValue().

The current implementation does not use the index on the upper bit zero bit positions.

Note: there is currently no implementation of BackToIndex().
AdvanceToValue(Int64)

Given a target value, advance the decoding index to the first bigger or equal value and return it if it is available. Otherwise return NO_MORE_VALUES.

The current implementation uses the index on the upper zero bit positions.
BackToValue(Int64)

Given a target value, go back to the first smaller or equal value and return it if it is available. Otherwise return NO_MORE_VALUES.

The current implementation does not use the index on the upper zero bit positions.
CurrentIndex()

The current decoding index. The first value encoded by EncodeNext(Int64) has index 0. Only valid directly after NextValue(), AdvanceToValue(Int64), PreviousValue(), or BackToValue(Int64) returned another value than NO_MORE_VALUES, or AdvanceToIndex(Int64) returned true.

CurrentValue()

The value at the current decoding index. Only valid when CurrentIndex() would return a valid result.

This is only intended for use after AdvanceToIndex(Int64) returned true.

NextValue()

If another value is available after the current decoding index, return this value and and increase the decoding index by 1. Otherwise return NO_MORE_VALUES.
PreviousValue()

If another value is available before the current decoding index, return this value and decrease the decoding index by 1. Otherwise return NO_MORE_VALUES.
ToAfterSequence()

Set the decoding index to just after the last encoded value.
ToBeforeSequence()

Set the decoding index to just before the first encoded value.

Extension Methods