Package org.apache.lucene.util.fst
Class Util
java.lang.Object
org.apache.lucene.util.fst.Util
Static helper methods.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Represents a path in TopNSearcher.static final class
Holds a single input (IntsRef) + output, returned byshortestPaths()
.static class
Utility class to find top N shortest paths from start point(s).static final class
Holds the results for a top N search usingUtil.TopNSearcher
-
Method Summary
Modifier and TypeMethodDescriptionstatic <T> T
Looks up the output for this input, or null if the input is not acceptedstatic <T> T
Looks up the output for this input, or null if the input is not accepted.static <T> FST.Arc<T>
readCeilArc
(int label, FST<T> fst, FST.Arc<T> follow, FST.Arc<T> arc, FST.BytesReader in) Reads the first arc greater or equal than the given label into the provided arc in place and returns it iff found, otherwise returnnull
.static <T> Util.TopResults<T>
shortestPaths
(FST<T> fst, FST.Arc<T> fromNode, T startOutput, Comparator<T> comparator, int topN, boolean allowEmptyString) Starting from node, find the top N min cost completions to a final node.static BytesRef
toBytesRef
(IntsRef input, BytesRefBuilder scratch) Just converts IntsRef to BytesRef; you must ensure the int values fit into a byte.static <T> void
Dumps anFST
to a GraphViz'sdot
language description for visualization.static IntsRef
toIntsRef
(BytesRef input, IntsRefBuilder scratch) Just takes unsigned byte values from the BytesRef and converts into an IntsRef.static IntsRef
toUTF16
(CharSequence s, IntsRefBuilder scratch) Just maps each UTF16 unit (char) to the ints in an IntsRef.static IntsRef
toUTF32
(char[] s, int offset, int length, IntsRefBuilder scratch) Decodes the Unicode codepoints from the provided char[] and places them in the provided scratch IntsRef, which must not be null, returning it.static IntsRef
toUTF32
(CharSequence s, IntsRefBuilder scratch) Decodes the Unicode codepoints from the provided CharSequence and places them in the provided scratch IntsRef, which must not be null, returning it.
-
Method Details
-
get
Looks up the output for this input, or null if the input is not accepted.- Throws:
IOException
-
get
Looks up the output for this input, or null if the input is not accepted- Throws:
IOException
-
shortestPaths
public static <T> Util.TopResults<T> shortestPaths(FST<T> fst, FST.Arc<T> fromNode, T startOutput, Comparator<T> comparator, int topN, boolean allowEmptyString) throws IOException Starting from node, find the top N min cost completions to a final node.- Throws:
IOException
-
toDot
public static <T> void toDot(FST<T> fst, Writer out, boolean sameRank, boolean labelStates) throws IOException Dumps anFST
to a GraphViz'sdot
language description for visualization. Example of use:PrintWriter pw = new PrintWriter("out.dot"); Util.toDot(fst, pw, true, true); pw.close();
and then, from command line:dot -Tpng -o out.png out.dot
Note: larger FSTs (a few thousand nodes) won't even render, don't bother.
- Parameters:
sameRank
- Iftrue
, the resultingdot
file will try to order states in layers of breadth-first traversal. This may mess up arcs, but makes the output FST's structure a bit clearer.labelStates
- Iftrue
states will have labels equal to their offsets in their binary format. Expands the graph considerably.- Throws:
IOException
- See Also:
-
toUTF16
Just maps each UTF16 unit (char) to the ints in an IntsRef. -
toUTF32
Decodes the Unicode codepoints from the provided CharSequence and places them in the provided scratch IntsRef, which must not be null, returning it. -
toUTF32
Decodes the Unicode codepoints from the provided char[] and places them in the provided scratch IntsRef, which must not be null, returning it. -
toIntsRef
Just takes unsigned byte values from the BytesRef and converts into an IntsRef. -
toBytesRef
Just converts IntsRef to BytesRef; you must ensure the int values fit into a byte. -
readCeilArc
public static <T> FST.Arc<T> readCeilArc(int label, FST<T> fst, FST.Arc<T> follow, FST.Arc<T> arc, FST.BytesReader in) throws IOException Reads the first arc greater or equal than the given label into the provided arc in place and returns it iff found, otherwise returnnull
.- Parameters:
label
- the label to ceil onfst
- the fst to operate onfollow
- the arc to follow reading the label fromarc
- the arc to read into in placein
- the fst'sFST.BytesReader
- Throws:
IOException
-