Class CompiledAutomaton

Immutable class holding compiled details for a given Automaton. The Automaton is deterministic, must not have dead states but is not necessarily minimal.

Note

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

Inheritance

object

CompiledAutomaton

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Util.Automaton

Assembly: Lucene.Net.dll

Syntax

public class CompiledAutomaton

Constructors

CompiledAutomaton(Automaton)

Immutable class holding compiled details for a given Automaton. The Automaton is deterministic, must not have dead states but is not necessarily minimal.

Note

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

Declaration

public CompiledAutomaton(Automaton automaton)

Parameters

Type	Name	Description
Automaton	automaton

CompiledAutomaton(Automaton, bool?, bool)

Immutable class holding compiled details for a given Automaton. The Automaton is deterministic, must not have dead states but is not necessarily minimal.

Note

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

Declaration

public CompiledAutomaton(Automaton automaton, bool? finite, bool simplify)

Parameters

Type	Name	Description
Automaton	automaton
bool?	finite
bool	simplify

Properties

CommonSuffixRef

Shared common suffix accepted by the automaton. Only valid for NORMAL, and only when the automaton accepts an infinite language.

Declaration

public BytesRef CommonSuffixRef { get; }

Property Value

Type	Description
BytesRef

Finite

Indicates if the automaton accepts a finite set of strings. Null if this was not computed. Only valid for NORMAL.

Declaration

public bool? Finite { get; }

Property Value

Type	Description
bool?

RunAutomaton

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

Declaration

public ByteRunAutomaton RunAutomaton { get; }

Property Value

Type	Description
ByteRunAutomaton

SortedTransitions

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

Only valid for NORMAL.

Declaration

public Transition[][] SortedTransitions { get; }

Property Value

Type	Description
Transition[][]

Term

For PREFIX, this is the prefix term; for SINGLE this is the singleton term.

Declaration

public BytesRef Term { get; }

Property Value

Type	Description
BytesRef

Type

Immutable class holding compiled details for a given Automaton. The Automaton is deterministic, must not have dead states but is not necessarily minimal.

Note

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

Declaration

public CompiledAutomaton.AUTOMATON_TYPE Type { get; }

Property Value

Type	Description
CompiledAutomaton.AUTOMATON_TYPE

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

Floor(BytesRef, 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 BytesRef. 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).

Declaration

public virtual BytesRef Floor(BytesRef input, BytesRef output)

Parameters

Type	Name	Description
BytesRef	input
BytesRef	output

Returns

Type	Description
BytesRef

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

GetTermsEnum(Terms)

Immutable class holding compiled details for a given Automaton. The Automaton is deterministic, must not have dead states but is not necessarily minimal.

Note

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

Declaration

public virtual TermsEnum GetTermsEnum(Terms terms)

Parameters

Type	Name	Description
Terms	terms

Returns

Type	Description
TermsEnum

ToDot()

Immutable class holding compiled details for a given Automaton. The Automaton is deterministic, must not have dead states but is not necessarily minimal.

Note

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

Declaration

public virtual string ToDot()

Returns

Type	Description
string