| <!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: theta/include/theta_union.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_e96b5dfe115c13cdeb36484e37aec42e.html">theta</a></li><li class="navelem"><a class="el" href="dir_3f8742d40c9573c3b90638004faf146b.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">theta_union.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 THETA_UNION_HPP_</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define THETA_UNION_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 "serde.hpp"</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "theta_sketch.hpp"</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "theta_union_base.hpp"</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespacedatasketches.html">datasketches</a> {</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="comment">// forward declaration</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">template</span><<span class="keyword">typename</span> A> <span class="keyword">class </span>theta_union_alloc;</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// alias with default allocator for convenience</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">using</span> theta_union = theta_union_alloc<std::allocator<uint64_t>>;</div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">template</span><<span class="keyword">typename</span> Allocator = std::allocator<u<span class="keywordtype">int</span>64_t>></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classdatasketches_1_1theta__union__alloc.html"> 40</a></span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1theta__union__alloc.html">theta_union_alloc</a> {</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">using</span> Entry = uint64_t;</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">using</span> ExtractKey = trivial_extract_key;</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">using</span> <a class="code" href="classdatasketches_1_1theta__sketch__alloc.html">Sketch</a> = <a class="code" href="classdatasketches_1_1theta__sketch__alloc.html">theta_sketch_alloc<Allocator></a>;</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">using</span> <a class="code" href="classdatasketches_1_1compact__theta__sketch__alloc.html">CompactSketch</a> = <a class="code" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc<Allocator></a>;</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">using</span> resize_factor = <a class="code" href="namespacedatasketches_1_1theta__constants.html#a329224ced789e065aed0698566b954a4">theta_constants::resize_factor</a>;</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="comment">// there is no payload in Theta sketch entry</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">struct </span>nop_policy {</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> operator()(uint64_t internal_entry, uint64_t incoming_entry)<span class="keyword"> const </span>{</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  unused(internal_entry);</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  unused(incoming_entry);</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</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">using</span> State = theta_union_base<Entry, ExtractKey, nop_policy, Sketch, CompactSketch, Allocator>;</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// No constructor here. Use builder instead.</span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">class </span><a class="code" href="classdatasketches_1_1theta__union__alloc_1_1builder.html">builder</a>;</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">template</span><<span class="keyword">typename</span> FwdSketch></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1theta__union__alloc.html#a4fac8167b04c9b5dbaeb5ccbd053703c">update</a>(FwdSketch&& sketch);</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classdatasketches_1_1compact__theta__sketch__alloc.html">CompactSketch</a> <a class="code" href="classdatasketches_1_1theta__union__alloc.html#a037835e8f8e6b5233fa0f0996bba6a99">get_result</a>(<span class="keywordtype">bool</span> ordered = <span class="keyword">true</span>) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1theta__union__alloc.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a>();</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  State state_;</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// for builder</span></div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classdatasketches_1_1theta__union__alloc.html">theta_union_alloc</a>(uint8_t lg_cur_size, uint8_t lg_nom_size, resize_factor rf, <span class="keywordtype">float</span> p, uint64_t theta, uint64_t seed, <span class="keyword">const</span> Allocator& allocator);</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>  </div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classdatasketches_1_1theta__union__alloc_1_1builder.html"> 86</a></span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1theta__union__alloc.html">theta_union_alloc</a><A>::<a class="code" href="classdatasketches_1_1theta__union__alloc_1_1builder.html">builder</a>: <span class="keyword">public</span> <a class="code" href="classdatasketches_1_1theta__base__builder.html">theta_base_builder</a><builder, A> {</div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classdatasketches_1_1theta__union__alloc_1_1builder.html">builder</a>(<span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="code" href="classdatasketches_1_1theta__union__alloc.html">theta_union_alloc<A></a> build() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> };</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> } <span class="comment">/* namespace datasketches */</span></div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#include "theta_union_impl.hpp"</span></div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#endif</span></div> |
| <div class="ttc" id="aclassdatasketches_1_1compact__theta__sketch__alloc_html"><div class="ttname"><a href="classdatasketches_1_1compact__theta__sketch__alloc.html">datasketches::compact_theta_sketch_alloc</a></div><div class="ttdoc">Compact Theta sketch.</div><div class="ttdef"><b>Definition:</b> theta_sketch.hpp:359</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1theta__base__builder_html"><div class="ttname"><a href="classdatasketches_1_1theta__base__builder.html">datasketches::theta_base_builder</a></div><div class="ttdoc">Theta base builder.</div><div class="ttdef"><b>Definition:</b> theta_update_sketch_base.hpp:97</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1theta__sketch__alloc_html"><div class="ttname"><a href="classdatasketches_1_1theta__sketch__alloc.html">datasketches::theta_sketch_alloc</a></div><div class="ttdoc">Base class for the Theta Sketch, a generalization of the Kth Minimum Value (KMV) sketch.</div><div class="ttdef"><b>Definition:</b> theta_sketch.hpp:127</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1theta__union__alloc_1_1builder_html"><div class="ttname"><a href="classdatasketches_1_1theta__union__alloc_1_1builder.html">datasketches::theta_union_alloc::builder</a></div><div class="ttdoc">Theta union builder.</div><div class="ttdef"><b>Definition:</b> theta_union.hpp:86</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1theta__union__alloc_html"><div class="ttname"><a href="classdatasketches_1_1theta__union__alloc.html">datasketches::theta_union_alloc</a></div><div class="ttdoc">Theta Union.</div><div class="ttdef"><b>Definition:</b> theta_union.hpp:40</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1theta__union__alloc_html_a037835e8f8e6b5233fa0f0996bba6a99"><div class="ttname"><a href="classdatasketches_1_1theta__union__alloc.html#a037835e8f8e6b5233fa0f0996bba6a99">datasketches::theta_union_alloc::get_result</a></div><div class="ttdeci">CompactSketch get_result(bool ordered=true) const</div><div class="ttdoc">Produces a copy of the current state of the union as a compact sketch.</div><div class="ttdef"><b>Definition:</b> theta_union_impl.hpp:37</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1theta__union__alloc_html_a4fac8167b04c9b5dbaeb5ccbd053703c"><div class="ttname"><a href="classdatasketches_1_1theta__union__alloc.html#a4fac8167b04c9b5dbaeb5ccbd053703c">datasketches::theta_union_alloc::update</a></div><div class="ttdeci">void update(FwdSketch &&sketch)</div><div class="ttdoc">Update the union with a given sketch.</div><div class="ttdef"><b>Definition:</b> theta_union_impl.hpp:32</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1theta__union__alloc_html_ad20897c5c8bd47f5d4005989bead0e55"><div class="ttname"><a href="classdatasketches_1_1theta__union__alloc.html#ad20897c5c8bd47f5d4005989bead0e55">datasketches::theta_union_alloc::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Reset the union to the initial empty state.</div><div class="ttdef"><b>Definition:</b> theta_union_impl.hpp:42</div></div> |
| <div class="ttc" id="anamespacedatasketches_1_1theta__constants_html_a329224ced789e065aed0698566b954a4"><div class="ttname"><a href="namespacedatasketches_1_1theta__constants.html#a329224ced789e065aed0698566b954a4">datasketches::theta_constants::resize_factor</a></div><div class="ttdeci">datasketches::resize_factor resize_factor</div><div class="ttdoc">hash table resize factor</div><div class="ttdef"><b>Definition:</b> theta_constants.hpp:31</div></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> |
