blob: 617e4232792f908cefd888d424dc0f6d103a4245 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>TestByteBloomFilter xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../testapidocs/org/apache/hadoop/hbase/util/TestByteBloomFilter.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a>
<a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">package</strong> org.apache.hadoop.hbase.util;
<a class="jxr_linenumber" name="21" href="#21">21</a>
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.ByteArrayOutputStream;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.DataOutputStream;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.nio.ByteBuffer;
<a class="jxr_linenumber" name="25" href="#25">25</a>
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> junit.framework.TestCase;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.testclassification.SmallTests;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.junit.experimental.categories.Category;
<a class="jxr_linenumber" name="29" href="#29">29</a>
<a class="jxr_linenumber" name="30" href="#30">30</a> @Category(SmallTests.<strong class="jxr_keyword">class</strong>)
<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/hadoop/hbase/util/TestByteBloomFilter.html">TestByteBloomFilter</a> <strong class="jxr_keyword">extends</strong> TestCase {
<a class="jxr_linenumber" name="32" href="#32">32</a>
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testBasicBloom() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="34" href="#34">34</a> ByteBloomFilter bf1 = <strong class="jxr_keyword">new</strong> ByteBloomFilter(1000, (<strong class="jxr_keyword">float</strong>)0.01, Hash.MURMUR_HASH, 0);
<a class="jxr_linenumber" name="35" href="#35">35</a> ByteBloomFilter bf2 = <strong class="jxr_keyword">new</strong> ByteBloomFilter(1000, (<strong class="jxr_keyword">float</strong>)0.01, Hash.MURMUR_HASH, 0);
<a class="jxr_linenumber" name="36" href="#36">36</a> bf1.allocBloom();
<a class="jxr_linenumber" name="37" href="#37">37</a> bf2.allocBloom();
<a class="jxr_linenumber" name="38" href="#38">38</a>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_comment">// test 1: verify no fundamental false negatives or positives</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> byte[] key1 = {1,2,3,4,5,6,7,8,9};
<a class="jxr_linenumber" name="41" href="#41">41</a> byte[] key2 = {1,2,3,4,5,6,7,8,7};
<a class="jxr_linenumber" name="42" href="#42">42</a>
<a class="jxr_linenumber" name="43" href="#43">43</a> bf1.add(key1);
<a class="jxr_linenumber" name="44" href="#44">44</a> bf2.add(key2);
<a class="jxr_linenumber" name="45" href="#45">45</a>
<a class="jxr_linenumber" name="46" href="#46">46</a> assertTrue(bf1.contains(key1));
<a class="jxr_linenumber" name="47" href="#47">47</a> assertFalse(bf1.contains(key2));
<a class="jxr_linenumber" name="48" href="#48">48</a> assertFalse(bf2.contains(key1));
<a class="jxr_linenumber" name="49" href="#49">49</a> assertTrue(bf2.contains(key2));
<a class="jxr_linenumber" name="50" href="#50">50</a>
<a class="jxr_linenumber" name="51" href="#51">51</a> byte [] bkey = {1,2,3,4};
<a class="jxr_linenumber" name="52" href="#52">52</a> byte [] bval = <span class="jxr_string">"this is a much larger byte array"</span>.getBytes();
<a class="jxr_linenumber" name="53" href="#53">53</a>
<a class="jxr_linenumber" name="54" href="#54">54</a> bf1.add(bkey);
<a class="jxr_linenumber" name="55" href="#55">55</a> bf1.add(bval, 1, bval.length-1);
<a class="jxr_linenumber" name="56" href="#56">56</a>
<a class="jxr_linenumber" name="57" href="#57">57</a> assertTrue( bf1.contains(bkey) );
<a class="jxr_linenumber" name="58" href="#58">58</a> assertTrue( bf1.contains(bval, 1, bval.length-1) );
<a class="jxr_linenumber" name="59" href="#59">59</a> assertFalse( bf1.contains(bval) );
<a class="jxr_linenumber" name="60" href="#60">60</a> assertFalse( bf1.contains(bval) );
<a class="jxr_linenumber" name="61" href="#61">61</a>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_comment">// test 2: serialization &amp; deserialization.</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_comment">// (convert bloom to byte array &amp; read byte array back in as input)</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> ByteArrayOutputStream bOut = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream();
<a class="jxr_linenumber" name="65" href="#65">65</a> bf1.writeBloom(<strong class="jxr_keyword">new</strong> DataOutputStream(bOut));
<a class="jxr_linenumber" name="66" href="#66">66</a> ByteBuffer bb = ByteBuffer.wrap(bOut.toByteArray());
<a class="jxr_linenumber" name="67" href="#67">67</a> ByteBloomFilter newBf1 = <strong class="jxr_keyword">new</strong> ByteBloomFilter(1000, (<strong class="jxr_keyword">float</strong>)0.01,
<a class="jxr_linenumber" name="68" href="#68">68</a> Hash.MURMUR_HASH, 0);
<a class="jxr_linenumber" name="69" href="#69">69</a> assertTrue(newBf1.contains(key1, bb));
<a class="jxr_linenumber" name="70" href="#70">70</a> assertFalse(newBf1.contains(key2, bb));
<a class="jxr_linenumber" name="71" href="#71">71</a> assertTrue( newBf1.contains(bkey, bb) );
<a class="jxr_linenumber" name="72" href="#72">72</a> assertTrue( newBf1.contains(bval, 1, bval.length-1, bb) );
<a class="jxr_linenumber" name="73" href="#73">73</a> assertFalse( newBf1.contains(bval, bb) );
<a class="jxr_linenumber" name="74" href="#74">74</a> assertFalse( newBf1.contains(bval, bb) );
<a class="jxr_linenumber" name="75" href="#75">75</a>
<a class="jxr_linenumber" name="76" href="#76">76</a> System.out.println(<span class="jxr_string">"Serialized as "</span> + bOut.size() + <span class="jxr_string">" bytes"</span>);
<a class="jxr_linenumber" name="77" href="#77">77</a> assertTrue(bOut.size() - bf1.byteSize &lt; 10); <em class="jxr_comment">//... allow small padding</em>
<a class="jxr_linenumber" name="78" href="#78">78</a> }
<a class="jxr_linenumber" name="79" href="#79">79</a>
<a class="jxr_linenumber" name="80" href="#80">80</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testBloomFold() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_comment">// test: foldFactor &lt; log(max/actual)</em>
<a class="jxr_linenumber" name="82" href="#82">82</a> ByteBloomFilter b = <strong class="jxr_keyword">new</strong> ByteBloomFilter(1003, (<strong class="jxr_keyword">float</strong>) 0.01,
<a class="jxr_linenumber" name="83" href="#83">83</a> Hash.MURMUR_HASH, 2);
<a class="jxr_linenumber" name="84" href="#84">84</a> b.allocBloom();
<a class="jxr_linenumber" name="85" href="#85">85</a> <strong class="jxr_keyword">long</strong> origSize = b.getByteSize();
<a class="jxr_linenumber" name="86" href="#86">86</a> assertEquals(1204, origSize);
<a class="jxr_linenumber" name="87" href="#87">87</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; 12; ++i) {
<a class="jxr_linenumber" name="88" href="#88">88</a> b.add(Bytes.toBytes(i));
<a class="jxr_linenumber" name="89" href="#89">89</a> }
<a class="jxr_linenumber" name="90" href="#90">90</a> b.compactBloom();
<a class="jxr_linenumber" name="91" href="#91">91</a> assertEquals(origSize&gt;&gt;2, b.getByteSize());
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">int</strong> falsePositives = 0;
<a class="jxr_linenumber" name="93" href="#93">93</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; 25; ++i) {
<a class="jxr_linenumber" name="94" href="#94">94</a> <strong class="jxr_keyword">if</strong> (b.contains(Bytes.toBytes(i))) {
<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">if</strong>(i &gt;= 12) falsePositives++;
<a class="jxr_linenumber" name="96" href="#96">96</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="97" href="#97">97</a> assertFalse(i &lt; 12);
<a class="jxr_linenumber" name="98" href="#98">98</a> }
<a class="jxr_linenumber" name="99" href="#99">99</a> }
<a class="jxr_linenumber" name="100" href="#100">100</a> assertTrue(falsePositives &lt;= 1);
<a class="jxr_linenumber" name="101" href="#101">101</a>
<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_comment">// test: foldFactor &gt; log(max/actual)</em>
<a class="jxr_linenumber" name="103" href="#103">103</a> }
<a class="jxr_linenumber" name="104" href="#104">104</a>
<a class="jxr_linenumber" name="105" href="#105">105</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testBloomPerf() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_comment">// add</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> <strong class="jxr_keyword">float</strong> err = (<strong class="jxr_keyword">float</strong>)0.01;
<a class="jxr_linenumber" name="108" href="#108">108</a> ByteBloomFilter b = <strong class="jxr_keyword">new</strong> ByteBloomFilter(10*1000*1000, (<strong class="jxr_keyword">float</strong>)err, Hash.MURMUR_HASH, 3);
<a class="jxr_linenumber" name="109" href="#109">109</a> b.allocBloom();
<a class="jxr_linenumber" name="110" href="#110">110</a> <strong class="jxr_keyword">long</strong> startTime = System.currentTimeMillis();
<a class="jxr_linenumber" name="111" href="#111">111</a> <strong class="jxr_keyword">long</strong> origSize = b.getByteSize();
<a class="jxr_linenumber" name="112" href="#112">112</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; 1*1000*1000; ++i) {
<a class="jxr_linenumber" name="113" href="#113">113</a> b.add(Bytes.toBytes(i));
<a class="jxr_linenumber" name="114" href="#114">114</a> }
<a class="jxr_linenumber" name="115" href="#115">115</a> <strong class="jxr_keyword">long</strong> endTime = System.currentTimeMillis();
<a class="jxr_linenumber" name="116" href="#116">116</a> System.out.println(<span class="jxr_string">"Total Add time = "</span> + (endTime - startTime) + <span class="jxr_string">"ms"</span>);
<a class="jxr_linenumber" name="117" href="#117">117</a>
<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_comment">// fold</em>
<a class="jxr_linenumber" name="119" href="#119">119</a> startTime = System.currentTimeMillis();
<a class="jxr_linenumber" name="120" href="#120">120</a> b.compactBloom();
<a class="jxr_linenumber" name="121" href="#121">121</a> endTime = System.currentTimeMillis();
<a class="jxr_linenumber" name="122" href="#122">122</a> System.out.println(<span class="jxr_string">"Total Fold time = "</span> + (endTime - startTime) + <span class="jxr_string">"ms"</span>);
<a class="jxr_linenumber" name="123" href="#123">123</a> assertTrue(origSize &gt;= b.getByteSize()&lt;&lt;3);
<a class="jxr_linenumber" name="124" href="#124">124</a>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_comment">// test</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> startTime = System.currentTimeMillis();
<a class="jxr_linenumber" name="127" href="#127">127</a> <strong class="jxr_keyword">int</strong> falsePositives = 0;
<a class="jxr_linenumber" name="128" href="#128">128</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; 2*1000*1000; ++i) {
<a class="jxr_linenumber" name="129" href="#129">129</a>
<a class="jxr_linenumber" name="130" href="#130">130</a> <strong class="jxr_keyword">if</strong> (b.contains(Bytes.toBytes(i))) {
<a class="jxr_linenumber" name="131" href="#131">131</a> <strong class="jxr_keyword">if</strong>(i &gt;= 1*1000*1000) falsePositives++;
<a class="jxr_linenumber" name="132" href="#132">132</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="133" href="#133">133</a> assertFalse(i &lt; 1*1000*1000);
<a class="jxr_linenumber" name="134" href="#134">134</a> }
<a class="jxr_linenumber" name="135" href="#135">135</a> }
<a class="jxr_linenumber" name="136" href="#136">136</a> endTime = System.currentTimeMillis();
<a class="jxr_linenumber" name="137" href="#137">137</a> System.out.println(<span class="jxr_string">"Total Contains time = "</span> + (endTime - startTime) + <span class="jxr_string">"ms"</span>);
<a class="jxr_linenumber" name="138" href="#138">138</a> System.out.println(<span class="jxr_string">"False Positive = "</span> + falsePositives);
<a class="jxr_linenumber" name="139" href="#139">139</a> assertTrue(falsePositives &lt;= (1*1000*1000)*err);
<a class="jxr_linenumber" name="140" href="#140">140</a>
<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_comment">// test: foldFactor &gt; log(max/actual)</em>
<a class="jxr_linenumber" name="142" href="#142">142</a> }
<a class="jxr_linenumber" name="143" href="#143">143</a>
<a class="jxr_linenumber" name="144" href="#144">144</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testSizing() {
<a class="jxr_linenumber" name="145" href="#145">145</a> <strong class="jxr_keyword">int</strong> bitSize = 8 * 128 * 1024; <em class="jxr_comment">// 128 KB</em>
<a class="jxr_linenumber" name="146" href="#146">146</a> <strong class="jxr_keyword">double</strong> errorRate = 0.025; <em class="jxr_comment">// target false positive rate</em>
<a class="jxr_linenumber" name="147" href="#147">147</a>
<a class="jxr_linenumber" name="148" href="#148">148</a> <em class="jxr_comment">// How many keys can we store in a Bloom filter of this size maintaining</em>
<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_comment">// the given false positive rate, not taking into account that the n</em>
<a class="jxr_linenumber" name="150" href="#150">150</a> <strong class="jxr_keyword">long</strong> maxKeys = ByteBloomFilter.idealMaxKeys(bitSize, errorRate);
<a class="jxr_linenumber" name="151" href="#151">151</a> assertEquals(136570, maxKeys);
<a class="jxr_linenumber" name="152" href="#152">152</a>
<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_comment">// A reverse operation: how many bits would we need to store this many keys</em>
<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_comment">// and keep the same low false positive rate?</em>
<a class="jxr_linenumber" name="155" href="#155">155</a> <strong class="jxr_keyword">long</strong> bitSize2 = ByteBloomFilter.computeBitSize(maxKeys, errorRate);
<a class="jxr_linenumber" name="156" href="#156">156</a>
<a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_comment">// The bit size comes out a little different due to rounding.</em>
<a class="jxr_linenumber" name="158" href="#158">158</a> assertTrue(Math.abs(bitSize2 - bitSize) * 1.0 / bitSize &lt; 1e-5);
<a class="jxr_linenumber" name="159" href="#159">159</a> }
<a class="jxr_linenumber" name="160" href="#160">160</a>
<a class="jxr_linenumber" name="161" href="#161">161</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testFoldableByteSize() {
<a class="jxr_linenumber" name="162" href="#162">162</a> assertEquals(128, ByteBloomFilter.computeFoldableByteSize(1000, 5));
<a class="jxr_linenumber" name="163" href="#163">163</a> assertEquals(640, ByteBloomFilter.computeFoldableByteSize(5001, 4));
<a class="jxr_linenumber" name="164" href="#164">164</a> }
<a class="jxr_linenumber" name="165" href="#165">165</a>
<a class="jxr_linenumber" name="166" href="#166">166</a>
<a class="jxr_linenumber" name="167" href="#167">167</a> }
<a class="jxr_linenumber" name="168" href="#168">168</a>
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>