Class FSTEnum<T>

Can Next() and Advance() through the terms in an FST

Note

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

Inheritance
System.Object
FSTEnum<T>
BytesRefFSTEnum<T>
Int32sRefFSTEnum<T>
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.Util.Fst
Assembly: Lucene.Net.dll
Syntax
public abstract class FSTEnum<T>
    where T : class
Type Parameters
Name Description
T

Constructors

| Improve this Doc View Source

FSTEnum(FST<T>)

doFloor controls the behavior of advance: if it's true doFloor is true, advance positions to the biggest term before target.

Declaration
protected FSTEnum(FST<T> fst)
Parameters
Type Name Description
FST<T> fst

Fields

| Improve this Doc View Source

m_arcs

Declaration
protected FST.Arc<T>[] m_arcs
Field Value
Type Description
FST.Arc<T>[]
| Improve this Doc View Source

m_fst

Declaration
protected readonly FST<T> m_fst
Field Value
Type Description
FST<T>
| Improve this Doc View Source

m_fstReader

Declaration
protected readonly FST.BytesReader m_fstReader
Field Value
Type Description
FST.BytesReader
| Improve this Doc View Source

m_output

Declaration
protected T[] m_output
Field Value
Type Description
T[]
| Improve this Doc View Source

m_scratchArc

Declaration
protected readonly FST.Arc<T> m_scratchArc
Field Value
Type Description
FST.Arc<T>
| Improve this Doc View Source

m_targetLength

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

m_upto

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

NO_OUTPUT

Declaration
protected readonly T NO_OUTPUT
Field Value
Type Description
T

Properties

| Improve this Doc View Source

CurrentLabel

Declaration
protected abstract int CurrentLabel { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TargetLabel

Declaration
protected abstract int TargetLabel { get; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

DoNext()

Declaration
protected virtual void DoNext()
| Improve this Doc View Source

DoSeekCeil()

Seeks to smallest term that's >= target.

Declaration
protected virtual void DoSeekCeil()
| Improve this Doc View Source

DoSeekExact()

Seeks to exactly target term.

Declaration
protected virtual bool DoSeekExact()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

DoSeekFloor()

Seeks to largest term that's <= target.

Declaration
protected virtual void DoSeekFloor()
| Improve this Doc View Source

Grow()

Declaration
protected abstract void Grow()
| Improve this Doc View Source

RewindPrefix()

Rewinds enum state to match the shared prefix between current term and target term

Declaration
protected void RewindPrefix()