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

Constructors

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

NO_OUTPUT

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.

Declaration
protected readonly T NO_OUTPUT
Field Value
Type Description
T

m_arcs

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.

Declaration
protected FST.Arc<T>[] m_arcs
Field Value
Type Description
Arc<T>[]

m_fst

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.

Declaration
protected readonly FST<T> m_fst
Field Value
Type Description
FST<T>

m_fstReader

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.

Declaration
protected readonly FST.BytesReader m_fstReader
Field Value
Type Description
FST.BytesReader

m_output

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.

Declaration
protected T[] m_output
Field Value
Type Description
T[]

m_scratchArc

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.

Declaration
protected readonly FST.Arc<T> m_scratchArc
Field Value
Type Description
FST.Arc<T>

m_targetLength

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.

Declaration
protected int m_targetLength
Field Value
Type Description
int

m_upto

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.

Declaration
protected int m_upto
Field Value
Type Description
int

Properties

CurrentLabel

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.

Declaration
protected abstract int CurrentLabel { get; set; }
Property Value
Type Description
int

TargetLabel

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.

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

Methods

DoNext()

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.

Declaration
protected virtual void DoNext()

DoSeekCeil()

Seeks to smallest term that's >= target.

Declaration
protected virtual void DoSeekCeil()

DoSeekExact()

Seeks to exactly target term.

Declaration
protected virtual bool DoSeekExact()
Returns
Type Description
bool

DoSeekFloor()

Seeks to largest term that's <= target.

Declaration
protected virtual void DoSeekFloor()

Grow()

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.

Declaration
protected abstract void Grow()

RewindPrefix()

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

Declaration
protected void RewindPrefix()