Package org.apache.pinot.segment.local.utils.nativefst

Class ConstantArcSizeFST

java.lang.Object

org.apache.pinot.segment.local.utils.nativefst.FST

org.apache.pinot.segment.local.utils.nativefst.ConstantArcSizeFST

All Implemented Interfaces:

Iterable<ByteBuffer>

public final class ConstantArcSizeFST
extends FST

A FST with constant-size arc representation produced directly by FSTBuilder.

See Also:

FSTBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static int	ADDRESS_OFFSET	Offset of the address field inside an arc.
static int	ARC_SIZE	Size of a single arc structure.
static int	BIT_ARC_FINAL	An arc flag indicating the target node of an arc corresponds to a final state.
static int	BIT_ARC_LAST	An arc flag indicating the arc is last within its state.
static int	FLAGS_OFFSET	Offset of the flags field inside an arc.
static int	FLAGS_SIZE	Size of the flags field (constant for the builder).
static int	LABEL_OFFSET	Offset of the label field inside an arc.
static int	LABEL_SIZE	Size of the label field (constant for the builder).
static int	TARGET_ADDRESS_SIZE	Size of the target address field (constant for the builder).
static int	TERMINAL_STATE	A dummy address of the terminal state.

Constructor Summary

Constructors

Constructor	Description
ConstantArcSizeFST(byte[] data, int epsilon, Map<Integer,Integer> outputSymbols)

Method Summary

Modifier and Type	Method	Description
int	getArc(int node, byte label)
byte	getArcLabel(int arc)
int	getEndNode(int arc)
int	getFirstArc(int node)
Set<FSTFlags>	getFlags()
int	getNextArc(int arc)
int	getOutputSymbol(int arc)	Get output symbol for the given arc
int	getRootNode()
boolean	isArcFinal(int arc)
boolean	isArcLast(int arc)
boolean	isArcTerminal(int arc)

Methods inherited from class org.apache.pinot.segment.local.utils.nativefst.FST

buildMap, getRightLanguageCount, getSequences, getSequences, iterator, printToString, read, read, read, readRemaining, save, toString, visitInPostOrder, visitInPostOrder, visitInPreOrder, visitInPreOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

TARGET_ADDRESS_SIZE

public static final int TARGET_ADDRESS_SIZE

Size of the target address field (constant for the builder).

See Also:

Constant Field Values

FLAGS_SIZE

public static final int FLAGS_SIZE

Size of the flags field (constant for the builder).

See Also:

Constant Field Values

LABEL_SIZE

public static final int LABEL_SIZE

Size of the label field (constant for the builder).

See Also:

Constant Field Values

ARC_SIZE

public static final int ARC_SIZE

Size of a single arc structure.

See Also:

Constant Field Values

FLAGS_OFFSET

public static final int FLAGS_OFFSET

Offset of the flags field inside an arc.

See Also:

Constant Field Values

LABEL_OFFSET

public static final int LABEL_OFFSET

Offset of the label field inside an arc.

See Also:

Constant Field Values

ADDRESS_OFFSET

public static final int ADDRESS_OFFSET

Offset of the address field inside an arc.

See Also:

Constant Field Values

BIT_ARC_FINAL

public static final int BIT_ARC_FINAL

An arc flag indicating the target node of an arc corresponds to a final state.

See Also:

Constant Field Values

BIT_ARC_LAST

public static final int BIT_ARC_LAST

An arc flag indicating the arc is last within its state.

See Also:

Constant Field Values

TERMINAL_STATE

public static final int TERMINAL_STATE

A dummy address of the terminal state.

See Also:

Constant Field Values

Constructor Detail

ConstantArcSizeFST

public ConstantArcSizeFST(byte[] data,
                          int epsilon,
                          Map<Integer,Integer> outputSymbols)

Parameters:

data - FST data. There must be no trailing bytes after the last state.

Method Detail

getRootNode

public int getRootNode()

Specified by:

getRootNode in class FST

Returns:

Returns the identifier of the root node of this automaton. Returns 0 if the start node is also the end node (the automaton is empty).

getFirstArc

public int getFirstArc(int node)

Specified by:

getFirstArc in class FST

Parameters:

node - Identifier of the node.

Returns:

Returns the identifier of the first arc leaving node or 0 if the node has no outgoing arcs.

getArc

public int getArc(int node,
                  byte label)

Specified by:

getArc in class FST

Parameters:

node - Identifier of the node.

label - The arc's label.

Returns:

Returns the identifier of an arc leaving node and labeled with label. An identifier equal to 0 means the node has no outgoing arc labeled label.

getNextArc

public int getNextArc(int arc)

Specified by:

getNextArc in class FST

Parameters:

arc - The arc's identifier.

Returns:

Returns the identifier of the next arc after arc and leaving node. Zero is returned if no more arcs are available for the node.

getArcLabel

public byte getArcLabel(int arc)

Specified by:

getArcLabel in class FST

Parameters:

arc - The arc's identifier.

Returns:

Return the label associated with a given arc.

getOutputSymbol

public int getOutputSymbol(int arc)

Description copied from class: FST

Get output symbol for the given arc

Specified by:

getOutputSymbol in class FST

Parameters:

arc - Arc for which the output symbol is requested

Returns:

Output symbol, null if not present

isArcFinal

public boolean isArcFinal(int arc)

Specified by:

isArcFinal in class FST

Parameters:

arc - The arc's identifier.

Returns:

Returns true if the destination node at the end of this arc corresponds to an input sequence created when building this automaton.

isArcTerminal

public boolean isArcTerminal(int arc)

Specified by:

isArcTerminal in class FST

Parameters:

arc - The arc's identifier.

Returns:

Returns true if this arc does not have a terminating node (@link FST.getEndNode(int) will throw an exception). Implies FST.isArcFinal(int).

isArcLast

public boolean isArcLast(int arc)

Specified by:

isArcLast in class FST

getEndNode

public int getEndNode(int arc)

Specified by:

getEndNode in class FST

Parameters:

arc - The arc's identifier.

Returns:

Return the end node pointed to by a given arc. Terminal arcs (those that point to a terminal state) have no end node representation and throw a runtime exception.

getFlags

public Set<FSTFlags> getFlags()

Specified by:

getFlags in class FST

Returns:

Returns a set of flags for this FST instance.