| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>datasketches-cpp: hll/include/HllUtil.hpp Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">datasketches-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_bc45e258c7269dbde5716543a4c54103.html">hll</a></li><li class="navelem"><a class="el" href="dir_aa059cbaaa7f4410839cee554e9ff9ba.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">HllUtil.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * under the License.</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef _HLLUTIL_HPP_</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define _HLLUTIL_HPP_</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "MurmurHash3.h"</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "RelativeErrorTables.hpp"</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "count_zeros.hpp"</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "common_defs.hpp"</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "ceiling_power_of_2.hpp"</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <cmath></span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <stdexcept></span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">namespace </span><a class="code" href="namespacedatasketches.html">datasketches</a> {</div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">enum</span> hll_mode { LIST = 0, SET, HLL };</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span>hll_constants {</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// preamble stuff</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t SER_VER = 1;</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FAMILY_ID = 7;</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t EMPTY_FLAG_MASK = 4;</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t COMPACT_FLAG_MASK = 8;</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t OUT_OF_ORDER_FLAG_MASK = 16;</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FULL_SIZE_FLAG_MASK = 32;</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t PREAMBLE_INTS_BYTE = 0;</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t SER_VER_BYTE = 1;</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t FAMILY_BYTE = 2;</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t LG_K_BYTE = 3;</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t LG_ARR_BYTE = 4;</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t FLAGS_BYTE = 5;</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t LIST_COUNT_BYTE = 6;</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t HLL_CUR_MIN_BYTE = 6;</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t MODE_BYTE = 7; <span class="comment">// lo2bits = curMode, next 2 bits = tgtHllMode</span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// Coupon List</span></div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t LIST_INT_ARR_START = 8;</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t LIST_PREINTS = 2;</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// Coupon Hash Set</span></div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t HASH_SET_COUNT_INT = 8;</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t HASH_SET_INT_ARR_START = 12;</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t HASH_SET_PREINTS = 3;</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// HLL</span></div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t HLL_PREINTS = 10;</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t HLL_BYTE_ARR_START = 40;</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t HIP_ACCUM_DOUBLE = 8;</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t KXQ0_DOUBLE = 16;</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t KXQ1_DOUBLE = 24;</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t CUR_MIN_COUNT_INT = 32;</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t AUX_COUNT_INT = 36;</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t EMPTY_SKETCH_SIZE_BYTES = 8;</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// other HllUtil stuff</span></div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t KEY_BITS_26 = 26;</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t VAL_BITS_6 = 6;</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t KEY_MASK_26 = (1 << KEY_BITS_26) - 1;</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t VAL_MASK_6 = (1 << VAL_BITS_6) - 1;</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t EMPTY = 0;</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t MIN_LOG_K = 4;</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t MAX_LOG_K = 21;</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">double</span> HLL_HIP_RSE_FACTOR = 0.8325546; <span class="comment">// sqrt(ln(2))</span></div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">double</span> HLL_NON_HIP_RSE_FACTOR = 1.03896; <span class="comment">// sqrt((3 * ln(2)) - 1)</span></div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">double</span> COUPON_RSE_FACTOR = 0.409; <span class="comment">// at transition point not the asymptote</span></div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">double</span> COUPON_RSE = COUPON_RSE_FACTOR / (1 << 13);</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t LG_INIT_LIST_SIZE = 3;</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t LG_INIT_SET_SIZE = 5;</div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t RESIZE_NUMER = 3;</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t RESIZE_DENOM = 4;</div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  </div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t loNibbleMask = 0x0f;</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t hiNibbleMask = 0xf0;</div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t AUX_TOKEN = 0xf;</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t LG_AUX_ARR_INTS[] = {</div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  0, 2, 2, 2, 2, 2, 2, 3, 3, 3, <span class="comment">// 0 - 9</span></div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  4, 4, 5, 5, 6, 7, 8, 9, 10, 11, <span class="comment">// 10-19</span></div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  12, 13, 14, 15, 16, 17, 18 <span class="comment">// 20-26</span></div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> };</div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> } <span class="comment">// namespace hll_constants</span></div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">// template provides internal consistency and allows static float values</span></div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment">// but we don't use the template parameter anywhere</span></div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">template</span><<span class="keyword">typename</span> A = std::allocator<u<span class="keywordtype">int</span>8_t> ></div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="keyword">class </span>HllUtil final {</div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  </div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">static</span> uint32_t coupon(<span class="keyword">const</span> uint64_t hash[]);</div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">static</span> uint32_t coupon(<span class="keyword">const</span> HashState& hashState);</div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> hash(<span class="keyword">const</span> <span class="keywordtype">void</span>* key, <span class="keywordtype">size_t</span> keyLen, uint64_t seed, HashState& result);</div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">static</span> uint8_t checkLgK(uint8_t lgK);</div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> checkMemSize(uint64_t minBytes, uint64_t capBytes);</div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> checkNumStdDev(uint8_t numStdDev);</div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">static</span> uint32_t pair(uint32_t slotNo, uint8_t value);</div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">static</span> uint32_t getLow26(uint32_t coupon);</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">static</span> uint8_t getValue(uint32_t coupon);</div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">static</span> uint8_t simpleIntLog2(uint32_t n); <span class="comment">// n must be power of 2</span></div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">static</span> uint8_t computeLgArrInts(hll_mode mode, uint32_t count, uint8_t lgConfigK);</div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keyword">static</span> <span class="keywordtype">double</span> getRelErr(<span class="keywordtype">bool</span> upperBound, <span class="keywordtype">bool</span> unioned, uint8_t lgConfigK, uint8_t numStdDev);</div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> };</div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  </div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="keyword">inline</span> uint32_t HllUtil<A>::coupon(<span class="keyword">const</span> uint64_t hash[]) {</div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  uint32_t addr26 = hash[0] & hll_constants::KEY_MASK_26;</div> |
| <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  uint8_t lz = count_leading_zeros_in_u64(hash[1]);</div> |
| <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  uint8_t value = ((lz > 62 ? 62 : lz) + 1); </div> |
| <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordflow">return</span> (value << hll_constants::KEY_BITS_26) | addr26;</div> |
| <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> }</div> |
| <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  </div> |
| <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="keyword">inline</span> uint32_t HllUtil<A>::coupon(<span class="keyword">const</span> HashState& hashState) {</div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  uint32_t addr26 = (int) (hashState.h1 & hll_constants::KEY_MASK_26);</div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  uint8_t lz = count_leading_zeros_in_u64(hashState.h2); </div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  uint8_t value = ((lz > 62 ? 62 : lz) + 1); </div> |
| <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keywordflow">return</span> (value << hll_constants::KEY_BITS_26) | addr26;</div> |
| <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> }</div> |
| <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  </div> |
| <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> HllUtil<A>::hash(<span class="keyword">const</span> <span class="keywordtype">void</span>* key, <span class="keywordtype">size_t</span> keyLen, uint64_t seed, HashState& result) {</div> |
| <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  MurmurHash3_x64_128(key, keyLen, seed, result);</div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> }</div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  </div> |
| <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="keyword">inline</span> uint8_t HllUtil<A>::checkLgK(uint8_t lgK) {</div> |
| <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordflow">if</span> ((lgK >= hll_constants::MIN_LOG_K) && (lgK <= hll_constants::MAX_LOG_K)) {</div> |
| <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordflow">return</span> lgK;</div> |
| <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  } <span class="keywordflow">else</span> {</div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordflow">throw</span> std::invalid_argument(<span class="stringliteral">"Invalid value of k: "</span> + std::to_string(lgK));</div> |
| <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  }</div> |
| <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> }</div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  </div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="keyword">inline</span> <span class="keywordtype">double</span> HllUtil<A>::getRelErr(<span class="keywordtype">bool</span> upperBound, <span class="keywordtype">bool</span> unioned,</div> |
| <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  uint8_t lgConfigK, uint8_t numStdDev) {</div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  checkLgK(lgConfigK);</div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordflow">if</span> (lgConfigK > 12) {</div> |
| <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> rseFactor = unioned ?</div> |
| <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  hll_constants::HLL_NON_HIP_RSE_FACTOR : hll_constants::HLL_HIP_RSE_FACTOR;</div> |
| <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keyword">const</span> uint32_t configK = 1 << lgConfigK;</div> |
| <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordflow">return</span> (upperBound ? -1 : 1) * (numStdDev * rseFactor) / sqrt(configK);</div> |
| <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  } <span class="keywordflow">else</span> {</div> |
| <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keywordflow">return</span> RelativeErrorTables<A>::getRelErr(upperBound, unioned, lgConfigK, numStdDev);</div> |
| <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  }</div> |
| <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> }</div> |
| <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  </div> |
| <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> HllUtil<A>::checkMemSize(uint64_t minBytes, uint64_t capBytes) {</div> |
| <div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keywordflow">if</span> (capBytes < minBytes) {</div> |
| <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordflow">throw</span> std::invalid_argument(<span class="stringliteral">"Given destination array is not large enough: "</span> + std::to_string(capBytes));</div> |
| <div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  }</div> |
| <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> }</div> |
| <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  </div> |
| <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> HllUtil<A>::checkNumStdDev(uint8_t numStdDev) {</div> |
| <div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keywordflow">if</span> ((numStdDev < 1) || (numStdDev > 3)) {</div> |
| <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordflow">throw</span> std::invalid_argument(<span class="stringliteral">"NumStdDev may not be less than 1 or greater than 3."</span>);</div> |
| <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  }</div> |
| <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> }</div> |
| <div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  </div> |
| <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="keyword">inline</span> uint32_t HllUtil<A>::pair(uint32_t slotNo, uint8_t value) {</div> |
| <div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keywordflow">return</span> (value << hll_constants::KEY_BITS_26) | (slotNo & hll_constants::KEY_MASK_26);</div> |
| <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> }</div> |
| <div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  </div> |
| <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="keyword">inline</span> uint32_t HllUtil<A>::getLow26(uint32_t coupon) {</div> |
| <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keywordflow">return</span> coupon & hll_constants::KEY_MASK_26;</div> |
| <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> }</div> |
| <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  </div> |
| <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="keyword">inline</span> uint8_t HllUtil<A>::getValue(uint32_t coupon) {</div> |
| <div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keywordflow">return</span> coupon >> hll_constants::KEY_BITS_26;</div> |
| <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> }</div> |
| <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  </div> |
| <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="keyword">inline</span> uint8_t HllUtil<A>::simpleIntLog2(uint32_t n) {</div> |
| <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordflow">if</span> (n == 0) {</div> |
| <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"cannot take log of 0"</span>);</div> |
| <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  }</div> |
| <div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <span class="keywordflow">return</span> count_trailing_zeros_in_u32(n);</div> |
| <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> }</div> |
| <div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  </div> |
| <div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="keyword">inline</span> uint8_t HllUtil<A>::computeLgArrInts(hll_mode mode, uint32_t count, uint8_t lgConfigK) {</div> |
| <div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="comment">// assume value missing and recompute</span></div> |
| <div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <span class="keywordflow">if</span> (mode == LIST) { <span class="keywordflow">return</span> hll_constants::LG_INIT_LIST_SIZE; }</div> |
| <div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  uint32_t ceilPwr2 = ceiling_power_of_2(count);</div> |
| <div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <span class="keywordflow">if</span> ((hll_constants::RESIZE_DENOM * count) > (hll_constants::RESIZE_NUMER * ceilPwr2)) { ceilPwr2 <<= 1;}</div> |
| <div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keywordflow">if</span> (mode == SET) {</div> |
| <div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keywordflow">return</span> std::max(hll_constants::LG_INIT_SET_SIZE, HllUtil<A>::simpleIntLog2(ceilPwr2));</div> |
| <div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  }</div> |
| <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <span class="comment">//only used for HLL4</span></div> |
| <div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="keywordflow">return</span> std::max(hll_constants::LG_AUX_ARR_INTS[lgConfigK], HllUtil<A>::simpleIntLog2(ceilPwr2));</div> |
| <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> }</div> |
| <div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  </div> |
| <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> }</div> |
| <div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  </div> |
| <div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="preprocessor">#endif </span><span class="comment">/* _HLLUTIL_HPP_ */</span><span class="preprocessor"></span></div> |
| <div class="ttc" id="anamespacedatasketches_html"><div class="ttname"><a href="namespacedatasketches.html">datasketches</a></div><div class="ttdoc">DataSketches namespace.</div><div class="ttdef"><b>Definition:</b> binomial_bounds.hpp:38</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 |
| </small></address> |
| </body> |
| </html> |
