PrevWordsInfo.java revision 1c2f1ada8305e36defa8572da687a4596bf083ea
183c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi/* 283c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi * Copyright (C) 2014 The Android Open Source Project 383c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi * 483c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi * Licensed under the Apache License, Version 2.0 (the "License"); 583c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi * you may not use this file except in compliance with the License. 683c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi * You may obtain a copy of the License at 783c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi * 883c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi * http://www.apache.org/licenses/LICENSE-2.0 983c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi * 1083c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi * Unless required by applicable law or agreed to in writing, software 1183c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi * distributed under the License is distributed on an "AS IS" BASIS, 1283c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1383c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi * See the License for the specific language governing permissions and 1483c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi * limitations under the License. 1583c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi */ 1683c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi 1783c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagipackage com.android.inputmethod.latin; 1883c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi 19e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagiimport java.util.Arrays; 20e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi 21e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagiimport com.android.inputmethod.latin.utils.StringUtils; 22e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi 23a790c5b68324da41428aeb68594d43ca5632f66dKeisuke Kuroyanagi/** 24a790c5b68324da41428aeb68594d43ca5632f66dKeisuke Kuroyanagi * Class to represent information of previous words. This class is used to add n-gram entries 25a790c5b68324da41428aeb68594d43ca5632f66dKeisuke Kuroyanagi * into binary dictionaries, to get predictions, and to get suggestions. 26a790c5b68324da41428aeb68594d43ca5632f66dKeisuke Kuroyanagi */ 2783c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagipublic class PrevWordsInfo { 28e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public static final PrevWordsInfo EMPTY_PREV_WORDS_INFO = 29e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi new PrevWordsInfo(WordInfo.EMPTY_WORD_INFO); 301c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi public static final PrevWordsInfo BEGINNING_OF_SENTENCE = 311c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi new PrevWordsInfo(WordInfo.BEGINNING_OF_SENTENCE); 321adca93381d261a6070be2721dbf8b8abafbfe01Keisuke Kuroyanagi 33e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi /** 34e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi * Word information used to represent previous words information. 35e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi */ 36e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public static class WordInfo { 37e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public static final WordInfo EMPTY_WORD_INFO = new WordInfo(null); 38e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public static final WordInfo BEGINNING_OF_SENTENCE = new WordInfo(); 39e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi 40e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // This is an empty string when mIsBeginningOfSentence is true. 41e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public final String mWord; 42e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // TODO: Have sentence separator. 43e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // Whether the current context is beginning of sentence or not. This is true when composing 44e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // at the beginning of an input field or composing a word after a sentence separator. 45e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public final boolean mIsBeginningOfSentence; 46e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi 47e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // Beginning of sentence. 48e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public WordInfo() { 49e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi mWord = ""; 50e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi mIsBeginningOfSentence = true; 51e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi } 52e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi 53e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public WordInfo(final String word) { 54e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi mWord = word; 55e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi mIsBeginningOfSentence = false; 56e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi } 57e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi 58e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public boolean isValid() { 59e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi return mWord != null; 60e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi } 611c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi 621c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi @Override 631c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi public int hashCode() { 641c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi return Arrays.hashCode(new Object[] { mWord, mIsBeginningOfSentence } ); 651c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi } 661c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi 671c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi @Override 681c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi public boolean equals(Object o) { 691c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi if (this == o) return true; 701c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi if (!(o instanceof WordInfo)) return false; 711c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi final WordInfo wordInfo = (WordInfo)o; 721c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi if (mWord == null || wordInfo.mWord == null) { 731c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi return mWord == wordInfo.mWord 741c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi && mIsBeginningOfSentence == wordInfo.mIsBeginningOfSentence; 751c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi } 761c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi return mWord.equals(wordInfo.mWord) 771c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi && mIsBeginningOfSentence == wordInfo.mIsBeginningOfSentence; 781c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi } 79e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi } 8083c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi 81e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // The words immediately before the considered word. EMPTY_WORD_INFO element means we don't 82e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // have any context for that previous word including the "beginning of sentence context" - we 83e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // just don't know what to predict using the information. An example of that is after a comma. 84e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // For simplicity of implementation, elements may also be EMPTY_WORD_INFO transiently after the 85e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // WordComposer was reset and before starting a new composing word, but we should never be 86e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // calling getSuggetions* in this situation. 87e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public WordInfo[] mPrevWordsInfo = new WordInfo[Constants.MAX_PREV_WORD_COUNT_FOR_N_GRAM]; 8817f326b7458c2bde2569e283a96e703755485328Keisuke Kuroyanagi 89e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // Construct from the previous word information. 90e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public PrevWordsInfo(final WordInfo prevWordInfo) { 91e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi mPrevWordsInfo[0] = prevWordInfo; 92e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi } 93e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi 94e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // Construct from WordInfo array. n-th element represents (n+1)-th previous word's information. 95e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public PrevWordsInfo(final WordInfo[] prevWordsInfo) { 96e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi for (int i = 0; i < Constants.MAX_PREV_WORD_COUNT_FOR_N_GRAM; i++) { 97e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi mPrevWordsInfo[i] = 98e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi (prevWordsInfo.length > i) ? prevWordsInfo[i] : WordInfo.EMPTY_WORD_INFO; 99e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi } 100e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi } 101e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi 102e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi // Create next prevWordsInfo using current prevWordsInfo. 103e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public PrevWordsInfo getNextPrevWordsInfo(final WordInfo wordInfo) { 104e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi final WordInfo[] prevWordsInfo = new WordInfo[Constants.MAX_PREV_WORD_COUNT_FOR_N_GRAM]; 105e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi prevWordsInfo[0] = wordInfo; 106e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi for (int i = 1; i < prevWordsInfo.length; i++) { 107e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi prevWordsInfo[i] = mPrevWordsInfo[i - 1]; 108e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi } 109e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi return new PrevWordsInfo(prevWordsInfo); 11083c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi } 1111adca93381d261a6070be2721dbf8b8abafbfe01Keisuke Kuroyanagi 1121adca93381d261a6070be2721dbf8b8abafbfe01Keisuke Kuroyanagi public boolean isValid() { 113e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi return mPrevWordsInfo[0].isValid(); 114e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi } 115e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi 116e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi public void outputToArray(final int[][] codePointArrays, 117e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi final boolean[] isBeginningOfSentenceArray) { 118e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi for (int i = 0; i < mPrevWordsInfo.length; i++) { 119e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi final WordInfo wordInfo = mPrevWordsInfo[i]; 120e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi if (wordInfo == null || !wordInfo.isValid()) { 121e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi codePointArrays[i] = new int[0]; 122e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi isBeginningOfSentenceArray[i] = false; 123e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi continue; 124e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi } 125e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi codePointArrays[i] = StringUtils.toCodePointArray(wordInfo.mWord); 126e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi isBeginningOfSentenceArray[i] = wordInfo.mIsBeginningOfSentence; 127e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi } 1281adca93381d261a6070be2721dbf8b8abafbfe01Keisuke Kuroyanagi } 129dfca51726e9dc9a35f462dee39331823eafa07c9Keisuke Kuroyanagi 130dfca51726e9dc9a35f462dee39331823eafa07c9Keisuke Kuroyanagi @Override 1311c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi public int hashCode() { 1321c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi return Arrays.hashCode(mPrevWordsInfo); 1331c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi } 1341c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi 1351c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi @Override 1361c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi public boolean equals(Object o) { 1371c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi if (this == o) return true; 1381c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi if (!(o instanceof PrevWordsInfo)) return false; 1391c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi final PrevWordsInfo prevWordsInfo = (PrevWordsInfo)o; 1401c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi return Arrays.equals(mPrevWordsInfo, prevWordsInfo.mPrevWordsInfo); 1411c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi } 1421c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi 1431c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi @Override 144dfca51726e9dc9a35f462dee39331823eafa07c9Keisuke Kuroyanagi public String toString() { 145e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi final StringBuffer builder = new StringBuffer(); 146e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi for (int i = 0; i < mPrevWordsInfo.length; i++) { 147e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi final WordInfo wordInfo = mPrevWordsInfo[i]; 148e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi builder.append("PrevWord["); 149e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi builder.append(i); 150e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi builder.append("]: "); 1511c2f1ada8305e36defa8572da687a4596bf083eaKeisuke Kuroyanagi if (wordInfo == null || !wordInfo.isValid()) { 152e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi builder.append("Empty. "); 153e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi continue; 154e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi } 155e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi builder.append(wordInfo.mWord); 156e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi builder.append(", isBeginningOfSentence: "); 157e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi builder.append(wordInfo.mIsBeginningOfSentence); 158e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi builder.append(". "); 159e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi } 160e708b1bc2e11285ad404133b8de21719ce08acb5Keisuke Kuroyanagi return builder.toString(); 161dfca51726e9dc9a35f462dee39331823eafa07c9Keisuke Kuroyanagi } 16283c40a2301a0b5a42a75eecada48e7887a7c940eKeisuke Kuroyanagi} 163