2013-06-11 03:01:49 +00:00
|
|
|
/*
|
|
|
|
* Copyright (C) 2013, 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.
|
|
|
|
*/
|
|
|
|
|
2013-08-13 11:35:16 +00:00
|
|
|
#include "suggest/policyimpl/dictionary/header/header_policy.h"
|
2013-06-11 03:01:49 +00:00
|
|
|
|
2014-03-07 05:19:10 +00:00
|
|
|
#include <algorithm>
|
|
|
|
|
2013-06-11 03:01:49 +00:00
|
|
|
namespace latinime {
|
|
|
|
|
2014-02-26 09:04:12 +00:00
|
|
|
// Note that these are corresponding definitions in Java side in DictionaryHeader.
|
2013-09-04 10:00:53 +00:00
|
|
|
const char *const HeaderPolicy::MULTIPLE_WORDS_DEMOTION_RATE_KEY = "MULTIPLE_WORDS_DEMOTION_RATE";
|
2013-12-13 08:09:16 +00:00
|
|
|
const char *const HeaderPolicy::REQUIRES_GERMAN_UMLAUT_PROCESSING_KEY =
|
|
|
|
"REQUIRES_GERMAN_UMLAUT_PROCESSING";
|
2013-09-30 04:57:54 +00:00
|
|
|
// TODO: Change attribute string to "IS_DECAYING_DICT".
|
|
|
|
const char *const HeaderPolicy::IS_DECAYING_DICT_KEY = "USES_FORGETTING_CURVE";
|
2014-01-30 09:15:35 +00:00
|
|
|
const char *const HeaderPolicy::DATE_KEY = "date";
|
2013-10-01 09:09:31 +00:00
|
|
|
const char *const HeaderPolicy::LAST_DECAYED_TIME_KEY = "LAST_DECAYED_TIME";
|
2013-09-27 14:12:12 +00:00
|
|
|
const char *const HeaderPolicy::UNIGRAM_COUNT_KEY = "UNIGRAM_COUNT";
|
|
|
|
const char *const HeaderPolicy::BIGRAM_COUNT_KEY = "BIGRAM_COUNT";
|
|
|
|
const char *const HeaderPolicy::EXTENDED_REGION_SIZE_KEY = "EXTENDED_REGION_SIZE";
|
2013-12-13 08:09:16 +00:00
|
|
|
// Historical info is information that is needed to support decaying such as timestamp, level and
|
|
|
|
// count.
|
|
|
|
const char *const HeaderPolicy::HAS_HISTORICAL_INFO_KEY = "HAS_HISTORICAL_INFO";
|
2014-02-04 14:51:05 +00:00
|
|
|
const char *const HeaderPolicy::LOCALE_KEY = "locale"; // match Java declaration
|
2014-02-26 09:04:12 +00:00
|
|
|
const char *const HeaderPolicy::FORGETTING_CURVE_PROBABILITY_VALUES_TABLE_ID_KEY =
|
|
|
|
"FORGETTING_CURVE_PROBABILITY_VALUES_TABLE_ID";
|
2014-02-28 12:06:03 +00:00
|
|
|
|
|
|
|
const char *const HeaderPolicy::MAX_UNIGRAM_COUNT_KEY = "MAX_UNIGRAM_COUNT";
|
|
|
|
const char *const HeaderPolicy::MAX_BIGRAM_COUNT_KEY = "MAX_BIGRAM_COUNT";
|
2014-02-26 09:04:12 +00:00
|
|
|
|
2013-09-26 01:45:03 +00:00
|
|
|
const int HeaderPolicy::DEFAULT_MULTIPLE_WORDS_DEMOTION_RATE = 100;
|
2013-09-04 10:00:53 +00:00
|
|
|
const float HeaderPolicy::MULTIPLE_WORD_COST_MULTIPLIER_SCALE = 100.0f;
|
2014-03-14 03:23:24 +00:00
|
|
|
const int HeaderPolicy::DEFAULT_FORGETTING_CURVE_PROBABILITY_VALUES_TABLE_ID = 3;
|
2014-02-28 12:06:03 +00:00
|
|
|
|
|
|
|
const int HeaderPolicy::DEFAULT_MAX_UNIGRAM_COUNT = 10000;
|
|
|
|
const int HeaderPolicy::DEFAULT_MAX_BIGRAM_COUNT = 10000;
|
2013-09-04 10:00:53 +00:00
|
|
|
|
|
|
|
// Used for logging. Question mark is used to indicate that the key is not found.
|
|
|
|
void HeaderPolicy::readHeaderValueOrQuestionMark(const char *const key, int *outValue,
|
|
|
|
int outValueSize) const {
|
|
|
|
if (outValueSize <= 0) return;
|
|
|
|
if (outValueSize == 1) {
|
|
|
|
outValue[0] = '\0';
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
std::vector<int> keyCodePointVector;
|
2013-09-26 01:45:03 +00:00
|
|
|
HeaderReadWriteUtils::insertCharactersIntoVector(key, &keyCodePointVector);
|
2014-02-06 08:55:45 +00:00
|
|
|
DictionaryHeaderStructurePolicy::AttributeMap::const_iterator it =
|
|
|
|
mAttributeMap.find(keyCodePointVector);
|
2013-09-04 10:00:53 +00:00
|
|
|
if (it == mAttributeMap.end()) {
|
|
|
|
// The key was not found.
|
|
|
|
outValue[0] = '?';
|
|
|
|
outValue[1] = '\0';
|
|
|
|
return;
|
|
|
|
}
|
2014-03-07 05:19:10 +00:00
|
|
|
const int terminalIndex = std::min(static_cast<int>(it->second.size()), outValueSize - 1);
|
2013-09-04 10:00:53 +00:00
|
|
|
for (int i = 0; i < terminalIndex; ++i) {
|
|
|
|
outValue[i] = it->second[i];
|
|
|
|
}
|
|
|
|
outValue[terminalIndex] = '\0';
|
|
|
|
}
|
2013-06-11 03:01:49 +00:00
|
|
|
|
2014-02-04 14:51:05 +00:00
|
|
|
const std::vector<int> HeaderPolicy::readLocale() const {
|
|
|
|
return HeaderReadWriteUtils::readCodePointVectorAttributeValue(&mAttributeMap, LOCALE_KEY);
|
|
|
|
}
|
|
|
|
|
2013-09-04 10:00:53 +00:00
|
|
|
float HeaderPolicy::readMultipleWordCostMultiplier() const {
|
2013-09-26 01:45:03 +00:00
|
|
|
const int demotionRate = HeaderReadWriteUtils::readIntAttributeValue(&mAttributeMap,
|
2013-09-27 14:12:12 +00:00
|
|
|
MULTIPLE_WORDS_DEMOTION_RATE_KEY, DEFAULT_MULTIPLE_WORDS_DEMOTION_RATE);
|
2013-09-26 01:45:03 +00:00
|
|
|
if (demotionRate <= 0) {
|
|
|
|
return static_cast<float>(MAX_VALUE_FOR_WEIGHTING);
|
2013-09-04 10:00:53 +00:00
|
|
|
}
|
2013-09-26 01:45:03 +00:00
|
|
|
return MULTIPLE_WORD_COST_MULTIPLIER_SCALE / static_cast<float>(demotionRate);
|
2013-09-05 03:28:38 +00:00
|
|
|
}
|
|
|
|
|
2013-12-13 08:09:16 +00:00
|
|
|
bool HeaderPolicy::readRequiresGermanUmlautProcessing() const {
|
|
|
|
return HeaderReadWriteUtils::readBoolAttributeValue(&mAttributeMap,
|
|
|
|
REQUIRES_GERMAN_UMLAUT_PROCESSING_KEY, false);
|
|
|
|
}
|
|
|
|
|
2014-01-30 09:15:35 +00:00
|
|
|
bool HeaderPolicy::fillInAndWriteHeaderToBuffer(const bool updatesLastDecayedTime,
|
|
|
|
const int unigramCount, const int bigramCount,
|
2013-12-17 12:34:41 +00:00
|
|
|
const int extendedRegionSize, BufferWithExtendableBuffer *const outBuffer) const {
|
2013-09-18 09:08:33 +00:00
|
|
|
int writingPos = 0;
|
2014-02-06 08:55:45 +00:00
|
|
|
DictionaryHeaderStructurePolicy::AttributeMap attributeMapToWrite(mAttributeMap);
|
2014-01-30 09:15:35 +00:00
|
|
|
fillInHeader(updatesLastDecayedTime, unigramCount, bigramCount,
|
|
|
|
extendedRegionSize, &attributeMapToWrite);
|
2013-12-17 12:34:41 +00:00
|
|
|
if (!HeaderReadWriteUtils::writeDictionaryVersion(outBuffer, mDictFormatVersion,
|
2013-09-18 09:08:33 +00:00
|
|
|
&writingPos)) {
|
|
|
|
return false;
|
|
|
|
}
|
2013-12-17 12:34:41 +00:00
|
|
|
if (!HeaderReadWriteUtils::writeDictionaryFlags(outBuffer, mDictionaryFlags,
|
2013-09-18 09:08:33 +00:00
|
|
|
&writingPos)) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
// Temporarily writes a dummy header size.
|
|
|
|
int headerSizeFieldPos = writingPos;
|
2013-12-17 12:34:41 +00:00
|
|
|
if (!HeaderReadWriteUtils::writeDictionaryHeaderSize(outBuffer, 0 /* size */,
|
2013-09-18 09:08:33 +00:00
|
|
|
&writingPos)) {
|
|
|
|
return false;
|
|
|
|
}
|
2013-12-17 12:34:41 +00:00
|
|
|
if (!HeaderReadWriteUtils::writeHeaderAttributes(outBuffer, &attributeMapToWrite,
|
2013-09-27 14:12:12 +00:00
|
|
|
&writingPos)) {
|
|
|
|
return false;
|
2013-09-18 09:08:33 +00:00
|
|
|
}
|
2013-12-17 12:34:41 +00:00
|
|
|
// Writes the actual header size.
|
|
|
|
if (!HeaderReadWriteUtils::writeDictionaryHeaderSize(outBuffer, writingPos,
|
2013-09-18 09:08:33 +00:00
|
|
|
&headerSizeFieldPos)) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2014-01-30 09:15:35 +00:00
|
|
|
void HeaderPolicy::fillInHeader(const bool updatesLastDecayedTime, const int unigramCount,
|
|
|
|
const int bigramCount, const int extendedRegionSize,
|
2014-02-06 08:55:45 +00:00
|
|
|
DictionaryHeaderStructurePolicy::AttributeMap *outAttributeMap) const {
|
2013-12-17 12:34:41 +00:00
|
|
|
HeaderReadWriteUtils::setIntAttribute(outAttributeMap, UNIGRAM_COUNT_KEY, unigramCount);
|
|
|
|
HeaderReadWriteUtils::setIntAttribute(outAttributeMap, BIGRAM_COUNT_KEY, bigramCount);
|
|
|
|
HeaderReadWriteUtils::setIntAttribute(outAttributeMap, EXTENDED_REGION_SIZE_KEY,
|
|
|
|
extendedRegionSize);
|
2014-01-30 09:15:35 +00:00
|
|
|
// Set the current time as the generation time.
|
|
|
|
HeaderReadWriteUtils::setIntAttribute(outAttributeMap, DATE_KEY,
|
|
|
|
TimeKeeper::peekCurrentTime());
|
2014-02-04 14:51:05 +00:00
|
|
|
HeaderReadWriteUtils::setCodePointVectorAttribute(outAttributeMap, LOCALE_KEY, mLocale);
|
2013-12-17 12:34:41 +00:00
|
|
|
if (updatesLastDecayedTime) {
|
|
|
|
// Set current time as the last updated time.
|
|
|
|
HeaderReadWriteUtils::setIntAttribute(outAttributeMap, LAST_DECAYED_TIME_KEY,
|
|
|
|
TimeKeeper::peekCurrentTime());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-02-06 08:55:45 +00:00
|
|
|
/* static */ DictionaryHeaderStructurePolicy::AttributeMap
|
2013-09-18 09:08:33 +00:00
|
|
|
HeaderPolicy::createAttributeMapAndReadAllAttributes(const uint8_t *const dictBuf) {
|
2014-02-06 08:55:45 +00:00
|
|
|
DictionaryHeaderStructurePolicy::AttributeMap attributeMap;
|
2013-09-18 09:08:33 +00:00
|
|
|
HeaderReadWriteUtils::fetchAllHeaderAttributes(dictBuf, &attributeMap);
|
2013-09-04 10:00:53 +00:00
|
|
|
return attributeMap;
|
|
|
|
}
|
|
|
|
|
2013-06-11 03:01:49 +00:00
|
|
|
} // namespace latinime
|