Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class Int32sRefFSTEnum<T>

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

    NOTE: This was IntsRefFSTEnum{T} in Lucene

    Note

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

    Inheritance
    object
    FSTEnum<T>
    Int32sRefFSTEnum<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 Int32sRefFSTEnum<T> : FSTEnum<T> where T : class
    Type Parameters
    Name Description
    T

    Constructors

    Int32sRefFSTEnum(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 Int32sRefFSTEnum(FST<T> fst)
    Parameters
    Type Name Description
    FST<T> fst

    Properties

    Current

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

    NOTE: This was IntsRefFSTEnum{T} in Lucene

    Note

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

    Declaration
    public Int32sRefFSTEnum.InputOutput<T> Current { get; }
    Property Value
    Type Description
    Int32sRefFSTEnum.InputOutput<T>

    CurrentLabel

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

    NOTE: This was IntsRefFSTEnum{T} in Lucene

    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 (Int32sRef) + output pairs in an FST.

    NOTE: This was IntsRefFSTEnum{T} in Lucene

    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 (Int32sRef) + output pairs in an FST.

    NOTE: This was IntsRefFSTEnum{T} in Lucene

    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 (Int32sRef) + output pairs in an FST.

    NOTE: This was IntsRefFSTEnum{T} in Lucene

    Note

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

    Declaration
    public bool MoveNext()
    Returns
    Type Description
    bool

    SeekCeil(Int32sRef)

    Seeks to smallest term that's >= target.

    Declaration
    public Int32sRefFSTEnum.InputOutput<T> SeekCeil(Int32sRef target)
    Parameters
    Type Name Description
    Int32sRef target
    Returns
    Type Description
    Int32sRefFSTEnum.InputOutput<T>

    SeekExact(Int32sRef)

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

    Declaration
    public Int32sRefFSTEnum.InputOutput<T> SeekExact(Int32sRef target)
    Parameters
    Type Name Description
    Int32sRef target
    Returns
    Type Description
    Int32sRefFSTEnum.InputOutput<T>

    SeekFloor(Int32sRef)

    Seeks to biggest term that's <= target.

    Declaration
    public Int32sRefFSTEnum.InputOutput<T> SeekFloor(Int32sRef target)
    Parameters
    Type Name Description
    Int32sRef target
    Returns
    Type Description
    Int32sRefFSTEnum.InputOutput<T>
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.