| <!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" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>datasketches-cpp: kll/include/kll_helper.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 id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">datasketches-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_10f6c93aee96669dfb32574207aeb69c.html">kll</a></li><li class="navelem"><a class="el" href="dir_cf88e39abd5376065d05109bb16db9ef.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">kll_helper.hpp</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" 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 id="l00003" 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 id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" 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 id="l00006" 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 id="l00007" 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 id="l00008" 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 id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" 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 id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" 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 id="l00013" 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 id="l00014" 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 id="l00015" 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 id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef KLL_HELPER_HPP_</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define KLL_HELPER_HPP_</span></div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <stdexcept></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacedatasketches.html">datasketches</a> {</div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#ifdef KLL_VALIDATION</span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">extern</span> uint32_t kll_next_offset;</div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#endif</span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment">// 0 <= power <= 30</span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">static</span> <span class="keyword">const</span> uint64_t powers_of_three[] = {1, 3, 9, 27, 81, 243, 729, 2187, 6561, 19683, 59049, 177147, 531441,</div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>1594323, 4782969, 14348907, 43046721, 129140163, 387420489, 1162261467,</div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>3486784401, 10460353203, 31381059609, 94143178827, 282429536481,</div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>847288609443, 2541865828329, 7625597484987, 22876792454961, 68630377364883,</div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>205891132094649};</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">class </span>kll_helper {</div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> is_even(uint32_t value);</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> is_odd(uint32_t value);</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">static</span> <span class="keyword">inline</span> uint8_t floor_of_log2_of_fraction(uint64_t numer, uint64_t denom);</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">static</span> <span class="keyword">inline</span> uint8_t ub_on_num_levels(uint64_t n);</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">static</span> <span class="keyword">inline</span> uint32_t compute_total_capacity(uint16_t k, uint8_t m, uint8_t num_levels);</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">static</span> <span class="keyword">inline</span> uint16_t level_capacity(uint16_t k, uint8_t numLevels, uint8_t height, uint8_t min_wid);</div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">static</span> <span class="keyword">inline</span> uint16_t int_cap_aux(uint16_t k, uint8_t depth);</div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">static</span> <span class="keyword">inline</span> uint16_t int_cap_aux_aux(uint16_t k, uint8_t depth);</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">static</span> <span class="keyword">inline</span> uint64_t sum_the_sample_weights(uint8_t num_levels, <span class="keyword">const</span> uint32_t* levels);</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">static</span> <span class="keywordtype">void</span> randomly_halve_down(T* buf, uint32_t start, uint32_t length);</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">static</span> <span class="keywordtype">void</span> randomly_halve_up(T* buf, uint32_t start, uint32_t length);</div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// this version moves objects within the same buffer</span></div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="comment">// assumes that destination has initialized objects</span></div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// does not destroy the originals after the move</span></div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T, <span class="keyword">typename</span> C></div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">static</span> <span class="keywordtype">void</span> merge_sorted_arrays(T* buf, uint32_t start_a, uint32_t len_a, uint32_t start_b, uint32_t len_b, uint32_t start_c);</div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// this version is to merge from two different buffers into a third buffer</span></div> |
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="comment">// initializes objects is the destination buffer</span></div> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="comment">// moves objects from buf_a and destroys the originals</span></div> |
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// copies objects from buf_b</span></div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T, <span class="keyword">typename</span> C></div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">static</span> <span class="keywordtype">void</span> merge_sorted_arrays(<span class="keyword">const</span> T* buf_a, uint32_t start_a, uint32_t len_a, <span class="keyword">const</span> T* buf_b, uint32_t start_b, uint32_t len_b, T* buf_c, uint32_t start_c);</div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">struct </span>compress_result {</div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> uint8_t final_num_levels;</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> uint32_t final_capacity;</div> |
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> uint32_t final_num_items;</div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> };</div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="comment">/*</span></div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment"> * Here is what we do for each level:</span></div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"> * If it does not need to be compacted, then simply copy it over.</span></div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment"> * Otherwise, it does need to be compacted, so...</span></div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"> * Copy zero or one guy over.</span></div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment"> * If the level above is empty, halve up.</span></div> |
| <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment"> * Else the level above is nonempty, so...</span></div> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment"> * halve down, then merge up.</span></div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"> * Adjust the boundaries of the level above.</span></div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment"> * It can be proved that general_compress returns a sketch that satisfies the space constraints</span></div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment"> * no matter how much data is passed in.</span></div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment"> * All levels except for level zero must be sorted before calling this, and will still be</span></div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment"> * sorted afterwards.</span></div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment"> * Level zero is not required to be sorted before, and may not be sorted afterwards.</span></div> |
| <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T, <span class="keyword">typename</span> C></div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">static</span> compress_result general_compress(uint16_t k, uint8_t m, uint8_t num_levels_in, T* items,</div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> uint32_t* in_levels, uint32_t* out_levels, <span class="keywordtype">bool</span> is_level_zero_sorted);</div> |
| <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">static</span> <span class="keywordtype">void</span> copy_construct(<span class="keyword">const</span> T* src, <span class="keywordtype">size_t</span> src_first, <span class="keywordtype">size_t</span> src_last, T* dst, <span class="keywordtype">size_t</span> dst_first);</div> |
| <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div> |
| <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keyword">static</span> <span class="keywordtype">void</span> move_construct(T* src, <span class="keywordtype">size_t</span> src_first, <span class="keywordtype">size_t</span> src_last, T* dst, <span class="keywordtype">size_t</span> dst_first, <span class="keywordtype">bool</span> destroy);</div> |
| <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="preprocessor">#ifdef KLL_VALIDATION</span></div> |
| <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div> |
| <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keyword">static</span> <span class="keyword">inline</span> uint32_t deterministic_offset();</div> |
| <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="preprocessor">#endif</span></div> |
| <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div> |
| <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span>};</div> |
| <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div> |
| <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span>} <span class="comment">/* namespace datasketches */</span></div> |
| <div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div> |
| <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="preprocessor">#include "kll_helper_impl.hpp"</span></div> |
| <div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div> |
| <div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="preprocessor">#endif </span><span class="comment">// KLL_HELPER_HPP_</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.8 |
| </small></address> |
| </body> |
| </html> |
