149ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard/* 249ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard * Copyright (C) 2012 The Android Open Source Project 349ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard * 449ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard * Licensed under the Apache License, Version 2.0 (the "License"); 549ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard * you may not use this file except in compliance with the License. 649ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard * You may obtain a copy of the License at 749ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard * 849ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard * http://www.apache.org/licenses/LICENSE-2.0 949ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard * 1049ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard * Unless required by applicable law or agreed to in writing, software 1149ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard * distributed under the License is distributed on an "AS IS" BASIS, 1249ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1349ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard * See the License for the specific language governing permissions and 1449ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard * limitations under the License. 1549ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard */ 1649ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard 1749ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard#ifndef LATINIME_BLOOM_FILTER_H 1849ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard#define LATINIME_BLOOM_FILTER_H 1949ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard 202fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi#include <bitset> 2149ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard 2249ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard#include "defines.h" 2349ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard 2449ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalardnamespace latinime { 2549ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard 261ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi// This bloom filter is used for optimizing bigram retrieval. 271ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi// Execution times with previous word "this" are as follows: 281ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi// without bloom filter (use only hash_map): 291ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi// Total 147792.34 (sum of others 147771.57) 301ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi// with bloom filter: 311ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi// Total 145900.64 (sum of others 145874.30) 321ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi// always read binary dictionary: 331ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi// Total 148603.14 (sum of others 148579.90) 341ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagiclass BloomFilter { 351ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi public: 362fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi BloomFilter() : mFilter() {} 371ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi 382fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi AK_FORCE_INLINE void setInFilter(const int position) { 392fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi mFilter.set(getIndex(position)); 401ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi } 411ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi 422fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi AK_FORCE_INLINE bool isInFilter(const int position) const { 432fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi return mFilter.test(getIndex(position)); 441ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi } 451ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi 461ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi private: 472fa3693c264a4c150ac307d9bb7f6f8f18cc4ffcKen Wakasa DISALLOW_ASSIGNMENT_OPERATOR(BloomFilter); 482fa3693c264a4c150ac307d9bb7f6f8f18cc4ffcKen Wakasa 492fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi AK_FORCE_INLINE size_t getIndex(const int position) const { 502fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi return static_cast<size_t>(position) % BIGRAM_FILTER_MODULO; 512fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi } 522fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi 532fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi // Size, in bits, of the bloom filter index for bigrams 542fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi // The probability of false positive is (1 - e ** (-kn/m))**k, 551ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi // where k is the number of hash functions, n the number of bigrams, and m the number of 561ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi // bits we can test. 572fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi // At the moment 100 is the maximum number of bigrams for a word with the current main 581ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi // dictionaries, so n = 100. 1024 buckets give us m = 1024. 591ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi // With 1 hash function, our false positive rate is about 9.3%, which should be enough for 601ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi // our uses since we are only using this to increase average performance. For the record, 611ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi // k = 2 gives 3.1% and k = 3 gives 1.6%. With k = 1, making m = 2048 gives 4.8%, 621ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi // and m = 4096 gives 2.4%. 632fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi // This is assigned here because it is used for bitset size. 642fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi // 1021 is the largest prime under 1024. 652fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi static const size_t BIGRAM_FILTER_MODULO = 1021; 662fd0bf9a37b510e1a79dd8c43ed6f6d5919dc376Keisuke Kuroyanagi std::bitset<BIGRAM_FILTER_MODULO> mFilter; 671ff81e889045d35ff8420b266398e73239bd15c9Keisuke Kuroynagi}; 6849ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard} // namespace latinime 6949ba135fdedb3c6b33ec915e91ecad682b7655b8Jean Chalard#endif // LATINIME_BLOOM_FILTER_H 70