core/org.gnit.lucenekmp.util.automaton/CompiledAutomaton

CompiledAutomaton

class CompiledAutomaton(automaton: Automaton, finite: Boolean, simplify: Boolean, isBinary: Boolean) : Accountable

Immutable class holding compiled details for a given Automaton. The Automaton could either be deterministic or non-deterministic, For deterministic automaton, it must not have dead states but is not necessarily minimal. And will be executed using ByteRunAutomaton For non-deterministic automaton, it will be executed using NFARunAutomaton

Constructors

CompiledAutomaton

constructor(automaton: Automaton, finite: Boolean, simplify: Boolean, isBinary: Boolean)

constructor(automaton: Automaton)

Create this, passing simplify=true, so that we try to simplify the automaton.

constructor(automaton: Automaton, finite: Boolean, simplify: Boolean)

Create this. If simplify is true, we run possibly expensive operations to determine if the automaton is one the cases in AUTOMATON_TYPE. Set finite to true if the automaton is finite, otherwise set to false if infinite or you don't know.

Types

AUTOMATON_TYPE

enum AUTOMATON_TYPE : Enum<CompiledAutomaton.AUTOMATON_TYPE>

Automata are compiled into different internal forms for the most efficient execution depending upon the language they accept.

Companion

object Companion

Properties

automaton

var automaton: Automaton?

Two dimensional array of transitions, indexed by state number for traversal. The state numbering is consistent with .runAutomaton. Only valid for .

childResources

open val childResources: MutableCollection<Accountable>

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

commonSuffixRef

var commonSuffixRef: BytesRef?

Shared common suffix accepted by the automaton. Only valid for AUTOMATON_TYPE.NORMAL, and only when the automaton accepts an infinite language. This will be null if the common prefix is length 0.

finite

var finite: Boolean

Indicates if the automaton accepts a finite set of strings. Only valid for .

nfaRunAutomaton

var nfaRunAutomaton: NFARunAutomaton?

Matcher directly run on a NFA, it will determinize the state on need and caches it, note that this field and .runAutomaton will not be non-null at the same time

runAutomaton

var runAutomaton: ByteRunAutomaton?

Matcher for quickly determining if a byte[] is accepted. only valid for .

sinkState

var sinkState: Int

Which state, if any, accepts all suffixes, else -1.

term

var term: BytesRef?

For AUTOMATON_TYPE.SINGLE this is the singleton term.

type

var type: CompiledAutomaton.AUTOMATON_TYPE

If simplify is true this will be the "simplified" type; else, this is NORMAL

Functions

equals

open operator override fun equals(obj: Any?): Boolean

floor

fun floor(input: BytesRef, output: BytesRefBuilder): BytesRef?

Finds largest term accepted by this Automaton, that's <= the provided input term. The result is placed in output; it's fine for output and input to point to the same bytes. The returned result is either the provided output, or null if there is no floor term (ie, the provided input term is before the first term accepted by this Automaton).

getByteRunnable

fun getByteRunnable(): ByteRunnable?

Get a ByteRunnable instance, it will be different depending on whether a NFA or DFA is passed in, and does not guarantee returning non-null object

getTermsEnum

fun getTermsEnum(terms: Terms): TermsEnum

Return a TermsEnum intersecting the provided Terms with the terms accepted by this automaton.

getTransitionAccessor

fun getTransitionAccessor(): TransitionAccessor?

Get a TransitionAccessor instance, it will be different depending on whether a NFA or DFA is passed in, and does not guarantee returning non-null object

hashCode

open override fun hashCode(): Int

ramBytesUsed

open override fun ramBytesUsed(): Long

Return the memory usage of this object in bytes. Negative values are illegal.

visit

fun visit(visitor: QueryVisitor, parent: Query, field: String)

Report back to a QueryVisitor how this automaton matches terms