Class BytesRefFSTEnum<T>

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

Note

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

Inheritance

object

FSTEnum<T>

BytesRefFSTEnum<T>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Util.Fst

Assembly: Lucene.Net.dll

Syntax

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

Type Parameters

Name	Description
T

Constructors

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

Current

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

Note

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

Declaration

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

Property Value

Type	Description
BytesRefFSTEnum.InputOutput<T>

CurrentLabel

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

Note

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

Declaration

protected override int CurrentLabel { get; set; }

Property Value

Type	Description
int

Overrides

FSTEnum<T>.CurrentLabel

TargetLabel

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

Note

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

Declaration

protected override int TargetLabel { get; }

Property Value

Type	Description
int

Overrides

FSTEnum<T>.TargetLabel

Methods

Grow()

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

Note

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

Declaration

protected override void Grow()

Overrides

FSTEnum<T>.Grow()

MoveNext()

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

Note

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

Declaration

public bool MoveNext()

Returns

Type	Description
bool

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>

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>

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>