FusionDictionary.java revision eae7b293e4a854819aa0de663066cd0b6cdd52e7
1bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard/* 2bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Copyright (C) 2011 The Android Open Source Project 3bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 4bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * use this file except in compliance with the License. You may obtain a copy of 6bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * the License at 7bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 8bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * http://www.apache.org/licenses/LICENSE-2.0 9bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 10bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Unless required by applicable law or agreed to in writing, software 11bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * License for the specific language governing permissions and limitations under 14bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * the License. 15bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 16bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 17cdc51fc6afc7fd374c5c9eeb0539cae5cf1de724Tom Ouyangpackage com.android.inputmethod.latin.makedict; 18bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 19eae7b293e4a854819aa0de663066cd0b6cdd52e7Yuichiro Hanadaimport com.android.inputmethod.latin.Constants; 20eae7b293e4a854819aa0de663066cd0b6cdd52e7Yuichiro Hanada 21bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalardimport java.util.ArrayList; 22bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalardimport java.util.Arrays; 23bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalardimport java.util.Collections; 24c734c2aca1830643d169fd292e0c9d4d9306af5aJean Chalardimport java.util.HashMap; 25bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalardimport java.util.Iterator; 26bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalardimport java.util.LinkedList; 27bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 28bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard/** 29bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * A dictionary that can fusion heads and tails of words for more compression. 30bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 31bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalardpublic class FusionDictionary implements Iterable<Word> { 32bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 3347db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard private static final boolean DBG = MakedictLog.DBG; 3447db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard 35bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 36bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * A node of the dictionary, containing several CharGroups. 37bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 38bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * A node is but an ordered array of CharGroups, which essentially contain all the 39bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * real information. 40bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * This class also contains fields to cache size and address, to help with binary 41bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * generation. 42bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 43bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public static class Node { 44bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard ArrayList<CharGroup> mData; 45bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // To help with binary generation 46bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int mCachedSize; 47bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int mCachedAddress; 48bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public Node() { 49bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mData = new ArrayList<CharGroup>(); 50bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mCachedSize = Integer.MIN_VALUE; 51bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mCachedAddress = Integer.MIN_VALUE; 52bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 53bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public Node(ArrayList<CharGroup> data) { 54bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mData = data; 55bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mCachedSize = Integer.MIN_VALUE; 56bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mCachedAddress = Integer.MIN_VALUE; 57bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 58bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 59bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 60bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 61bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * A string with a frequency. 62bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 63bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * This represents an "attribute", that is either a bigram or a shortcut. 64bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 65bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public static class WeightedString { 6654e84a00fc032ba566cbda41feafa71de77e1c43Jean Chalard public final String mWord; 6754e84a00fc032ba566cbda41feafa71de77e1c43Jean Chalard public int mFrequency; 68bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public WeightedString(String word, int frequency) { 69bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mWord = word; 70bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mFrequency = frequency; 71bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 729f0ea52a5db9710df6bef4672d8e193c48451df0Ken Wakasa 739f0ea52a5db9710df6bef4672d8e193c48451df0Ken Wakasa @Override 749f0ea52a5db9710df6bef4672d8e193c48451df0Ken Wakasa public int hashCode() { 759f0ea52a5db9710df6bef4672d8e193c48451df0Ken Wakasa return Arrays.hashCode(new Object[] { mWord, mFrequency }); 769f0ea52a5db9710df6bef4672d8e193c48451df0Ken Wakasa } 779f0ea52a5db9710df6bef4672d8e193c48451df0Ken Wakasa 789f0ea52a5db9710df6bef4672d8e193c48451df0Ken Wakasa @Override 799f0ea52a5db9710df6bef4672d8e193c48451df0Ken Wakasa public boolean equals(Object o) { 809f0ea52a5db9710df6bef4672d8e193c48451df0Ken Wakasa if (o == this) return true; 819f0ea52a5db9710df6bef4672d8e193c48451df0Ken Wakasa if (!(o instanceof WeightedString)) return false; 829f0ea52a5db9710df6bef4672d8e193c48451df0Ken Wakasa WeightedString w = (WeightedString)o; 839f0ea52a5db9710df6bef4672d8e193c48451df0Ken Wakasa return mWord.equals(w.mWord) && mFrequency == w.mFrequency; 849f0ea52a5db9710df6bef4672d8e193c48451df0Ken Wakasa } 85bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 86bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 87bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 88eec2e51e2cbc9e69739187557846a439ed74325eJean Chalard * A group of characters, with a frequency, shortcut targets, bigrams, and children. 89bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 90bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * This is the central class of the in-memory representation. A CharGroup is what can 91bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * be seen as a traditional "trie node", except it can hold several characters at the 92bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * same time. A CharGroup essentially represents one or several characters in the middle 93bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * of the trie trie; as such, it can be a terminal, and it can have children. 94bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * In this in-memory representation, whether the CharGroup is a terminal or not is represented 95bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * in the frequency, where NOT_A_TERMINAL (= -1) means this is not a terminal and any other 96bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * value is the frequency of this terminal. A terminal may have non-null shortcuts and/or 97bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * bigrams, but a non-terminal may not. Moreover, children, if present, are null. 98bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 99bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public static class CharGroup { 100bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public static final int NOT_A_TERMINAL = -1; 101bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final int mChars[]; 1027cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang ArrayList<WeightedString> mShortcutTargets; 1037cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang ArrayList<WeightedString> mBigrams; 1047cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang int mFrequency; // NOT_A_TERMINAL == mFrequency indicates this is not a terminal. 105bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard Node mChildren; 10672b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard boolean mIsNotAWord; // Only a shortcut 10772b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard boolean mIsBlacklistEntry; 108bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // The two following members to help with binary generation 109bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int mCachedSize; 110bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int mCachedAddress; 111bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 112eec2e51e2cbc9e69739187557846a439ed74325eJean Chalard public CharGroup(final int[] chars, final ArrayList<WeightedString> shortcutTargets, 11372b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard final ArrayList<WeightedString> bigrams, final int frequency, 11472b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard final boolean isNotAWord, final boolean isBlacklistEntry) { 115bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mChars = chars; 116bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mFrequency = frequency; 117eec2e51e2cbc9e69739187557846a439ed74325eJean Chalard mShortcutTargets = shortcutTargets; 118bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mBigrams = bigrams; 119bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mChildren = null; 12072b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard mIsNotAWord = isNotAWord; 12172b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard mIsBlacklistEntry = isBlacklistEntry; 122bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 123bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 124eec2e51e2cbc9e69739187557846a439ed74325eJean Chalard public CharGroup(final int[] chars, final ArrayList<WeightedString> shortcutTargets, 12572b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard final ArrayList<WeightedString> bigrams, final int frequency, 12672b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard final boolean isNotAWord, final boolean isBlacklistEntry, final Node children) { 127bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mChars = chars; 128bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mFrequency = frequency; 129eec2e51e2cbc9e69739187557846a439ed74325eJean Chalard mShortcutTargets = shortcutTargets; 130bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mBigrams = bigrams; 131bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mChildren = children; 13272b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard mIsNotAWord = isNotAWord; 13372b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard mIsBlacklistEntry = isBlacklistEntry; 134bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 135bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 136bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public void addChild(CharGroup n) { 137bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (null == mChildren) { 138bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mChildren = new Node(); 139bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 140bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mChildren.mData.add(n); 141bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 142bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 143bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public boolean isTerminal() { 144bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return NOT_A_TERMINAL != mFrequency; 145bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 146bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 147bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public boolean hasSeveralChars() { 148bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard assert(mChars.length > 0); 149bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return 1 < mChars.length; 150bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 1517cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang 1527cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang /** 1537cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * Adds a word to the bigram list. Updates the frequency if the word already 1547cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * exists. 1557cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang */ 1567cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang public void addBigram(final String word, final int frequency) { 1577cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (mBigrams == null) { 1587cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang mBigrams = new ArrayList<WeightedString>(); 1597cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 1607cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang WeightedString bigram = getBigram(word); 1617cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (bigram != null) { 1627cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang bigram.mFrequency = frequency; 1637cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } else { 1647cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang bigram = new WeightedString(word, frequency); 1657cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang mBigrams.add(bigram); 1667cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 1677cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 1687cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang 1697cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang /** 1707cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * Gets the shortcut target for the given word. Returns null if the word is not in the 1717cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * shortcut list. 1727cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang */ 1737cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang public WeightedString getShortcut(final String word) { 17447db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard // TODO: Don't do a linear search 1757cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (mShortcutTargets != null) { 1767cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang final int size = mShortcutTargets.size(); 1777cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang for (int i = 0; i < size; ++i) { 1787cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang WeightedString shortcut = mShortcutTargets.get(i); 1797cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (shortcut.mWord.equals(word)) { 1807cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang return shortcut; 1817cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 1827cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 1837cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 1847cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang return null; 1857cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 1867cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang 1877cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang /** 1887cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * Gets the bigram for the given word. 1897cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * Returns null if the word is not in the bigrams list. 1907cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang */ 1917cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang public WeightedString getBigram(final String word) { 19247db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard // TODO: Don't do a linear search 1937cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (mBigrams != null) { 1947cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang final int size = mBigrams.size(); 1957cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang for (int i = 0; i < size; ++i) { 1967cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang WeightedString bigram = mBigrams.get(i); 1977cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (bigram.mWord.equals(word)) { 1987cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang return bigram; 1997cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 2007cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 2017cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 2027cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang return null; 2037cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 2047cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang 2057cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang /** 2067cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * Updates the CharGroup with the given properties. Adds the shortcut and bigram lists to 2077cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * the existing ones if any. Note: unigram, bigram, and shortcut frequencies are only 2087cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * updated if they are higher than the existing ones. 2097cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang */ 21072b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard public void update(final int frequency, final ArrayList<WeightedString> shortcutTargets, 21172b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard final ArrayList<WeightedString> bigrams, 21272b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard final boolean isNotAWord, final boolean isBlacklistEntry) { 2137cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (frequency > mFrequency) { 2147cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang mFrequency = frequency; 2157cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 2167cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (shortcutTargets != null) { 2177cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (mShortcutTargets == null) { 2187cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang mShortcutTargets = shortcutTargets; 2197cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } else { 2207cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang final int size = shortcutTargets.size(); 2217cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang for (int i = 0; i < size; ++i) { 2227cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang final WeightedString shortcut = shortcutTargets.get(i); 2237cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang final WeightedString existingShortcut = getShortcut(shortcut.mWord); 2247cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (existingShortcut == null) { 2257cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang mShortcutTargets.add(shortcut); 2267cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } else if (existingShortcut.mFrequency < shortcut.mFrequency) { 2277cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang existingShortcut.mFrequency = shortcut.mFrequency; 2287cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 2297cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 2307cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 2317cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 2327cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (bigrams != null) { 2337cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (mBigrams == null) { 2347cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang mBigrams = bigrams; 2357cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } else { 2367cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang final int size = bigrams.size(); 2377cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang for (int i = 0; i < size; ++i) { 2387cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang final WeightedString bigram = bigrams.get(i); 2397cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang final WeightedString existingBigram = getBigram(bigram.mWord); 2407cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (existingBigram == null) { 2417cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang mBigrams.add(bigram); 2427cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } else if (existingBigram.mFrequency < bigram.mFrequency) { 2437cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang existingBigram.mFrequency = bigram.mFrequency; 2447cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 2457cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 2467cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 2477cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 24872b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard mIsNotAWord = isNotAWord; 24972b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard mIsBlacklistEntry = isBlacklistEntry; 2507cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 251bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 252bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 253bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 254bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Options global to the dictionary. 255bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 256bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * There are no options at the moment, so this class is empty. 257bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 258bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public static class DictionaryOptions { 259f420df28233c26e555d203185fb292e83b94b8c3Jean Chalard public final boolean mGermanUmlautProcessing; 260f420df28233c26e555d203185fb292e83b94b8c3Jean Chalard public final boolean mFrenchLigatureProcessing; 261f420df28233c26e555d203185fb292e83b94b8c3Jean Chalard public final HashMap<String, String> mAttributes; 262f420df28233c26e555d203185fb292e83b94b8c3Jean Chalard public DictionaryOptions(final HashMap<String, String> attributes, 263f420df28233c26e555d203185fb292e83b94b8c3Jean Chalard final boolean germanUmlautProcessing, final boolean frenchLigatureProcessing) { 264c734c2aca1830643d169fd292e0c9d4d9306af5aJean Chalard mAttributes = attributes; 265f420df28233c26e555d203185fb292e83b94b8c3Jean Chalard mGermanUmlautProcessing = germanUmlautProcessing; 266f420df28233c26e555d203185fb292e83b94b8c3Jean Chalard mFrenchLigatureProcessing = frenchLigatureProcessing; 267c734c2aca1830643d169fd292e0c9d4d9306af5aJean Chalard } 268bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 269bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 270bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public final DictionaryOptions mOptions; 271bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public final Node mRoot; 272bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 273bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public FusionDictionary(final Node root, final DictionaryOptions options) { 274bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mRoot = root; 275bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mOptions = options; 276bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 277bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 278c734c2aca1830643d169fd292e0c9d4d9306af5aJean Chalard public void addOptionAttribute(final String key, final String value) { 279c734c2aca1830643d169fd292e0c9d4d9306af5aJean Chalard mOptions.mAttributes.put(key, value); 280c734c2aca1830643d169fd292e0c9d4d9306af5aJean Chalard } 281c734c2aca1830643d169fd292e0c9d4d9306af5aJean Chalard 282bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 283bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Helper method to convert a String to an int array. 284bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 28547db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard static private int[] getCodePoints(final String word) { 28647db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard // TODO: this is a copy-paste of the contents of StringUtils.toCodePointArray, 28747db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard // which is not visible from the makedict package. Factor this code. 28847db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard final char[] characters = word.toCharArray(); 28947db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard final int length = characters.length; 29047db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard final int[] codePoints = new int[Character.codePointCount(characters, 0, length)]; 29147db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard int codePoint = Character.codePointAt(characters, 0); 29247db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard int dsti = 0; 29347db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard for (int srci = Character.charCount(codePoint); 29447db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard srci < length; srci += Character.charCount(codePoint), ++dsti) { 29547db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard codePoints[dsti] = codePoint; 29647db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard codePoint = Character.codePointAt(characters, srci); 297c599f2e9d6ab839f38183aa178684ff0e94178a3Jean Chalard } 29847db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard codePoints[dsti] = codePoint; 29947db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard return codePoints; 300c599f2e9d6ab839f38183aa178684ff0e94178a3Jean Chalard } 301c599f2e9d6ab839f38183aa178684ff0e94178a3Jean Chalard 302c599f2e9d6ab839f38183aa178684ff0e94178a3Jean Chalard /** 303bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Helper method to add a word as a string. 304bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 305bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * This method adds a word to the dictionary with the given frequency. Optional 306bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * lists of bigrams and shortcuts can be passed here. For each word inside, 307bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * they will be added to the dictionary as necessary. 308bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 309bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @param word the word to add. 310bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @param frequency the frequency of the word, in the range [0..255]. 311eec2e51e2cbc9e69739187557846a439ed74325eJean Chalard * @param shortcutTargets a list of shortcut targets for this word, or null. 31272b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard * @param isNotAWord true if this should not be considered a word (e.g. shortcut only) 313bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 314eec2e51e2cbc9e69739187557846a439ed74325eJean Chalard public void add(final String word, final int frequency, 31572b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard final ArrayList<WeightedString> shortcutTargets, final boolean isNotAWord) { 31672b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard add(getCodePoints(word), frequency, shortcutTargets, isNotAWord, 31772b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard false /* isBlacklistEntry */); 31872b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard } 31972b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard 32072b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard /** 32172b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard * Helper method to add a blacklist entry as a string. 32272b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard * 32372b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard * @param word the word to add as a blacklist entry. 32472b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard * @param shortcutTargets a list of shortcut targets for this word, or null. 32572b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard * @param isNotAWord true if this is not a word for spellcheking purposes (shortcut only or so) 32672b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard */ 32772b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard public void addBlacklistEntry(final String word, 32872b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard final ArrayList<WeightedString> shortcutTargets, final boolean isNotAWord) { 32972b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard add(getCodePoints(word), 0, shortcutTargets, isNotAWord, true /* isBlacklistEntry */); 330bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 331bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 332bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 333bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Sanity check for a node. 334bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 335bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * This method checks that all CharGroups in a node are ordered as expected. 336bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * If they are, nothing happens. If they aren't, an exception is thrown. 337bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 338bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard private void checkStack(Node node) { 339bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard ArrayList<CharGroup> stack = node.mData; 340bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int lastValue = -1; 341bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard for (int i = 0; i < stack.size(); ++i) { 342bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int currentValue = stack.get(i).mChars[0]; 343bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (currentValue <= lastValue) 344bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard throw new RuntimeException("Invalid stack"); 345bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard else 346bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard lastValue = currentValue; 347bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 348bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 349bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 350bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 3517cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * Helper method to add a new bigram to the dictionary. 3527cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * 3537cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * @param word1 the previous word of the context 3547cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * @param word2 the next word of the context 3557cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang * @param frequency the bigram frequency 3567cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang */ 3577cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang public void setBigram(final String word1, final String word2, final int frequency) { 3587cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang CharGroup charGroup = findWordInTree(mRoot, word1); 3597cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (charGroup != null) { 3607cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang final CharGroup charGroup2 = findWordInTree(mRoot, word2); 3617cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang if (charGroup2 == null) { 36272b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard add(getCodePoints(word2), 0, null, false /* isNotAWord */, 36372b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard false /* isBlacklistEntry */); 3647cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 3657cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang charGroup.addBigram(word2, frequency); 3667cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } else { 3677cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang throw new RuntimeException("First word of bigram not found"); 3687cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 3697cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang } 3707cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang 3717cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang /** 372bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Add a word to this dictionary. 373bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 37444c64f46a143623dd793facd889c8d6eab5e230cJean Chalard * The shortcuts, if any, have to be in the dictionary already. If they aren't, 375bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * an exception is thrown. 376bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 377bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @param word the word, as an int array. 378bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @param frequency the frequency of the word, in the range [0..255]. 379eec2e51e2cbc9e69739187557846a439ed74325eJean Chalard * @param shortcutTargets an optional list of shortcut targets for this word (null if none). 38072b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard * @param isNotAWord true if this is not a word for spellcheking purposes (shortcut only or so) 38172b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard * @param isBlacklistEntry true if this is a blacklisted word, false otherwise 382bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 383eec2e51e2cbc9e69739187557846a439ed74325eJean Chalard private void add(final int[] word, final int frequency, 38472b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard final ArrayList<WeightedString> shortcutTargets, 38572b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard final boolean isNotAWord, final boolean isBlacklistEntry) { 386bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard assert(frequency >= 0 && frequency <= 255); 387eae7b293e4a854819aa0de663066cd0b6cdd52e7Yuichiro Hanada if (word.length >= Constants.Dictionary.MAX_WORD_LENGTH) { 388eae7b293e4a854819aa0de663066cd0b6cdd52e7Yuichiro Hanada MakedictLog.w("Ignoring a word that is too long: word.length = " + word.length); 389eae7b293e4a854819aa0de663066cd0b6cdd52e7Yuichiro Hanada return; 390eae7b293e4a854819aa0de663066cd0b6cdd52e7Yuichiro Hanada } 391eae7b293e4a854819aa0de663066cd0b6cdd52e7Yuichiro Hanada 392bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard Node currentNode = mRoot; 393bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int charIndex = 0; 394bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 395bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard CharGroup currentGroup = null; 396bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int differentCharIndex = 0; // Set by the loop to the index of the char that differs 397bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int nodeIndex = findIndexOfChar(mRoot, word[charIndex]); 398bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard while (CHARACTER_NOT_FOUND != nodeIndex) { 399bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard currentGroup = currentNode.mData.get(nodeIndex); 400cad25fc8a754d6f145bc846f17f270220b15c055Jean Chalard differentCharIndex = compareArrays(currentGroup.mChars, word, charIndex); 401bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (ARRAYS_ARE_EQUAL != differentCharIndex 402bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard && differentCharIndex < currentGroup.mChars.length) break; 403bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (null == currentGroup.mChildren) break; 404bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard charIndex += currentGroup.mChars.length; 405bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (charIndex >= word.length) break; 406bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard currentNode = currentGroup.mChildren; 407bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard nodeIndex = findIndexOfChar(currentNode, word[charIndex]); 408bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 409bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 410bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (-1 == nodeIndex) { 411bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // No node at this point to accept the word. Create one. 412bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final int insertionIndex = findInsertionIndex(currentNode, word[charIndex]); 413bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final CharGroup newGroup = new CharGroup( 414eec2e51e2cbc9e69739187557846a439ed74325eJean Chalard Arrays.copyOfRange(word, charIndex, word.length), 41572b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard shortcutTargets, null /* bigrams */, frequency, isNotAWord, isBlacklistEntry); 416bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard currentNode.mData.add(insertionIndex, newGroup); 41747db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard if (DBG) checkStack(currentNode); 418bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } else { 419bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // There is a word with a common prefix. 420bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (differentCharIndex == currentGroup.mChars.length) { 421bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (charIndex + differentCharIndex >= word.length) { 422bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // The new word is a prefix of an existing word, but the node on which it 4237cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang // should end already exists as is. Since the old CharNode was not a terminal, 4247cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang // make it one by filling in its frequency and other attributes 42572b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard currentGroup.update(frequency, shortcutTargets, null, isNotAWord, 42672b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard isBlacklistEntry); 427bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } else { 428bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // The new word matches the full old word and extends past it. 429bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // We only have to create a new node and add it to the end of this. 430bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final CharGroup newNode = new CharGroup( 431bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard Arrays.copyOfRange(word, charIndex + differentCharIndex, word.length), 43272b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard shortcutTargets, null /* bigrams */, frequency, isNotAWord, 43372b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard isBlacklistEntry); 434bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard currentGroup.mChildren = new Node(); 435bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard currentGroup.mChildren.mData.add(newNode); 436bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 437bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } else { 438bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (0 == differentCharIndex) { 4397cfe20efbeb4a94b15291aee95d0559ae2449c45Tom Ouyang // Exact same word. Update the frequency if higher. This will also add the 44044c64f46a143623dd793facd889c8d6eab5e230cJean Chalard // new shortcuts to the existing shortcut list if it already exists. 44172b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard currentGroup.update(frequency, shortcutTargets, null, 44272b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard currentGroup.mIsNotAWord && isNotAWord, 44372b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard currentGroup.mIsBlacklistEntry || isBlacklistEntry); 444bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } else { 445bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // Partial prefix match only. We have to replace the current node with a node 446bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // containing the current prefix and create two new ones for the tails. 447bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard Node newChildren = new Node(); 448bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final CharGroup newOldWord = new CharGroup( 449bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard Arrays.copyOfRange(currentGroup.mChars, differentCharIndex, 450eec2e51e2cbc9e69739187557846a439ed74325eJean Chalard currentGroup.mChars.length), currentGroup.mShortcutTargets, 45172b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard currentGroup.mBigrams, currentGroup.mFrequency, 45272b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard currentGroup.mIsNotAWord, currentGroup.mIsBlacklistEntry, 45372b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard currentGroup.mChildren); 454bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard newChildren.mData.add(newOldWord); 455bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 456bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final CharGroup newParent; 457bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (charIndex + differentCharIndex >= word.length) { 458bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard newParent = new CharGroup( 459bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard Arrays.copyOfRange(currentGroup.mChars, 0, differentCharIndex), 46072b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard shortcutTargets, null /* bigrams */, frequency, 46172b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard isNotAWord, isBlacklistEntry, newChildren); 462bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } else { 463bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard newParent = new CharGroup( 464bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard Arrays.copyOfRange(currentGroup.mChars, 0, differentCharIndex), 46572b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard null /* shortcutTargets */, null /* bigrams */, -1, 46672b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard false /* isNotAWord */, false /* isBlacklistEntry */, newChildren); 46744c64f46a143623dd793facd889c8d6eab5e230cJean Chalard final CharGroup newWord = new CharGroup(Arrays.copyOfRange(word, 46844c64f46a143623dd793facd889c8d6eab5e230cJean Chalard charIndex + differentCharIndex, word.length), 46972b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard shortcutTargets, null /* bigrams */, frequency, 47072b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard isNotAWord, isBlacklistEntry); 471bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final int addIndex = word[charIndex + differentCharIndex] 472bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard > currentGroup.mChars[differentCharIndex] ? 1 : 0; 473bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard newChildren.mData.add(addIndex, newWord); 474bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 475bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard currentNode.mData.set(nodeIndex, newParent); 476bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 47747db0be7cbdb8abafc18c1e49b71f6dac0d46994Jean Chalard if (DBG) checkStack(currentNode); 478bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 479bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 480bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 481bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 48293ebf74bae44728e0d5f7e738ea28376187a876eTadashi G. Takaoka private static int ARRAYS_ARE_EQUAL = 0; 48393ebf74bae44728e0d5f7e738ea28376187a876eTadashi G. Takaoka 484bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 485bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Custom comparison of two int arrays taken to contain character codes. 486bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 487bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * This method compares the two arrays passed as an argument in a lexicographic way, 488bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * with an offset in the dst string. 489bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * This method does NOT test for the first character. It is taken to be equal. 490bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * I repeat: this method starts the comparison at 1 <> dstOffset + 1. 491bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * The index where the strings differ is returned. ARRAYS_ARE_EQUAL = 0 is returned if the 492bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * strings are equal. This works BECAUSE we don't look at the first character. 493bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 494bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @param src the left-hand side string of the comparison. 495bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @param dst the right-hand side string of the comparison. 496bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @param dstOffset the offset in the right-hand side string. 497bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @return the index at which the strings differ, or ARRAYS_ARE_EQUAL = 0 if they don't. 498bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 499bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard private static int compareArrays(final int[] src, final int[] dst, int dstOffset) { 500bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // We do NOT test the first char, because we come from a method that already 501bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // tested it. 502bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard for (int i = 1; i < src.length; ++i) { 503bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (dstOffset + i >= dst.length) return i; 504bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (src[i] != dst[dstOffset + i]) return i; 505bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 506bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (dst.length > src.length) return src.length; 507bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return ARRAYS_ARE_EQUAL; 508bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 509bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 510bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 511bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Helper class that compares and sorts two chargroups according to their 512bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * first element only. I repeat: ONLY the first element is considered, the rest 513bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * is ignored. 514bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * This comparator imposes orderings that are inconsistent with equals. 515bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 5162aa02b84a4fcfaf5554c278d2b25cf9414eecf8bKen Wakasa static private class CharGroupComparator implements java.util.Comparator<CharGroup> { 51793ebf74bae44728e0d5f7e738ea28376187a876eTadashi G. Takaoka @Override 5182aa02b84a4fcfaf5554c278d2b25cf9414eecf8bKen Wakasa public int compare(CharGroup c1, CharGroup c2) { 519bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (c1.mChars[0] == c2.mChars[0]) return 0; 520bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return c1.mChars[0] < c2.mChars[0] ? -1 : 1; 521bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 522bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 523bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final static private CharGroupComparator CHARGROUP_COMPARATOR = new CharGroupComparator(); 524bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 525bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 526bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Finds the insertion index of a character within a node. 527bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 528bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard private static int findInsertionIndex(final Node node, int character) { 5292aa02b84a4fcfaf5554c278d2b25cf9414eecf8bKen Wakasa final ArrayList<CharGroup> data = node.mData; 53044c64f46a143623dd793facd889c8d6eab5e230cJean Chalard final CharGroup reference = new CharGroup(new int[] { character }, 53172b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard null /* shortcutTargets */, null /* bigrams */, 0, false /* isNotAWord */, 53272b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard false /* isBlacklistEntry */); 533bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int result = Collections.binarySearch(data, reference, CHARGROUP_COMPARATOR); 534bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return result >= 0 ? result : -result - 1; 535bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 536bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 53793ebf74bae44728e0d5f7e738ea28376187a876eTadashi G. Takaoka private static int CHARACTER_NOT_FOUND = -1; 53893ebf74bae44728e0d5f7e738ea28376187a876eTadashi G. Takaoka 539bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 540bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Find the index of a char in a node, if it exists. 541bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 542bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @param node the node to search in. 543bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @param character the character to search for. 544bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @return the position of the character if it's there, or CHARACTER_NOT_FOUND = -1 else. 545bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 546bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard private static int findIndexOfChar(final Node node, int character) { 547bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final int insertionIndex = findInsertionIndex(node, character); 548bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (node.mData.size() <= insertionIndex) return CHARACTER_NOT_FOUND; 549bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return character == node.mData.get(insertionIndex).mChars[0] ? insertionIndex 550bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard : CHARACTER_NOT_FOUND; 551bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 552bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 553bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 554bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Helper method to find a word in a given branch. 555bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 556bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public static CharGroup findWordInTree(Node node, final String s) { 557bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int index = 0; 55812efad3d15147f255f6e01600c40e9fdb1224d84Jean Chalard final StringBuilder checker = DBG ? new StringBuilder() : null; 559bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 560bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard CharGroup currentGroup; 561bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard do { 562bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int indexOfGroup = findIndexOfChar(node, s.codePointAt(index)); 563bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (CHARACTER_NOT_FOUND == indexOfGroup) return null; 564bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard currentGroup = node.mData.get(indexOfGroup); 56566f338983bb9cb04a0d94a4729330b1c8ff01c93Yuichiro Hanada 56666f338983bb9cb04a0d94a4729330b1c8ff01c93Yuichiro Hanada if (s.length() - index < currentGroup.mChars.length) return null; 56766f338983bb9cb04a0d94a4729330b1c8ff01c93Yuichiro Hanada int newIndex = index; 56866f338983bb9cb04a0d94a4729330b1c8ff01c93Yuichiro Hanada while (newIndex < s.length() && newIndex - index < currentGroup.mChars.length) { 56966f338983bb9cb04a0d94a4729330b1c8ff01c93Yuichiro Hanada if (currentGroup.mChars[newIndex - index] != s.codePointAt(newIndex)) return null; 57066f338983bb9cb04a0d94a4729330b1c8ff01c93Yuichiro Hanada newIndex++; 57166f338983bb9cb04a0d94a4729330b1c8ff01c93Yuichiro Hanada } 57266f338983bb9cb04a0d94a4729330b1c8ff01c93Yuichiro Hanada index = newIndex; 57366f338983bb9cb04a0d94a4729330b1c8ff01c93Yuichiro Hanada 57412efad3d15147f255f6e01600c40e9fdb1224d84Jean Chalard if (DBG) checker.append(new String(currentGroup.mChars, 0, currentGroup.mChars.length)); 575bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (index < s.length()) { 576bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard node = currentGroup.mChildren; 577bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 578bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } while (null != node && index < s.length()); 579bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 58066f338983bb9cb04a0d94a4729330b1c8ff01c93Yuichiro Hanada if (index < s.length()) return null; 5810d35c159fefd7591c2ab9d5037c32d1804024197Yuichiro Hanada if (!currentGroup.isTerminal()) return null; 58212efad3d15147f255f6e01600c40e9fdb1224d84Jean Chalard if (DBG && !s.equals(checker.toString())) return null; 583bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return currentGroup; 584bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 585bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 586bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 587eddfbb68dcff55c85b3d5b82d406f543bd038825Jean Chalard * Helper method to find out whether a word is in the dict or not. 588eddfbb68dcff55c85b3d5b82d406f543bd038825Jean Chalard */ 589eddfbb68dcff55c85b3d5b82d406f543bd038825Jean Chalard public boolean hasWord(final String s) { 590eddfbb68dcff55c85b3d5b82d406f543bd038825Jean Chalard if (null == s || "".equals(s)) { 591eddfbb68dcff55c85b3d5b82d406f543bd038825Jean Chalard throw new RuntimeException("Can't search for a null or empty string"); 592eddfbb68dcff55c85b3d5b82d406f543bd038825Jean Chalard } 593eddfbb68dcff55c85b3d5b82d406f543bd038825Jean Chalard return null != findWordInTree(mRoot, s); 594eddfbb68dcff55c85b3d5b82d406f543bd038825Jean Chalard } 595eddfbb68dcff55c85b3d5b82d406f543bd038825Jean Chalard 596eddfbb68dcff55c85b3d5b82d406f543bd038825Jean Chalard /** 597bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Recursively count the number of character groups in a given branch of the trie. 598bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 599bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @param node the parent node. 600bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @return the number of char groups in all the branch under this node. 601bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 602bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public static int countCharGroups(final Node node) { 603bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final int nodeSize = node.mData.size(); 604bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int size = nodeSize; 605bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard for (int i = nodeSize - 1; i >= 0; --i) { 606bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard CharGroup group = node.mData.get(i); 607bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (null != group.mChildren) 608bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard size += countCharGroups(group.mChildren); 609bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 610bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return size; 611bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 612bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 613bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 614bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Recursively count the number of nodes in a given branch of the trie. 615bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 616bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * @param node the node to count. 61720a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard * @return the number of nodes in this branch. 618bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 619bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public static int countNodes(final Node node) { 620bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard int size = 1; 621bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard for (int i = node.mData.size() - 1; i >= 0; --i) { 622bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard CharGroup group = node.mData.get(i); 623bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (null != group.mChildren) 624bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard size += countNodes(group.mChildren); 625bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 626bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return size; 627bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 628bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 62920a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard // Recursively find out whether there are any bigrams. 63020a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard // This can be pretty expensive especially if there aren't any (we return as soon 63120a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard // as we find one, so it's much cheaper if there are bigrams) 63220a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard private static boolean hasBigramsInternal(final Node node) { 63320a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard if (null == node) return false; 63420a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard for (int i = node.mData.size() - 1; i >= 0; --i) { 63520a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard CharGroup group = node.mData.get(i); 63620a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard if (null != group.mBigrams) return true; 63720a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard if (hasBigramsInternal(group.mChildren)) return true; 63820a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard } 63920a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard return false; 64020a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard } 64120a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard 64220a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard /** 64320a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard * Finds out whether there are any bigrams in this dictionary. 64420a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard * 64520a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard * @return true if there is any bigram, false otherwise. 64620a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard */ 64720a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard // TODO: this is expensive especially for large dictionaries without any bigram. 64820a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard // The up side is, this is always accurate and correct and uses no memory. We should 64920a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard // find a more efficient way of doing this, without compromising too much on memory 65020a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard // and ease of use. 65120a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard public boolean hasBigrams() { 65220a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard return hasBigramsInternal(mRoot); 65320a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard } 65420a6dea1cabfd8822824f7dca828d898e5b91cbcJean Chalard 655bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // Historically, the tails of the words were going to be merged to save space. 656bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // However, that would prevent the code to search for a specific address in log(n) 657bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // time so this was abandoned. 658bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // The code is still of interest as it does add some compression to any dictionary 659bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // that has no need for attributes. Implementations that does not read attributes should be 660bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // able to read a dictionary with merged tails. 661bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // Also, the following code does support frequencies, as in, it will only merges 662bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // tails that share the same frequency. Though it would result in the above loss of 663bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // performance while searching by address, it is still technically possible to merge 664bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // tails that contain attributes, but this code does not take that into account - it does 665bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // not compare attributes and will merge terminals with different attributes regardless. 666bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public void mergeTails() { 667bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard MakedictLog.i("Do not merge tails"); 668bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return; 669bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 670bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// MakedictLog.i("Merging nodes. Number of nodes : " + countNodes(root)); 671bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// MakedictLog.i("Number of groups : " + countCharGroups(root)); 672bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// 673bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// final HashMap<String, ArrayList<Node>> repository = 674bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// new HashMap<String, ArrayList<Node>>(); 675bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// mergeTailsInner(repository, root); 676bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// 677bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// MakedictLog.i("Number of different pseudohashes : " + repository.size()); 678bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// int size = 0; 679bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// for (ArrayList<Node> a : repository.values()) { 680bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// size += a.size(); 681bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// } 682bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// MakedictLog.i("Number of nodes after merge : " + (1 + size)); 683bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// MakedictLog.i("Recursively seen nodes : " + countNodes(root)); 684bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 685bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 686bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard // The following methods are used by the deactivated mergeTails() 687bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// private static boolean isEqual(Node a, Node b) { 688bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// if (null == a && null == b) return true; 689bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// if (null == a || null == b) return false; 690bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// if (a.data.size() != b.data.size()) return false; 691bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// final int size = a.data.size(); 692bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// for (int i = size - 1; i >= 0; --i) { 693bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// CharGroup aGroup = a.data.get(i); 694bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// CharGroup bGroup = b.data.get(i); 695bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// if (aGroup.frequency != bGroup.frequency) return false; 696bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// if (aGroup.alternates == null && bGroup.alternates != null) return false; 697bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// if (aGroup.alternates != null && !aGroup.equals(bGroup.alternates)) return false; 698bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// if (!Arrays.equals(aGroup.chars, bGroup.chars)) return false; 699bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// if (!isEqual(aGroup.children, bGroup.children)) return false; 700bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// } 701bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// return true; 702bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// } 703bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 704bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// static private HashMap<String, ArrayList<Node>> mergeTailsInner( 705bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// final HashMap<String, ArrayList<Node>> map, final Node node) { 706bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// final ArrayList<CharGroup> branches = node.data; 707bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// final int nodeSize = branches.size(); 708bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// for (int i = 0; i < nodeSize; ++i) { 709bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// CharGroup group = branches.get(i); 710bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// if (null != group.children) { 711bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// String pseudoHash = getPseudoHash(group.children); 712bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// ArrayList<Node> similarList = map.get(pseudoHash); 713bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// if (null == similarList) { 714bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// similarList = new ArrayList<Node>(); 715bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// map.put(pseudoHash, similarList); 716bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// } 717bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// boolean merged = false; 718bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// for (Node similar : similarList) { 719bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// if (isEqual(group.children, similar)) { 720bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// group.children = similar; 721bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// merged = true; 722bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// break; 723bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// } 724bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// } 725bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// if (!merged) { 726bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// similarList.add(group.children); 727bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// } 728bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// mergeTailsInner(map, group.children); 729bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// } 730bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// } 731bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// return map; 732bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// } 733bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 734bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// private static String getPseudoHash(final Node node) { 735bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// StringBuilder s = new StringBuilder(); 736bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// for (CharGroup g : node.data) { 737bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// s.append(g.frequency); 738f2789819bd005b5b0581e8439601b5501306327dKen Wakasa// for (int ch : g.chars) { 739bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// s.append(Character.toChars(ch)); 740bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// } 741bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// } 742bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// return s.toString(); 743bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard// } 744bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 745bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 746bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Iterator to walk through a dictionary. 747bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 748bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * This is purely for convenience. 749bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 750bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public static class DictionaryIterator implements Iterator<Word> { 751bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 752bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard private static class Position { 753bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public Iterator<CharGroup> pos; 754bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public int length; 755bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public Position(ArrayList<CharGroup> groups) { 756bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard pos = groups.iterator(); 757bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard length = 0; 758bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 759bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 760bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final StringBuilder mCurrentString; 761bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final LinkedList<Position> mPositions; 762bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 763bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public DictionaryIterator(ArrayList<CharGroup> root) { 764bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mCurrentString = new StringBuilder(); 765bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mPositions = new LinkedList<Position>(); 766bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final Position rootPos = new Position(root); 767bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mPositions.add(rootPos); 768bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 769bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 770bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard @Override 771bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public boolean hasNext() { 772bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard for (Position p : mPositions) { 773bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (p.pos.hasNext()) { 774bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return true; 775bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 776bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 777bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return false; 778bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 779bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 780bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard @Override 781bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public Word next() { 782bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard Position currentPos = mPositions.getLast(); 783bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mCurrentString.setLength(mCurrentString.length() - currentPos.length); 784bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 785bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard do { 786bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (currentPos.pos.hasNext()) { 787bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard final CharGroup currentGroup = currentPos.pos.next(); 788bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard currentPos.length = currentGroup.mChars.length; 789bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard for (int i : currentGroup.mChars) 790bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mCurrentString.append(Character.toChars(i)); 791bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (null != currentGroup.mChildren) { 792bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard currentPos = new Position(currentGroup.mChildren.mData); 793bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mPositions.addLast(currentPos); 794bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 795bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard if (currentGroup.mFrequency >= 0) 796bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return new Word(mCurrentString.toString(), currentGroup.mFrequency, 79772b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard currentGroup.mShortcutTargets, currentGroup.mBigrams, 79872b1c9394105b6fbc0d8c6ff00f3574ee37a9aaaJean Chalard currentGroup.mIsNotAWord, currentGroup.mIsBlacklistEntry); 799bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } else { 800bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mPositions.removeLast(); 801bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard currentPos = mPositions.getLast(); 802bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard mCurrentString.setLength(mCurrentString.length() - mPositions.getLast().length); 803bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 804f2789819bd005b5b0581e8439601b5501306327dKen Wakasa } while (true); 805bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 806bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 807bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard @Override 808bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public void remove() { 809bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard throw new UnsupportedOperationException("Unsupported yet"); 810bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 811bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 812bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 813bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard 814bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard /** 815bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * Method to return an iterator. 816bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * 817bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * This method enables Java's enhanced for loop. With this you can have a FusionDictionary x 818bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard * and say : for (Word w : x) {} 819bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard */ 820bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard @Override 821bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard public Iterator<Word> iterator() { 822bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard return new DictionaryIterator(mRoot.mData); 823bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard } 824bfbbee8c5757aef4a20879547c16af0a4d1bf4c7Jean Chalard} 825