core/org.gnit.lucenekmp.util.fst/Outputs

Outputs

abstract class Outputs<T>

Represents the outputs for an FST, providing the basic algebra required for building and traversing the FST.

Note that any operation that returns NO_OUTPUT must return the same singleton object from .getNoOutput.

Inheritors

Constructors

Outputs

constructor()

Properties

noOutput

abstract val noOutput: T

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

Functions

add

abstract fun add(prefix: T, output: T): T

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

common

abstract fun common(output1: T, output2: T): T

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

merge

fun merge(first: T, second: T): T

outputToString

abstract fun outputToString(output: T): String

ramBytesUsed

abstract fun ramBytesUsed(output: T): Long

Return memory usage for the provided output.

read

abstract fun read(in: DataInput): T

Decode an output value previously written with .write.

readFinalOutput

fun readFinalOutput(in: DataInput): T

Decode an output value previously written with .writeFinalOutput. By default this just calls .read.

skipFinalOutput

open fun skipFinalOutput(in: DataInput)

Skip the output previously written with .writeFinalOutput; defaults to just calling .readFinalOutput and discarding the result.

skipOutput

open fun skipOutput(in: DataInput)

Skip the output; defaults to just calling .read and discarding the result.

subtract

abstract fun subtract(output: T, inc: T): T

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

write

abstract fun write(output: T, out: DataOutput)

Encode an output value into a DataOutput.

writeFinalOutput

fun writeFinalOutput(output: T, out: DataOutput)

Encode an final node output value into a DataOutput. By default this just calls .write.