core/org.gnit.lucenekmp.util.fst/FST/Companion

Companion

Properties

Value of the arc flags to declare a node with fixed length (sparse) arcs designed for binary search.

Value of the arc flags to declare a node with continuous arcs designed for pos the arc directly with labelToPos - firstLabel. like .ARCS_FOR_BINARY_SEARCH we use flag combinations that will not occur at the same time.

ARCS_FOR_DIRECT_ADDRESSING

const val ARCS_FOR_DIRECT_ADDRESSING: Byte

Value of the arc flags to declare a node with fixed length dense arcs and bit table designed for direct addressing.

BIT_ARC_HAS_FINAL_OUTPUT

const val BIT_ARC_HAS_FINAL_OUTPUT: Int

BIT_ARC_HAS_OUTPUT

const val BIT_ARC_HAS_OUTPUT: Int

This flag is set if the arc has an output.

BIT_FINAL_ARC

const val BIT_FINAL_ARC: Int

BIT_LAST_ARC

const val BIT_LAST_ARC: Int

BIT_STOP_NODE

const val BIT_STOP_NODE: Int

BIT_TARGET_NEXT

const val BIT_TARGET_NEXT: Int

END_LABEL

const val END_LABEL: Int

If arc has this label then that arc is final/accepted

FINAL_END_NODE

const val FINAL_END_NODE: Long

NON_FINAL_END_NODE

const val NON_FINAL_END_NODE: Long = 0

VERSION_90

const val VERSION_90: Int

Version that was used when releasing Lucene 9.0.

VERSION_CONTINUOUS_ARCS

const val VERSION_CONTINUOUS_ARCS: Int = 9

Version that started storing continuous arcs.

VERSION_CURRENT

const val VERSION_CURRENT: Int

Current version.

VERSION_START

const val VERSION_START: Int = 6

First supported version, this is the version that was used when releasing Lucene 7.0.

Functions

fromFSTReader

fun <T> fromFSTReader(fstMetadata: FST.FSTMetadata<T>?, fstReader: FSTReader): FST<T>?

Create a FST from a FSTReader. Return null if the metadata is null.

getNumPresenceBytes

fun getNumPresenceBytes(labelRange: Int): Int

Gets the number of bytes required to flag the presence of each arc in the given label range, one bit per arc.

read

fun <T> read(path: Path, outputs: Outputs<T>): FST<T>

Reads an automaton from a file.

readEndArc

fun <T> readEndArc(follow: FST.Arc<T>, arc: FST.Arc<T>): FST.Arc<T>?

readMetadata

fun <T> readMetadata(metaIn: DataInput, outputs: Outputs<T>): FST.FSTMetadata<T>

Read the FST metadata from DataInput

targetHasArcs

fun <T> targetHasArcs(arc: FST.Arc<T>): Boolean

returns true if the node at this address has any outgoing arcs