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

PairOutputs

class PairOutputs<A, B>(outputs1: Outputs<A>, outputs2: Outputs<B>) : Outputs<PairOutputs.Pair<A, B>>

An Outputs implementation that pairs two other outputs.

Constructors

PairOutputs

constructor(outputs1: Outputs<A>, outputs2: Outputs<B>)

Types

Pair

class Pair<A, B>(val output1: A, val output2: B)

Properties

noOutput

open override val noOutput: PairOutputs.Pair<A, B>

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

open override fun add(prefix: PairOutputs.Pair<A, B>, output: PairOutputs.Pair<A, B>): PairOutputs.Pair<A, B>

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

common

open override fun common(output1: PairOutputs.Pair<A, B>, output2: PairOutputs.Pair<A, B>): PairOutputs.Pair<A, B>

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

merge

fun merge(first: PairOutputs.Pair<A, B>, second: PairOutputs.Pair<A, B>): PairOutputs.Pair<A, B>

newPair

fun newPair(a: A, b: B): PairOutputs.Pair<A, B>

outputToString

open override fun outputToString(output: PairOutputs.Pair<A, B>): String

ramBytesUsed

open override fun ramBytesUsed(output: PairOutputs.Pair<A, B>): Long

Return memory usage for the provided output.

read

open override fun read(input: DataInput): PairOutputs.Pair<A, B>

Decode an output value previously written with .write.

readFinalOutput

fun readFinalOutput(in: DataInput): PairOutputs.Pair<A, B>

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 override fun skipOutput(input: DataInput)

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

subtract

open override fun subtract(output: PairOutputs.Pair<A, B>, inc: PairOutputs.Pair<A, B>): PairOutputs.Pair<A, B>

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

toString

open override fun toString(): String

write

open override fun write(output: PairOutputs.Pair<A, B>, out: DataOutput)

Encode an output value into a DataOutput.

writeFinalOutput

fun writeFinalOutput(output: PairOutputs.Pair<A, B>, out: DataOutput)

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