Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class ByteSequenceOutputs

    An FST Outputs{BytesRef} implementation where each output is a sequence of bytes.

    Note

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

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

    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 BytesRef NoOutput { get; }
    Property Value
    Type Description
    BytesRef
    Overrides
    Outputs<BytesRef>.NoOutput

    Singleton

    An FST Outputs{BytesRef} implementation where each output is a sequence of bytes.

    Note

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

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

    Methods

    Add(BytesRef, BytesRef)

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

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

    Common(BytesRef, BytesRef)

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

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

    OutputToString(BytesRef)

    An FST Outputs{BytesRef} implementation where each output is a sequence of bytes.

    Note

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

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

    Read(DataInput)

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

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

    Subtract(BytesRef, BytesRef)

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

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

    Write(BytesRef, DataOutput)

    Encode an output value into a DataOutput.

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