Class MultiLevelSkipListReader

This abstract class reads skip lists with multiple levels.

See MultiLevelSkipListWriter for the information about the encoding of the multi level skip lists.

Subclasses must implement the abstract method ReadSkipData(Int32, IndexInput) which defines the actual format of the skip data.

This is a Lucene.NET EXPERIMENTAL API, use at your own risk
Inheritance
System.Object
MultiLevelSkipListReader
Lucene40SkipListReader
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Codecs
Assembly: Lucene.Net.dll
Syntax
public abstract class MultiLevelSkipListReader : IDisposable

Constructors

| Improve this Doc View Source

MultiLevelSkipListReader(IndexInput, Int32, Int32)

Creates a MultiLevelSkipListReader, where Lucene.Net.Codecs.MultiLevelSkipListReader.skipInterval and Lucene.Net.Codecs.MultiLevelSkipListReader.skipMultiplier are the same.

Declaration
protected MultiLevelSkipListReader(IndexInput skipStream, int maxSkipLevels, int skipInterval)
Parameters
Type Name Description
IndexInput skipStream
System.Int32 maxSkipLevels
System.Int32 skipInterval
| Improve this Doc View Source

MultiLevelSkipListReader(IndexInput, Int32, Int32, Int32)

Creates a MultiLevelSkipListReader.

Declaration
protected MultiLevelSkipListReader(IndexInput skipStream, int maxSkipLevels, int skipInterval, int skipMultiplier)
Parameters
Type Name Description
IndexInput skipStream
System.Int32 maxSkipLevels
System.Int32 skipInterval
System.Int32 skipMultiplier

Fields

| Improve this Doc View Source

m_maxNumberOfSkipLevels

The maximum number of skip levels possible for this index.

Declaration
protected int m_maxNumberOfSkipLevels
Field Value
Type Description
System.Int32
| Improve this Doc View Source

m_skipDoc

Doc id of current skip entry per level.

Declaration
protected int[] m_skipDoc
Field Value
Type Description
System.Int32[]

Properties

| Improve this Doc View Source

Doc

Returns the id of the doc to which the last call of SkipTo(Int32) has skipped.

Declaration
public virtual int Doc { get; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

Dispose()

Disposes all resources used by this object.

Declaration
public void Dispose()
| Improve this Doc View Source

Dispose(Boolean)

Disposes all resources used by this object. Subclasses may override to dispose their own resources.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
| Improve this Doc View Source

Init(Int64, Int32)

Initializes the reader, for reuse on a new term.

Declaration
public virtual void Init(long skipPointer, int df)
Parameters
Type Name Description
System.Int64 skipPointer
System.Int32 df
| Improve this Doc View Source

ReadSkipData(Int32, IndexInput)

Subclasses must implement the actual skip data encoding in this method.

Declaration
protected abstract int ReadSkipData(int level, IndexInput skipStream)
Parameters
Type Name Description
System.Int32 level

The level skip data shall be read from.

IndexInput skipStream

The skip stream to read from.

Returns
Type Description
System.Int32
| Improve this Doc View Source

SeekChild(Int32)

Seeks the skip entry on the given level.

Declaration
protected virtual void SeekChild(int level)
Parameters
Type Name Description
System.Int32 level
| Improve this Doc View Source

SetLastSkipData(Int32)

Copies the values of the last read skip entry on this level.

Declaration
protected virtual void SetLastSkipData(int level)
Parameters
Type Name Description
System.Int32 level
| Improve this Doc View Source

SkipTo(Int32)

Skips entries to the first beyond the current whose document number is greater than or equal to target. Returns the current doc count.

Declaration
public virtual int SkipTo(int target)
Parameters
Type Name Description
System.Int32 target
Returns
Type Description
System.Int32

Implements

System.IDisposable

Extension Methods