Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class CharSequenceOutputs

    An FST Outputs<T> implementation where each output is a sequence of characters.

    Note

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

    Inheritance
    object
    Outputs<CharsRef>
    CharSequenceOutputs
    Inherited Members
    Outputs<CharsRef>.WriteFinalOutput(CharsRef, DataOutput)
    Outputs<CharsRef>.ReadFinalOutput(DataInput)
    Outputs<CharsRef>.Merge(CharsRef, CharsRef)
    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 CharSequenceOutputs : Outputs<CharsRef>

    Properties

    NoOutput

    NOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no output

    Declaration
    public override CharsRef NoOutput { get; }
    Property Value
    Type Description
    CharsRef
    Overrides
    Outputs<CharsRef>.NoOutput

    Singleton

    An FST Outputs<T> implementation where each output is a sequence of characters.

    Note

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

    Declaration
    public static CharSequenceOutputs Singleton { get; }
    Property Value
    Type Description
    CharSequenceOutputs

    Methods

    Add(CharsRef, CharsRef)

    Eg add("foo", "bar") -> "foobar"

    Declaration
    public override CharsRef Add(CharsRef prefix, CharsRef output)
    Parameters
    Type Name Description
    CharsRef prefix
    CharsRef output
    Returns
    Type Description
    CharsRef
    Overrides
    Outputs<CharsRef>.Add(CharsRef, CharsRef)

    Common(CharsRef, CharsRef)

    Eg common("foobar", "food") -> "foo"

    Declaration
    public override CharsRef Common(CharsRef output1, CharsRef output2)
    Parameters
    Type Name Description
    CharsRef output1
    CharsRef output2
    Returns
    Type Description
    CharsRef
    Overrides
    Outputs<CharsRef>.Common(CharsRef, CharsRef)

    OutputToString(CharsRef)

    An FST Outputs<T> implementation where each output is a sequence of characters.

    Note

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

    Declaration
    public override string OutputToString(CharsRef output)
    Parameters
    Type Name Description
    CharsRef output
    Returns
    Type Description
    string
    Overrides
    Outputs<CharsRef>.OutputToString(CharsRef)

    Read(DataInput)

    Decode an output value previously written with Write(T, DataOutput).

    Declaration
    public override CharsRef Read(DataInput @in)
    Parameters
    Type Name Description
    DataInput in
    Returns
    Type Description
    CharsRef
    Overrides
    Outputs<CharsRef>.Read(DataInput)

    Subtract(CharsRef, CharsRef)

    Eg subtract("foobar", "foo") -> "bar"

    Declaration
    public override CharsRef Subtract(CharsRef output, CharsRef inc)
    Parameters
    Type Name Description
    CharsRef output
    CharsRef inc
    Returns
    Type Description
    CharsRef
    Overrides
    Outputs<CharsRef>.Subtract(CharsRef, CharsRef)

    Write(CharsRef, DataOutput)

    Encode an output value into a DataOutput.

    Declaration
    public override void Write(CharsRef prefix, DataOutput @out)
    Parameters
    Type Name Description
    CharsRef prefix
    DataOutput out
    Overrides
    Outputs<CharsRef>.Write(CharsRef, DataOutput)
    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.