| <!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: tuple/include/tuple_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_00b03cb5ae954e8a2b89b347e34477b0.html">tuple</a></li><li class="navelem"><a class="el" href="dir_0bcb9827d33186afae8dcf178a314956.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">tuple_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 TUPLE_UNION_HPP_</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define TUPLE_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 "tuple_sketch.hpp"</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "theta_union_base.hpp"</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">// for types with defined + operation</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">template</span><<span class="keyword">typename</span> Summary></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">struct </span>default_tuple_union_policy {</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">void</span> operator()(Summary& summary, <span class="keyword">const</span> Summary& other)<span class="keyword"> const </span>{</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  summary += other;</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  }</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>  </div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">template</span><</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">typename</span> Summary,</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">typename</span> Policy = default_tuple_union_policy<Summary>,</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">typename</span> Allocator = std::allocator<Summary></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> ></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classdatasketches_1_1tuple__union.html"> 45</a></span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1tuple__union.html">tuple_union</a> {</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">using</span> Entry = std::pair<uint64_t, Summary>;</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">using</span> ExtractKey = pair_extract_key<uint64_t, Summary>;</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">using</span> <a class="code" href="classdatasketches_1_1tuple__sketch.html">Sketch</a> = <a class="code" href="classdatasketches_1_1tuple__sketch.html">tuple_sketch<Summary, Allocator></a>;</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">using</span> <a class="code" href="classdatasketches_1_1compact__tuple__sketch.html">CompactSketch</a> = <a class="code" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch<Summary, Allocator></a>;</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">using</span> AllocEntry = <span class="keyword">typename</span> std::allocator_traits<Allocator>::template rebind_alloc<Entry>;</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</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="l00053"></a><span class="lineno"> 53</span>  </div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// reformulate the external policy that operates on Summary</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// in terms of operations on Entry</span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">struct </span>internal_policy {</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  internal_policy(<span class="keyword">const</span> Policy& external_policy): external_policy_(external_policy) {}</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">void</span> operator()(Entry& internal_entry, <span class="keyword">const</span> Entry& incoming_entry)<span class="keyword"> const </span>{</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  external_policy_(internal_entry.second, incoming_entry.second);</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">void</span> operator()(Entry& internal_entry, Entry&& incoming_entry)<span class="keyword"> const </span>{</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  external_policy_(internal_entry.second, std::move(incoming_entry.second));</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">const</span> Policy& get_external_policy()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> external_policy_; }</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  Policy external_policy_;</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  };</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">using</span> State = theta_union_base<Entry, ExtractKey, internal_policy, Sketch, CompactSketch, AllocEntry>;</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// No constructor here. Use builder instead.</span></div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">class </span><a class="code" href="classdatasketches_1_1tuple__union_1_1builder.html">builder</a>;</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">template</span><<span class="keyword">typename</span> FwdSketch></div> |
| <div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classdatasketches_1_1tuple__union.html#a4fac8167b04c9b5dbaeb5ccbd053703c"> 78</a></span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1tuple__union.html#a4fac8167b04c9b5dbaeb5ccbd053703c">update</a>(FwdSketch&& sketch);</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="classdatasketches_1_1compact__tuple__sketch.html">CompactSketch</a> <a class="code" href="classdatasketches_1_1tuple__union.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="l00086"></a><span class="lineno"> 86</span>  </div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1tuple__union.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a>();</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="keyword">protected</span>:</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  State state_;</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="comment">// for builder</span></div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="classdatasketches_1_1tuple__union.html">tuple_union</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> Policy& policy, <span class="keyword">const</span> Allocator& allocator);</div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> };</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="keyword">template</span><<span class="keyword">typename</span> S, <span class="keyword">typename</span> P, <span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classdatasketches_1_1tuple__union_1_1builder.html"> 101</a></span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1tuple__union.html">tuple_union</a><S, P, A>::<a class="code" href="classdatasketches_1_1tuple__union_1_1builder.html">builder</a>: <span class="keyword">public</span> <a class="code" href="classdatasketches_1_1tuple__base__builder.html">tuple_base_builder</a><builder, P, A> {</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="classdatasketches_1_1tuple__union_1_1builder.html">builder</a>(<span class="keyword">const</span> P& policy = P(), <span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <a class="code" href="classdatasketches_1_1tuple__union.html">tuple_union</a> build() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</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="comment">/* namespace datasketches */</span></div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  </div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">#include "tuple_union_impl.hpp"</span></div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  </div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor">#endif</span></div> |
| <div class="ttc" id="aclassdatasketches_1_1compact__tuple__sketch_html"><div class="ttname"><a href="classdatasketches_1_1compact__tuple__sketch.html">datasketches::compact_tuple_sketch</a></div><div class="ttdoc">Compact Tuple sketch.</div><div class="ttdef"><b>Definition:</b> tuple_sketch.hpp:407</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1tuple__base__builder_html"><div class="ttname"><a href="classdatasketches_1_1tuple__base__builder.html">datasketches::tuple_base_builder</a></div><div class="ttdoc">Tuple base builder.</div><div class="ttdef"><b>Definition:</b> tuple_sketch.hpp:587</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1tuple__sketch_html"><div class="ttname"><a href="classdatasketches_1_1tuple__sketch.html">datasketches::tuple_sketch</a></div><div class="ttdoc">Base class for Tuple sketch.</div><div class="ttdef"><b>Definition:</b> tuple_sketch.hpp:54</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1tuple__union_1_1builder_html"><div class="ttname"><a href="classdatasketches_1_1tuple__union_1_1builder.html">datasketches::tuple_union::builder</a></div><div class="ttdoc">Tuple union builder.</div><div class="ttdef"><b>Definition:</b> tuple_union.hpp:101</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1tuple__union_html"><div class="ttname"><a href="classdatasketches_1_1tuple__union.html">datasketches::tuple_union</a></div><div class="ttdoc">Tuple Union.</div><div class="ttdef"><b>Definition:</b> tuple_union.hpp:45</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1tuple__union_html_a037835e8f8e6b5233fa0f0996bba6a99"><div class="ttname"><a href="classdatasketches_1_1tuple__union.html#a037835e8f8e6b5233fa0f0996bba6a99">datasketches::tuple_union::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> tuple_union_impl.hpp:34</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1tuple__union_html_a4fac8167b04c9b5dbaeb5ccbd053703c"><div class="ttname"><a href="classdatasketches_1_1tuple__union.html#a4fac8167b04c9b5dbaeb5ccbd053703c">datasketches::tuple_union::update</a></div><div class="ttdeci">void update(FwdSketch &&sketch)</div><div class="ttdoc">Update the union with a given sketch.</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1tuple__union_html_ad20897c5c8bd47f5d4005989bead0e55"><div class="ttname"><a href="classdatasketches_1_1tuple__union.html#ad20897c5c8bd47f5d4005989bead0e55">datasketches::tuple_union::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> tuple_union_impl.hpp:39</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> |
