Class BytesRefFSTEnum<T>

Enumerates all input (BytesRef) + output pairs in an FST.

This is a Lucene.NET EXPERIMENTAL API, use at your own risk

Inheritance

System.Object

FSTEnum<T>

BytesRefFSTEnum<T>

Inherited Members

FSTEnum<T>.m_fst

FSTEnum<T>.m_arcs

FSTEnum<T>.m_output

FSTEnum<T>.NO_OUTPUT

FSTEnum<T>.m_fstReader

FSTEnum<T>.m_scratchArc

FSTEnum<T>.m_upto

FSTEnum<T>.m_targetLength

FSTEnum<T>.RewindPrefix()

FSTEnum<T>.DoNext()

FSTEnum<T>.DoSeekCeil()

FSTEnum<T>.DoSeekFloor()

FSTEnum<T>.DoSeekExact()

Namespace: Lucene.Net.Util.Fst

Assembly: Lucene.Net.dll

Syntax

public sealed class BytesRefFSTEnum<T> : FSTEnum<T>

Type Parameters

Name	Description
T

Constructors

| Improve this Doc View Source

BytesRefFSTEnum(FST<T>)

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

Declaration

public BytesRefFSTEnum(FST<T> fst)

Parameters

Type	Name	Description
FST<T>	fst

Properties

| Improve this Doc View Source

Current

Declaration

public BytesRefFSTEnum.InputOutput<T> Current { get; }

Property Value

Type	Description
BytesRefFSTEnum.InputOutput<T>

| Improve this Doc View Source

CurrentLabel

Declaration

protected override int CurrentLabel { get; set; }

Property Value

Type	Description
System.Int32

Overrides

Lucene.Net.Util.Fst.FSTEnum<T>.CurrentLabel

| Improve this Doc View Source

TargetLabel

Declaration

protected override int TargetLabel { get; }

Property Value

Type	Description
System.Int32

Overrides

Lucene.Net.Util.Fst.FSTEnum<T>.TargetLabel

Methods

| Improve this Doc View Source

Grow()

Declaration

protected override void Grow()

Overrides

Lucene.Net.Util.Fst.FSTEnum<T>.Grow()

| Improve this Doc View Source

Next()

Declaration

public BytesRefFSTEnum.InputOutput<T> Next()

Returns

Type	Description
BytesRefFSTEnum.InputOutput<T>

| Improve this Doc View Source

SeekCeil(BytesRef)

Seeks to smallest term that's >= target.

Declaration

public BytesRefFSTEnum.InputOutput<T> SeekCeil(BytesRef target)

Parameters

Type	Name	Description
BytesRef	target

Returns

Type	Description
BytesRefFSTEnum.InputOutput<T>

| Improve this Doc View Source

SeekExact(BytesRef)

Seeks to exactly this term, returning null if the term doesn't exist. This is faster than using SeekFloor(BytesRef) or SeekCeil(BytesRef) because it short-circuits as soon the match is not found.

Declaration

public BytesRefFSTEnum.InputOutput<T> SeekExact(BytesRef target)

Parameters

Type	Name	Description
BytesRef	target

Returns

Type	Description
BytesRefFSTEnum.InputOutput<T>

| Improve this Doc View Source

SeekFloor(BytesRef)

Seeks to biggest term that's <= target.

Declaration

public BytesRefFSTEnum.InputOutput<T> SeekFloor(BytesRef target)

Parameters

Type	Name	Description
BytesRef	target

Returns

Type	Description
BytesRefFSTEnum.InputOutput<T>