| <!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: fi/include/reverse_purge_hash_map.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_f1edaa446c592ba78db5fad06a956381.html">fi</a></li><li class="navelem"><a class="el" href="dir_70f016e26945e18c18bc29cf7b499574.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">reverse_purge_hash_map.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 REVERSE_PURGE_HASH_MAP_HPP_</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define REVERSE_PURGE_HASH_MAP_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 <memory></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <iterator></span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespacedatasketches.html">datasketches</a> {</div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * This is a specialized linear-probing hash map with a reverse purge operation</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * that removes all entries in the map with values that are less than zero.</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * Based on Java implementation here:</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * https://github.com/apache/datasketches-java/blob/master/src/main/java/org/apache/datasketches/frequencies/ReversePurgeItemHashMap.java</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * author Alexander Saydakov</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">template</span><</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">typename</span> K,</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">typename</span> V = uint64_t,</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">typename</span> H = std::hash<K>,</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">typename</span> E = std::equal_to<K>,</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">typename</span> A = std::allocator<K></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">class </span>reverse_purge_hash_map {</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">using</span> AllocV = <span class="keyword">typename</span> std::allocator_traits<A>::template rebind_alloc<V>;</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">using</span> AllocU16 = <span class="keyword">typename</span> std::allocator_traits<A>::template rebind_alloc<uint16_t>;</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>  reverse_purge_hash_map(uint8_t lg_size, uint8_t lg_max_size, <span class="keyword">const</span> E& equal, <span class="keyword">const</span> A& allocator);</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  reverse_purge_hash_map(<span class="keyword">const</span> reverse_purge_hash_map& other);</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  reverse_purge_hash_map(reverse_purge_hash_map&& other) noexcept;</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  ~reverse_purge_hash_map();</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  reverse_purge_hash_map& operator=(<span class="keyword">const</span> reverse_purge_hash_map& other);</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  reverse_purge_hash_map& operator=(reverse_purge_hash_map&& other);</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">template</span><<span class="keyword">typename</span> FwdK></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  V adjust_or_insert(FwdK&& key, V value);</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>  V get(<span class="keyword">const</span> K& key) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  uint8_t get_lg_cur_size() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  uint8_t get_lg_max_size() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  uint32_t get_capacity() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  uint32_t get_num_active() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">const</span> A& get_allocator() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">class </span>iterator;</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  iterator begin() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  iterator end() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">static</span> constexpr <span class="keywordtype">double</span> LOAD_FACTOR = 0.75;</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">static</span> constexpr uint16_t DRIFT_LIMIT = 1024; <span class="comment">// used only for stress testing</span></div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">static</span> constexpr uint32_t MAX_SAMPLE_SIZE = 1024; <span class="comment">// number of samples to compute approximate median during purge</span></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>  E equal_;</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  A allocator_;</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  uint8_t lg_cur_size_;</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  uint8_t lg_max_size_;</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  uint32_t num_active_;</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  K* keys_;</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  V* values_;</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  uint16_t* states_;</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> is_active(uint32_t probe) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">void</span> subtract_and_keep_positive_only(V amount);</div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> hash_delete(uint32_t probe);</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  uint32_t internal_adjust_or_insert(<span class="keyword">const</span> K& key, V value);</div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  V resize_or_purge_if_needed();</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">void</span> resize(uint8_t lg_new_size);</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  V purge();</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> };</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">// This iterator uses strides based on golden ratio to avoid clustering during merge</span></div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">template</span><<span class="keyword">typename</span> K, <span class="keyword">typename</span> V, <span class="keyword">typename</span> H, <span class="keyword">typename</span> E, <span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keyword">class </span>reverse_purge_hash_map<K, V, H, E, A>::iterator {</div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">using</span> iterator_category = std::input_iterator_tag;</div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">using</span> value_type = std::pair<K&, V>;</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">using</span> difference_type = void;</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">using</span> pointer = void;</div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">using</span> reference = <span class="keyword">const</span> value_type;</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">friend</span> <span class="keyword">class </span>reverse_purge_hash_map<K, V, H, E, A>;</div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  iterator& operator++() {</div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  ++count;</div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">if</span> (count < map->num_active_) {</div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">const</span> uint32_t mask = (1 << map->lg_cur_size_) - 1;</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordflow">do</span> {</div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  index = (index + stride) & mask;</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  } <span class="keywordflow">while</span> (!map->is_active(index));</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>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  }</div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  iterator operator++(<span class="keywordtype">int</span>) { iterator tmp(*<span class="keyword">this</span>); operator++(); <span class="keywordflow">return</span> tmp; }</div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> iterator& rhs)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> count == rhs.count; }</div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> iterator& rhs)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> count != rhs.count; }</div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  reference operator*()<span class="keyword"> const </span>{</div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">return</span> value_type(map->keys_[index], map->values_[index]);</div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  }</div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">static</span> constexpr <span class="keywordtype">double</span> GOLDEN_RATIO_RECIPROCAL = 0.6180339887498949; <span class="comment">// = (sqrt(5) - 1) / 2</span></div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">const</span> reverse_purge_hash_map<K, V, H, E, A>* map;</div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  uint32_t index;</div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  uint32_t count;</div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  uint32_t stride;</div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  iterator(<span class="keyword">const</span> reverse_purge_hash_map<K, V, H, E, A>* map, uint32_t index, uint32_t count):</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  map(map), index(index), count(count), stride(static_cast<uint32_t>((1 << map->lg_cur_size_) * GOLDEN_RATIO_RECIPROCAL) | 1) {}</div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> };</div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  </div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> } <span class="comment">/* namespace datasketches */</span></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> <span class="preprocessor">#include "reverse_purge_hash_map_impl.hpp"</span></div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#endif</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> |
