diff options
-rw-r--r-- | native/src/bigram_dictionary.cpp | 233 | ||||
-rw-r--r-- | native/src/bigram_dictionary.h | 27 | ||||
-rw-r--r-- | native/src/defines.h | 53 | ||||
-rw-r--r-- | native/src/dictionary.cpp | 61 | ||||
-rw-r--r-- | native/src/dictionary.h | 96 | ||||
-rw-r--r-- | native/src/unigram_dictionary.cpp | 411 | ||||
-rw-r--r-- | native/src/unigram_dictionary.h | 55 |
7 files changed, 473 insertions, 463 deletions
diff --git a/native/src/bigram_dictionary.cpp b/native/src/bigram_dictionary.cpp index 4d9a612a5..095b80531 100644 --- a/native/src/bigram_dictionary.cpp +++ b/native/src/bigram_dictionary.cpp @@ -15,17 +15,240 @@ ** limitations under the License. */ +#include <string.h> + +#define LOG_TAG "LatinIME: bigram_dictionary.cpp" + #include "bigram_dictionary.h" +#include "dictionary.h" namespace latinime { -BigramDictionary::BigramDictionary(void *dict, int typedLetterMultiplier, int fullWordMultiplier, - int maxWordLength, int maxWords, int maxAlternatives, Dictionary *parentDictionary) -{ +BigramDictionary::BigramDictionary(const unsigned char *dict, int maxWordLength, + int maxAlternatives, const bool isLatestDictVersion, const bool hasBigram, + Dictionary *parentDictionary) + : DICT(dict), MAX_WORD_LENGTH(maxWordLength), + MAX_ALTERNATIVES(maxAlternatives), IS_LATEST_DICT_VERSION(isLatestDictVersion), + HAS_BIGRAM(hasBigram), mParentDictionary(parentDictionary) { + LOGI("BigramDictionary - constructor"); + LOGI("Has Bigram : %d \n", hasBigram); +} + +BigramDictionary::~BigramDictionary() { } -BigramDictionary::~BigramDictionary() -{ +bool BigramDictionary::addWordBigram(unsigned short *word, int length, int frequency) { + word[length] = 0; + if (DEBUG_DICT) { + char s[length + 1]; + for (int i = 0; i <= length; i++) s[i] = word[i]; + LOGI("Bigram: Found word = %s, freq = %d : \n", s, frequency); + } + + // Find the right insertion point + int insertAt = 0; + while (insertAt < mMaxBigrams) { + if (frequency > mBigramFreq[insertAt] || (mBigramFreq[insertAt] == frequency + && length < Dictionary::wideStrLen(mBigramChars + insertAt * MAX_WORD_LENGTH))) { + break; + } + insertAt++; + } + LOGI("Bigram: InsertAt -> %d maxBigrams: %d\n", insertAt, mMaxBigrams); + if (insertAt < mMaxBigrams) { + memmove((char*) mBigramFreq + (insertAt + 1) * sizeof(mBigramFreq[0]), + (char*) mBigramFreq + insertAt * sizeof(mBigramFreq[0]), + (mMaxBigrams - insertAt - 1) * sizeof(mBigramFreq[0])); + mBigramFreq[insertAt] = frequency; + memmove((char*) mBigramChars + (insertAt + 1) * MAX_WORD_LENGTH * sizeof(short), + (char*) mBigramChars + (insertAt ) * MAX_WORD_LENGTH * sizeof(short), + (mMaxBigrams - insertAt - 1) * sizeof(short) * MAX_WORD_LENGTH); + unsigned short *dest = mBigramChars + (insertAt ) * MAX_WORD_LENGTH; + while (length--) { + *dest++ = *word++; + } + *dest = 0; // NULL terminate + if (DEBUG_DICT) LOGI("Bigram: Added word at %d\n", insertAt); + return true; + } + return false; } + +int BigramDictionary::getBigramAddress(int *pos, bool advance) { + int address = 0; + + address += (DICT[*pos] & 0x3F) << 16; + address += (DICT[*pos + 1] & 0xFF) << 8; + address += (DICT[*pos + 2] & 0xFF); + + if (advance) { + *pos += 3; + } + + return address; +} + +int BigramDictionary::getBigramFreq(int *pos) { + int freq = DICT[(*pos)++] & FLAG_BIGRAM_FREQ; + + return freq; +} + + +int BigramDictionary::getBigrams(unsigned short *prevWord, int prevWordLength, int *codes, + int codesSize, unsigned short *bigramChars, int *bigramFreq, int maxWordLength, + int maxBigrams, int maxAlternatives) { + mBigramFreq = bigramFreq; + mBigramChars = bigramChars; + mInputCodes = codes; + mInputLength = codesSize; + mMaxBigrams = maxBigrams; + + if (HAS_BIGRAM && IS_LATEST_DICT_VERSION) { + int pos = mParentDictionary->isValidWordRec( + DICTIONARY_HEADER_SIZE, prevWord, 0, prevWordLength); + LOGI("Pos -> %d\n", pos); + if (pos < 0) { + return 0; + } + + int bigramCount = 0; + int bigramExist = (DICT[pos] & FLAG_BIGRAM_READ); + if (bigramExist > 0) { + int nextBigramExist = 1; + while (nextBigramExist > 0 && bigramCount < maxBigrams) { + int bigramAddress = getBigramAddress(&pos, true); + int frequency = (FLAG_BIGRAM_FREQ & DICT[pos]); + // search for all bigrams and store them + searchForTerminalNode(bigramAddress, frequency); + nextBigramExist = (DICT[pos++] & FLAG_BIGRAM_CONTINUED); + bigramCount++; + } + } + + return bigramCount; + } + return 0; +} + +void BigramDictionary::searchForTerminalNode(int addressLookingFor, int frequency) { + // track word with such address and store it in an array + unsigned short word[MAX_WORD_LENGTH]; + + int pos; + int followDownBranchAddress = DICTIONARY_HEADER_SIZE; + bool found = false; + char followingChar = ' '; + int depth = -1; + + while(!found) { + bool followDownAddressSearchStop = false; + bool firstAddress = true; + bool haveToSearchAll = true; + + if (depth >= 0) { + word[depth] = (unsigned short) followingChar; + } + pos = followDownBranchAddress; // pos start at count + int count = DICT[pos] & 0xFF; + LOGI("count - %d\n",count); + pos++; + for (int i = 0; i < count; i++) { + // pos at data + pos++; + // pos now at flag + if (!getFirstBitOfByte(&pos)) { // non-terminal + if (!followDownAddressSearchStop) { + int addr = getBigramAddress(&pos, false); + if (addr > addressLookingFor) { + followDownAddressSearchStop = true; + if (firstAddress) { + firstAddress = false; + haveToSearchAll = true; + } else if (!haveToSearchAll) { + break; + } + } else { + followDownBranchAddress = addr; + followingChar = (char)(0xFF & DICT[pos-1]); + if (firstAddress) { + firstAddress = false; + haveToSearchAll = false; + } + } + } + pos += 3; + } else if (getFirstBitOfByte(&pos)) { // terminal + if (addressLookingFor == (pos-1)) { // found !! + depth++; + word[depth] = (0xFF & DICT[pos-1]); + found = true; + break; + } + if (getSecondBitOfByte(&pos)) { // address + freq (4 byte) + if (!followDownAddressSearchStop) { + int addr = getBigramAddress(&pos, false); + if (addr > addressLookingFor) { + followDownAddressSearchStop = true; + if (firstAddress) { + firstAddress = false; + haveToSearchAll = true; + } else if (!haveToSearchAll) { + break; + } + } else { + followDownBranchAddress = addr; + followingChar = (char)(0xFF & DICT[pos-1]); + if (firstAddress) { + firstAddress = false; + haveToSearchAll = true; + } + } + } + pos += 4; + } else { // freq only (2 byte) + pos += 2; + } + + // skipping bigram + int bigramExist = (DICT[pos] & FLAG_BIGRAM_READ); + if (bigramExist > 0) { + int nextBigramExist = 1; + while (nextBigramExist > 0) { + pos += 3; + nextBigramExist = (DICT[pos++] & FLAG_BIGRAM_CONTINUED); + } + } else { + pos++; + } + } + } + depth++; + if (followDownBranchAddress == 0) { + LOGI("ERROR!!! Cannot find bigram!!"); + break; + } + } + if (checkFirstCharacter(word)) { + addWordBigram(word, depth, frequency); + } +} + +bool BigramDictionary::checkFirstCharacter(unsigned short *word) { + // Checks whether this word starts with same character or neighboring characters of + // what user typed. + + int *inputCodes = mInputCodes; + int maxAlt = MAX_ALTERNATIVES; + while (maxAlt > 0) { + if ((unsigned int) *inputCodes == (unsigned int) *word) { + return true; + } + inputCodes++; + maxAlt--; + } + return false; +} + // TODO: Move functions related to bigram to here } // namespace latinime diff --git a/native/src/bigram_dictionary.h b/native/src/bigram_dictionary.h index 98146a0e7..d658b93e6 100644 --- a/native/src/bigram_dictionary.h +++ b/native/src/bigram_dictionary.h @@ -22,10 +22,33 @@ namespace latinime { class Dictionary; class BigramDictionary { public: - BigramDictionary(void *dict, int typedLetterMultipler, int fullWordMultiplier, int maxWordLength, - int maxWords, int maxAlternatives, Dictionary *parentDictionary); + BigramDictionary(const unsigned char *dict, int maxWordLength, int maxAlternatives, + const bool isLatestDictVersion, const bool hasBigram, Dictionary *parentDictionary); + int getBigrams(unsigned short *word, int length, int *codes, int codesSize, + unsigned short *outWords, int *frequencies, int maxWordLength, int maxBigrams, + int maxAlternatives); ~BigramDictionary(); private: + bool addWordBigram(unsigned short *word, int length, int frequency); + int getBigramAddress(int *pos, bool advance); + int getBigramFreq(int *pos); + void searchForTerminalNode(int addressLookingFor, int frequency); + bool getFirstBitOfByte(int *pos) { return (DICT[*pos] & 0x80) > 0; } + bool getSecondBitOfByte(int *pos) { return (DICT[*pos] & 0x40) > 0; } + bool checkFirstCharacter(unsigned short *word); + + const unsigned char *DICT; + const int MAX_WORD_LENGTH; + const int MAX_ALTERNATIVES; + const bool IS_LATEST_DICT_VERSION; + const bool HAS_BIGRAM; + + Dictionary *mParentDictionary; + int *mBigramFreq; + int mMaxBigrams; + unsigned short *mBigramChars; + int *mInputCodes; + int mInputLength; }; // ---------------------------------------------------------------------------- }; // namespace latinime diff --git a/native/src/defines.h b/native/src/defines.h new file mode 100644 index 000000000..aaaf3483d --- /dev/null +++ b/native/src/defines.h @@ -0,0 +1,53 @@ +/* +** +** Copyright 2010, The Android Open Source Project +** +** Licensed under the Apache License, Version 2.0 (the "License"); +** you may not use this file except in compliance with the License. +** You may obtain a copy of the License at +** +** http://www.apache.org/licenses/LICENSE-2.0 +** +** Unless required by applicable law or agreed to in writing, software +** distributed under the License is distributed on an "AS IS" BASIS, +** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +** See the License for the specific language governing permissions and +** limitations under the License. +*/ + +#ifndef LATINIME_DEFINES_H +#define LATINIME_DEFINES_H + +#ifdef FLAG_DBG +#include <cutils/log.h> +#ifndef LOG_TAG +#define LOG_TAG "LatinIME: " +#endif +#define DEBUG_DICT 1 +#else // FLAG_DBG +#define LOGI +#define DEBUG_DICT 0 +#endif // FLAG_DBG + +// 22-bit address = ~4MB dictionary size limit, which on average would be about 200k-300k words +#define ADDRESS_MASK 0x3FFFFF + +// The bit that decides if an address follows in the next 22 bits +#define FLAG_ADDRESS_MASK 0x40 +// The bit that decides if this is a terminal node for a word. The node could still have children, +// if the word has other endings. +#define FLAG_TERMINAL_MASK 0x80 + +#define FLAG_BIGRAM_READ 0x80 +#define FLAG_BIGRAM_CHILDEXIST 0x40 +#define FLAG_BIGRAM_CONTINUED 0x80 +#define FLAG_BIGRAM_FREQ 0x7F + +#define DICTIONARY_VERSION_MIN 200 +#define DICTIONARY_HEADER_SIZE 2 +#define NOT_VALID_WORD -99 + +#define SUGGEST_MISSING_CHARACTERS true +#define SUGGEST_MISSING_CHARACTERS_THRESHOLD 5 + +#endif // LATINIME_DEFINES_H diff --git a/native/src/dictionary.cpp b/native/src/dictionary.cpp index a21b80a48..05692f7ef 100644 --- a/native/src/dictionary.cpp +++ b/native/src/dictionary.cpp @@ -17,17 +17,23 @@ #include <stdio.h> +#define LOG_TAG "LatinIME: dictionary.cpp" + #include "dictionary.h" namespace latinime { Dictionary::Dictionary(void *dict, int typedLetterMultiplier, int fullWordMultiplier, int maxWordLength, int maxWords, int maxAlternatives) + : DICT((unsigned char*) dict), + // Checks whether it has the latest dictionary or the old dictionary + IS_LATEST_DICT_VERSION((((unsigned char*) dict)[0] & 0xFF) >= DICTIONARY_VERSION_MIN) { - mUnigramDictionary = new UnigramDictionary(dict, typedLetterMultiplier, fullWordMultiplier, - maxWordLength, maxWords, maxAlternatives, this); - mBigramDictionary = new BigramDictionary(dict, typedLetterMultiplier, fullWordMultiplier, - maxWordLength, maxWords, maxAlternatives, this); + LOGI("IN NATIVE SUGGEST Version: %d \n", (DICT[0] & 0xFF)); + mUnigramDictionary = new UnigramDictionary(DICT, typedLetterMultiplier, fullWordMultiplier, + maxWordLength, maxWords, maxAlternatives, IS_LATEST_DICT_VERSION); + mBigramDictionary = new BigramDictionary(DICT, maxWordLength, maxAlternatives, + IS_LATEST_DICT_VERSION, hasBigram(), this); } Dictionary::~Dictionary() @@ -35,4 +41,51 @@ Dictionary::~Dictionary() delete mUnigramDictionary; delete mBigramDictionary; } + +bool Dictionary::hasBigram() { + return ((DICT[1] & 0xFF) == 1); +} + +// TODO: use uint16_t instead of unsigned short +bool Dictionary::isValidWord(unsigned short *word, int length) +{ + if (IS_LATEST_DICT_VERSION) { + return (isValidWordRec(DICTIONARY_HEADER_SIZE, word, 0, length) != NOT_VALID_WORD); + } else { + return (isValidWordRec(0, word, 0, length) != NOT_VALID_WORD); + } +} + +int Dictionary::isValidWordRec(int pos, unsigned short *word, int offset, int length) { + // returns address of bigram data of that word + // return -99 if not found + + int count = Dictionary::getCount(DICT, &pos); + unsigned short currentChar = (unsigned short) word[offset]; + for (int j = 0; j < count; j++) { + unsigned short c = Dictionary::getChar(DICT, &pos); + int terminal = Dictionary::getTerminal(DICT, &pos); + int childPos = Dictionary::getAddress(DICT, &pos); + if (c == currentChar) { + if (offset == length - 1) { + if (terminal) { + return (pos+1); + } + } else { + if (childPos != 0) { + int t = isValidWordRec(childPos, word, offset + 1, length); + if (t > 0) { + return t; + } + } + } + } + if (terminal) { + Dictionary::getFreq(DICT, IS_LATEST_DICT_VERSION, &pos); + } + // There could be two instances of each alphabet - upper and lower case. So continue + // looking ... + } + return NOT_VALID_WORD; +} } // namespace latinime diff --git a/native/src/dictionary.h b/native/src/dictionary.h index 4c1f8837c..1cd517cfb 100644 --- a/native/src/dictionary.h +++ b/native/src/dictionary.h @@ -18,24 +18,11 @@ #define LATINIME_DICTIONARY_H #include "bigram_dictionary.h" +#include "defines.h" #include "unigram_dictionary.h" namespace latinime { -// 22-bit address = ~4MB dictionary size limit, which on average would be about 200k-300k words -#define ADDRESS_MASK 0x3FFFFF - -// The bit that decides if an address follows in the next 22 bits -#define FLAG_ADDRESS_MASK 0x40 -// The bit that decides if this is a terminal node for a word. The node could still have children, -// if the word has other endings. -#define FLAG_TERMINAL_MASK 0x80 - -#define FLAG_BIGRAM_READ 0x80 -#define FLAG_BIGRAM_CHILDEXIST 0x40 -#define FLAG_BIGRAM_CONTINUED 0x80 -#define FLAG_BIGRAM_FREQ 0x7F - class Dictionary { public: Dictionary(void *dict, int typedLetterMultipler, int fullWordMultiplier, int maxWordLength, @@ -50,24 +37,95 @@ public: int getBigrams(unsigned short *word, int length, int *codes, int codesSize, unsigned short *outWords, int *frequencies, int maxWordLength, int maxBigrams, int maxAlternatives) { - return mUnigramDictionary->getBigrams(word, length, codes, codesSize, outWords, frequencies, + return mBigramDictionary->getBigrams(word, length, codes, codesSize, outWords, frequencies, maxWordLength, maxBigrams, maxAlternatives); } - bool isValidWord(unsigned short *word, int length) { - return mUnigramDictionary->isValidWord(word, length); - } + bool isValidWord(unsigned short *word, int length); + int isValidWordRec(int pos, unsigned short *word, int offset, int length); void setAsset(void *asset) { mAsset = asset; } void *getAsset() { return mAsset; } ~Dictionary(); + // public static utility methods + // static inline methods should be defined in the header file + static unsigned short getChar(const unsigned char *dict, int *pos); + static int getCount(const unsigned char *dict, int *pos); + static bool getTerminal(const unsigned char *dict, int *pos); + static int getAddress(const unsigned char *dict, int *pos); + static int getFreq(const unsigned char *dict, const bool isLatestDictVersion, int *pos); + static int wideStrLen(unsigned short *str); + private: + bool hasBigram(); + + const unsigned char *DICT; + const bool IS_LATEST_DICT_VERSION; void *mAsset; BigramDictionary *mBigramDictionary; UnigramDictionary *mUnigramDictionary; }; // ---------------------------------------------------------------------------- +// public static utility methods +// static inline methods should be defined in the header file +inline unsigned short Dictionary::getChar(const unsigned char *dict, int *pos) { + unsigned short ch = (unsigned short) (dict[(*pos)++] & 0xFF); + // If the code is 255, then actual 16 bit code follows (in big endian) + if (ch == 0xFF) { + ch = ((dict[*pos] & 0xFF) << 8) | (dict[*pos + 1] & 0xFF); + (*pos) += 2; + } + return ch; +} -}; // namespace latinime +inline int Dictionary::getCount(const unsigned char *dict, int *pos) { + return dict[(*pos)++] & 0xFF; +} +inline bool Dictionary::getTerminal(const unsigned char *dict, int *pos) { + return (dict[*pos] & FLAG_TERMINAL_MASK) > 0; +} + +inline int Dictionary::getAddress(const unsigned char *dict, int *pos) { + int address = 0; + if ((dict[*pos] & FLAG_ADDRESS_MASK) == 0) { + *pos += 1; + } else { + address += (dict[*pos] & (ADDRESS_MASK >> 16)) << 16; + address += (dict[*pos + 1] & 0xFF) << 8; + address += (dict[*pos + 2] & 0xFF); + *pos += 3; + } + return address; +} + +inline int Dictionary::getFreq(const unsigned char *dict, + const bool isLatestDictVersion, int *pos) { + int freq = dict[(*pos)++] & 0xFF; + if (isLatestDictVersion) { + // skipping bigram + int bigramExist = (dict[*pos] & FLAG_BIGRAM_READ); + if (bigramExist > 0) { + int nextBigramExist = 1; + while (nextBigramExist > 0) { + (*pos) += 3; + nextBigramExist = (dict[(*pos)++] & FLAG_BIGRAM_CONTINUED); + } + } else { + (*pos)++; + } + } + return freq; +} + + +inline int Dictionary::wideStrLen(unsigned short *str) { + if (!str) return 0; + unsigned short *end = str; + while (*end) + end++; + return end - str; +} + +}; // namespace latinime #endif // LATINIME_DICTIONARY_H diff --git a/native/src/unigram_dictionary.cpp b/native/src/unigram_dictionary.cpp index 88382a94d..d0c903e81 100644 --- a/native/src/unigram_dictionary.cpp +++ b/native/src/unigram_dictionary.cpp @@ -20,47 +20,28 @@ #include <sys/mman.h> #include <string.h> -#ifdef FLAG_DBG -#define LOG_TAG "LatinIME: dictionary.cpp" -#include <cutils/log.h> -#define DEBUG_DICT 1 -#else // FLAG_DBG -#define LOGI -#define DEBUG_DICT 0 -#endif // FLAG_DBG +#define LOG_TAG "LatinIME: unigram_dictionary.cpp" -#include "unigram_dictionary.h" #include "basechars.h" #include "char_utils.h" - -#define DICTIONARY_VERSION_MIN 200 -#define DICTIONARY_HEADER_SIZE 2 -#define NOT_VALID_WORD -99 - -#define SUGGEST_MISSING_CHARACTERS true -#define SUGGEST_MISSING_CHARACTERS_THRESHOLD 5 - +#include "dictionary.h" +#include "unigram_dictionary.h" namespace latinime { -UnigramDictionary::UnigramDictionary(void *dict, int typedLetterMultiplier, int fullWordMultiplier, - int maxWordLength, int maxWords, int maxAlternatives, Dictionary *parentDictionary) - : MAX_WORD_LENGTH(maxWordLength),MAX_WORDS(maxWords), MAX_ALTERNATIVES(maxAlternatives) -{ +UnigramDictionary::UnigramDictionary(const unsigned char *dict, int typedLetterMultiplier, + int fullWordMultiplier, int maxWordLength, int maxWords, int maxAlternatives, + const bool isLatestDictVersion) + : DICT(dict), MAX_WORD_LENGTH(maxWordLength),MAX_WORDS(maxWords), + MAX_ALTERNATIVES(maxAlternatives), IS_LATEST_DICT_VERSION(isLatestDictVersion), + TYPED_LETTER_MULTIPLIER(typedLetterMultiplier), FULL_WORD_MULTIPLIER(fullWordMultiplier) { LOGI("UnigramDictionary - constructor"); - mDict = (unsigned char*) dict; - mTypedLetterMultiplier = typedLetterMultiplier; - mFullWordMultiplier = fullWordMultiplier; - mParentDictionary = parentDictionary; - getVersionNumber(); } -UnigramDictionary::~UnigramDictionary() -{ -} +UnigramDictionary::~UnigramDictionary() {} -int UnigramDictionary::getSuggestions(int *codes, int codesSize, unsigned short *outWords, int *frequencies, - int *nextLetters, int nextLettersSize) +int UnigramDictionary::getSuggestions(int *codes, int codesSize, unsigned short *outWords, + int *frequencies, int *nextLetters, int nextLettersSize) { initSuggestions(codes, codesSize, outWords, frequencies); @@ -106,7 +87,7 @@ void UnigramDictionary::initSuggestions(int *codes, int codesSize, unsigned shor int UnigramDictionary::getSuggestionCandidates(int inputLength, int skipPos, int *nextLetters, int nextLettersSize) { - if (checkIfDictVersionIsLatest()) { + if (IS_LATEST_DICT_VERSION) { getWordsRec(DICTIONARY_HEADER_SIZE, 0, inputLength * 3, false, 1, 0, 0, skipPos, nextLetters, nextLettersSize); } else { @@ -127,82 +108,6 @@ void UnigramDictionary::registerNextLetter(unsigned short c, int *nextLetters, i } } -// TODO: Should be const static variable calculate in the constructor -void -UnigramDictionary::getVersionNumber() -{ - mVersion = (mDict[0] & 0xFF); - mBigram = (mDict[1] & 0xFF); - LOGI("IN NATIVE SUGGEST Version: %d Bigram : %d \n", mVersion, mBigram); -} - -// TODO: Should be const static variable calculate in the constructor -// Checks whether it has the latest dictionary or the old dictionary -bool -UnigramDictionary::checkIfDictVersionIsLatest() -{ - return (mVersion >= DICTIONARY_VERSION_MIN) && (mBigram == 1 || mBigram == 0); -} - -unsigned short -UnigramDictionary::getChar(int *pos) -{ - unsigned short ch = (unsigned short) (mDict[(*pos)++] & 0xFF); - // If the code is 255, then actual 16 bit code follows (in big endian) - if (ch == 0xFF) { - ch = ((mDict[*pos] & 0xFF) << 8) | (mDict[*pos + 1] & 0xFF); - (*pos) += 2; - } - return ch; -} - -int -UnigramDictionary::getAddress(int *pos) -{ - int address = 0; - if ((mDict[*pos] & FLAG_ADDRESS_MASK) == 0) { - *pos += 1; - } else { - address += (mDict[*pos] & (ADDRESS_MASK >> 16)) << 16; - address += (mDict[*pos + 1] & 0xFF) << 8; - address += (mDict[*pos + 2] & 0xFF); - *pos += 3; - } - return address; -} - -int -UnigramDictionary::getFreq(int *pos) -{ - int freq = mDict[(*pos)++] & 0xFF; - - if (checkIfDictVersionIsLatest()) { - // skipping bigram - int bigramExist = (mDict[*pos] & FLAG_BIGRAM_READ); - if (bigramExist > 0) { - int nextBigramExist = 1; - while (nextBigramExist > 0) { - (*pos) += 3; - nextBigramExist = (mDict[(*pos)++] & FLAG_BIGRAM_CONTINUED); - } - } else { - (*pos)++; - } - } - - return freq; -} - -int -UnigramDictionary::wideStrLen(unsigned short *str) -{ - if (!str) return 0; - unsigned short *end = str; - while (*end) - end++; - return end - str; -} - bool UnigramDictionary::addWord(unsigned short *word, int length, int frequency) { @@ -218,7 +123,7 @@ UnigramDictionary::addWord(unsigned short *word, int length, int frequency) while (insertAt < MAX_WORDS) { if (frequency > mFrequencies[insertAt] || (mFrequencies[insertAt] == frequency - && length < wideStrLen(mOutputChars + insertAt * MAX_WORD_LENGTH))) { + && length < Dictionary::wideStrLen(mOutputChars + insertAt * MAX_WORD_LENGTH))) { break; } insertAt++; @@ -242,46 +147,6 @@ UnigramDictionary::addWord(unsigned short *word, int length, int frequency) return false; } -bool -UnigramDictionary::addWordBigram(unsigned short *word, int length, int frequency) -{ - word[length] = 0; - if (DEBUG_DICT) { - char s[length + 1]; - for (int i = 0; i <= length; i++) s[i] = word[i]; - LOGI("Bigram: Found word = %s, freq = %d : \n", s, frequency); - } - - // Find the right insertion point - int insertAt = 0; - while (insertAt < mMaxBigrams) { - if (frequency > mBigramFreq[insertAt] - || (mBigramFreq[insertAt] == frequency - && length < wideStrLen(mBigramChars + insertAt * MAX_WORD_LENGTH))) { - break; - } - insertAt++; - } - LOGI("Bigram: InsertAt -> %d maxBigrams: %d\n", insertAt, mMaxBigrams); - if (insertAt < mMaxBigrams) { - memmove((char*) mBigramFreq + (insertAt + 1) * sizeof(mBigramFreq[0]), - (char*) mBigramFreq + insertAt * sizeof(mBigramFreq[0]), - (mMaxBigrams - insertAt - 1) * sizeof(mBigramFreq[0])); - mBigramFreq[insertAt] = frequency; - memmove((char*) mBigramChars + (insertAt + 1) * MAX_WORD_LENGTH * sizeof(short), - (char*) mBigramChars + (insertAt ) * MAX_WORD_LENGTH * sizeof(short), - (mMaxBigrams - insertAt - 1) * sizeof(short) * MAX_WORD_LENGTH); - unsigned short *dest = mBigramChars + (insertAt ) * MAX_WORD_LENGTH; - while (length--) { - *dest++ = *word++; - } - *dest = 0; // NULL terminate - if (DEBUG_DICT) LOGI("Bigram: Added word at %d\n", insertAt); - return true; - } - return false; -} - unsigned short UnigramDictionary::toLowerCase(unsigned short c) { if (c < sizeof(BASE_CHARS) / sizeof(BASE_CHARS[0])) { @@ -315,8 +180,8 @@ UnigramDictionary::sameAsTyped(unsigned short *word, int length) static char QUOTE = '\''; void -UnigramDictionary::getWordsRec(int pos, int depth, int maxDepth, bool completion, int snr, int inputIndex, - int diffs, int skipPos, int *nextLetters, int nextLettersSize) +UnigramDictionary::getWordsRec(int pos, int depth, int maxDepth, bool completion, int snr, + int inputIndex, int diffs, int skipPos, int *nextLetters, int nextLettersSize) { // Optimization: Prune out words that are too long compared to how much was typed. if (depth > maxDepth) { @@ -325,7 +190,7 @@ UnigramDictionary::getWordsRec(int pos, int depth, int maxDepth, bool completion if (diffs > mMaxEditDistance) { return; } - int count = getCount(&pos); + int count = Dictionary::getCount(DICT, &pos); int *currentChars = NULL; if (mInputLength <= inputIndex) { completion = true; @@ -335,14 +200,14 @@ UnigramDictionary::getWordsRec(int pos, int depth, int maxDepth, bool completion for (int i = 0; i < count; i++) { // -- at char - unsigned short c = getChar(&pos); + unsigned short c = Dictionary::getChar(DICT, &pos); // -- at flag/add unsigned short lowerC = toLowerCase(c); - bool terminal = getTerminal(&pos); - int childrenAddress = getAddress(&pos); + bool terminal = Dictionary::getTerminal(DICT, &pos); + int childrenAddress = Dictionary::getAddress(DICT, &pos); // -- after address or flag int freq = 1; - if (terminal) freq = getFreq(&pos); + if (terminal) freq = Dictionary::getFreq(DICT, IS_LATEST_DICT_VERSION, &pos); // -- after add or freq // If we are only doing completions, no need to look at the typed characters. @@ -369,14 +234,14 @@ UnigramDictionary::getWordsRec(int pos, int depth, int maxDepth, bool completion int j = 0; while (currentChars[j] > 0) { if (currentChars[j] == lowerC || currentChars[j] == c) { - int addedWeight = j == 0 ? mTypedLetterMultiplier : 1; + int addedWeight = j == 0 ? TYPED_LETTER_MULTIPLIER : 1; mWord[depth] = c; if (mInputLength == inputIndex + 1) { if (terminal) { if (//INCLUDE_TYPED_WORD_IF_VALID || !sameAsTyped(mWord, depth + 1)) { int finalFreq = freq * snr * addedWeight; - if (skipPos < 0) finalFreq *= mFullWordMultiplier; + if (skipPos < 0) finalFreq *= FULL_WORD_MULTIPLIER; addWord(mWord, depth + 1, finalFreq); } } @@ -398,234 +263,4 @@ UnigramDictionary::getWordsRec(int pos, int depth, int maxDepth, bool completion } } -int -UnigramDictionary::getBigramAddress(int *pos, bool advance) -{ - int address = 0; - - address += (mDict[*pos] & 0x3F) << 16; - address += (mDict[*pos + 1] & 0xFF) << 8; - address += (mDict[*pos + 2] & 0xFF); - - if (advance) { - *pos += 3; - } - - return address; -} - -int -UnigramDictionary::getBigramFreq(int *pos) -{ - int freq = mDict[(*pos)++] & FLAG_BIGRAM_FREQ; - - return freq; -} - - -int -UnigramDictionary::getBigrams(unsigned short *prevWord, int prevWordLength, int *codes, int codesSize, - unsigned short *bigramChars, int *bigramFreq, int maxWordLength, int maxBigrams, - int maxAlternatives) -{ - mBigramFreq = bigramFreq; - mBigramChars = bigramChars; - mInputCodes = codes; - mInputLength = codesSize; - mMaxBigrams = maxBigrams; - - if (mBigram == 1 && checkIfDictVersionIsLatest()) { - int pos = isValidWordRec( - DICTIONARY_HEADER_SIZE, prevWord, 0, prevWordLength); - LOGI("Pos -> %d\n", pos); - if (pos < 0) { - return 0; - } - - int bigramCount = 0; - int bigramExist = (mDict[pos] & FLAG_BIGRAM_READ); - if (bigramExist > 0) { - int nextBigramExist = 1; - while (nextBigramExist > 0 && bigramCount < maxBigrams) { - int bigramAddress = getBigramAddress(&pos, true); - int frequency = (FLAG_BIGRAM_FREQ & mDict[pos]); - // search for all bigrams and store them - searchForTerminalNode(bigramAddress, frequency); - nextBigramExist = (mDict[pos++] & FLAG_BIGRAM_CONTINUED); - bigramCount++; - } - } - - return bigramCount; - } - return 0; -} - -void -UnigramDictionary::searchForTerminalNode(int addressLookingFor, int frequency) -{ - // track word with such address and store it in an array - unsigned short word[MAX_WORD_LENGTH]; - - int pos; - int followDownBranchAddress = DICTIONARY_HEADER_SIZE; - bool found = false; - char followingChar = ' '; - int depth = -1; - - while(!found) { - bool followDownAddressSearchStop = false; - bool firstAddress = true; - bool haveToSearchAll = true; - - if (depth >= 0) { - word[depth] = (unsigned short) followingChar; - } - pos = followDownBranchAddress; // pos start at count - int count = mDict[pos] & 0xFF; - LOGI("count - %d\n",count); - pos++; - for (int i = 0; i < count; i++) { - // pos at data - pos++; - // pos now at flag - if (!getFirstBitOfByte(&pos)) { // non-terminal - if (!followDownAddressSearchStop) { - int addr = getBigramAddress(&pos, false); - if (addr > addressLookingFor) { - followDownAddressSearchStop = true; - if (firstAddress) { - firstAddress = false; - haveToSearchAll = true; - } else if (!haveToSearchAll) { - break; - } - } else { - followDownBranchAddress = addr; - followingChar = (char)(0xFF & mDict[pos-1]); - if (firstAddress) { - firstAddress = false; - haveToSearchAll = false; - } - } - } - pos += 3; - } else if (getFirstBitOfByte(&pos)) { // terminal - if (addressLookingFor == (pos-1)) { // found !! - depth++; - word[depth] = (0xFF & mDict[pos-1]); - found = true; - break; - } - if (getSecondBitOfByte(&pos)) { // address + freq (4 byte) - if (!followDownAddressSearchStop) { - int addr = getBigramAddress(&pos, false); - if (addr > addressLookingFor) { - followDownAddressSearchStop = true; - if (firstAddress) { - firstAddress = false; - haveToSearchAll = true; - } else if (!haveToSearchAll) { - break; - } - } else { - followDownBranchAddress = addr; - followingChar = (char)(0xFF & mDict[pos-1]); - if (firstAddress) { - firstAddress = false; - haveToSearchAll = true; - } - } - } - pos += 4; - } else { // freq only (2 byte) - pos += 2; - } - - // skipping bigram - int bigramExist = (mDict[pos] & FLAG_BIGRAM_READ); - if (bigramExist > 0) { - int nextBigramExist = 1; - while (nextBigramExist > 0) { - pos += 3; - nextBigramExist = (mDict[pos++] & FLAG_BIGRAM_CONTINUED); - } - } else { - pos++; - } - } - } - depth++; - if (followDownBranchAddress == 0) { - LOGI("ERROR!!! Cannot find bigram!!"); - break; - } - } - if (checkFirstCharacter(word)) { - addWordBigram(word, depth, frequency); - } -} - -bool -UnigramDictionary::checkFirstCharacter(unsigned short *word) -{ - // Checks whether this word starts with same character or neighboring characters of - // what user typed. - - int *inputCodes = mInputCodes; - int maxAlt = MAX_ALTERNATIVES; - while (maxAlt > 0) { - if ((unsigned int) *inputCodes == (unsigned int) *word) { - return true; - } - inputCodes++; - maxAlt--; - } - return false; -} - -// TODO: Move to parent dictionary -bool -UnigramDictionary::isValidWord(unsigned short *word, int length) -{ - if (checkIfDictVersionIsLatest()) { - return (isValidWordRec(DICTIONARY_HEADER_SIZE, word, 0, length) != NOT_VALID_WORD); - } else { - return (isValidWordRec(0, word, 0, length) != NOT_VALID_WORD); - } -} - -int -UnigramDictionary::isValidWordRec(int pos, unsigned short *word, int offset, int length) { - // returns address of bigram data of that word - // return -99 if not found - - int count = getCount(&pos); - unsigned short currentChar = (unsigned short) word[offset]; - for (int j = 0; j < count; j++) { - unsigned short c = getChar(&pos); - int terminal = getTerminal(&pos); - int childPos = getAddress(&pos); - if (c == currentChar) { - if (offset == length - 1) { - if (terminal) { - return (pos+1); - } - } else { - if (childPos != 0) { - int t = isValidWordRec(childPos, word, offset + 1, length); - if (t > 0) { - return t; - } - } - } - } - if (terminal) { - getFreq(&pos); - } - // There could be two instances of each alphabet - upper and lower case. So continue - // looking ... - } - return NOT_VALID_WORD; -} } // namespace latinime diff --git a/native/src/unigram_dictionary.h b/native/src/unigram_dictionary.h index 28e4308b4..557e54cb7 100644 --- a/native/src/unigram_dictionary.h +++ b/native/src/unigram_dictionary.h @@ -17,84 +17,49 @@ #ifndef LATINIME_UNIGRAM_DICTIONARY_H #define LATINIME_UNIGRAM_DICTIONARY_H -namespace latinime { - -// 22-bit address = ~4MB dictionary size limit, which on average would be about 200k-300k words -#define ADDRESS_MASK 0x3FFFFF +#include "defines.h" -// The bit that decides if an address follows in the next 22 bits -#define FLAG_ADDRESS_MASK 0x40 -// The bit that decides if this is a terminal node for a word. The node could still have children, -// if the word has other endings. -#define FLAG_TERMINAL_MASK 0x80 - -#define FLAG_BIGRAM_READ 0x80 -#define FLAG_BIGRAM_CHILDEXIST 0x40 -#define FLAG_BIGRAM_CONTINUED 0x80 -#define FLAG_BIGRAM_FREQ 0x7F +namespace latinime { -class Dictionary; class UnigramDictionary { public: - UnigramDictionary(void *dict, int typedLetterMultipler, int fullWordMultiplier, int maxWordLength, - int maxWords, int maxAlternatives, Dictionary *parentDictionary); + UnigramDictionary(const unsigned char *dict, int typedLetterMultipler, int fullWordMultiplier, + int maxWordLength, int maxWords, int maxAlternatives, const bool isLatestDictVersion); int getSuggestions(int *codes, int codesSize, unsigned short *outWords, int *frequencies, int *nextLetters, int nextLettersSize); - int getBigrams(unsigned short *word, int length, int *codes, int codesSize, - unsigned short *outWords, int *frequencies, int maxWordLength, int maxBigrams, - int maxAlternatives); - bool isValidWord(unsigned short *word, int length); ~UnigramDictionary(); private: void initSuggestions(int *codes, int codesSize, unsigned short *outWords, int *frequencies); - int getSuggestionCandidates(int inputLength, int skipPos, int *nextLetters, int nextLettersSize); + int getSuggestionCandidates(int inputLength, int skipPos, int *nextLetters, + int nextLettersSize); void getVersionNumber(); bool checkIfDictVersionIsLatest(); int getAddress(int *pos); - int getBigramAddress(int *pos, bool advance); int getFreq(int *pos); - int getBigramFreq(int *pos); - void searchForTerminalNode(int address, int frequency); - - bool getFirstBitOfByte(int *pos) { return (mDict[*pos] & 0x80) > 0; } - bool getSecondBitOfByte(int *pos) { return (mDict[*pos] & 0x40) > 0; } - bool getTerminal(int *pos) { return (mDict[*pos] & FLAG_TERMINAL_MASK) > 0; } - int getCount(int *pos) { return mDict[(*pos)++] & 0xFF; } - unsigned short getChar(int *pos); int wideStrLen(unsigned short *str); bool sameAsTyped(unsigned short *word, int length); - bool checkFirstCharacter(unsigned short *word); bool addWord(unsigned short *word, int length, int frequency); - bool addWordBigram(unsigned short *word, int length, int frequency); unsigned short toLowerCase(unsigned short c); void getWordsRec(int pos, int depth, int maxDepth, bool completion, int frequency, int inputIndex, int diffs, int skipPos, int *nextLetters, int nextLettersSize); void registerNextLetter(unsigned short c, int *nextLetters, int nextLettersSize); - int isValidWordRec(int pos, unsigned short *word, int offset, int length); - - unsigned char *mDict; - Dictionary *mParentDictionary; + const unsigned char *DICT; const int MAX_WORDS; const int MAX_WORD_LENGTH; const int MAX_ALTERNATIVES; + const bool IS_LATEST_DICT_VERSION; + const int TYPED_LETTER_MULTIPLIER; + const int FULL_WORD_MULTIPLIER; int *mFrequencies; - int *mBigramFreq; - int mMaxBigrams; unsigned short *mOutputChars; - unsigned short *mBigramChars; int *mInputCodes; int mInputLength; unsigned short mWord[128]; int mMaxEditDistance; - - int mFullWordMultiplier; - int mTypedLetterMultiplier; - int mVersion; - int mBigram; }; // ---------------------------------------------------------------------------- |