| <!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: sampling/include/var_opt_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_135820457b1e8e8dc5343e26fb29c1f8.html">sampling</a></li><li class="navelem"><a class="el" href="dir_577378e109fcef5e822b70d599376114.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">var_opt_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 _VAR_OPT_UNION_HPP_</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define _VAR_OPT_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 "var_opt_sketch.hpp"</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "common_defs.hpp"</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "serde.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="preprocessor">#include <vector></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="keyword">namespace </span><a class="code" href="namespacedatasketches.html">datasketches</a> {</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">template</span><<span class="keyword">typename</span> A> <span class="keyword">using</span> AllocU8 = <span class="keyword">typename</span> std::allocator_traits<A>::template rebind_alloc<uint8_t>;</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">template</span><</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">typename</span> T,</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">typename</span> A = std::allocator<T></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> ></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classdatasketches_1_1var__opt__union.html"> 52</a></span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</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="keyword">public</span>:</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">explicit</span> <a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a>(uint32_t max_k, <span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a>& other);</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a>(<a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a>&& other) noexcept;</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  ~<a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a>();</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a>& operator=(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a>& other);</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a>& operator=(<a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a>&& other);</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1var__opt__union.html#a34ccfdbae9cae36faf1093e12da38d0c">update</a>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a>& sk);</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1var__opt__union.html#a34ccfdbae9cae36faf1093e12da38d0c">update</a>(<a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a>&& sk);</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a> <a class="code" href="classdatasketches_1_1var__opt__union.html#a28e630639a11dc71d7f72c4e0518b2fe">get_result</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1var__opt__union.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a>();</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">template</span><<span class="keyword">typename</span> SerDe = serde<T>></div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">size_t</span> <a class="code" href="classdatasketches_1_1var__opt__union.html#a8762fed25b3024f07989976344dd0afb">get_serialized_size_bytes</a>(<span class="keyword">const</span> SerDe& sd = SerDe()) <span class="keyword">const</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="comment">// This is a convenience alias for users</span></div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">// The type returned by the following serialize method</span></div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">typedef</span> vector_u8<A> vector_bytes;</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">template</span><<span class="keyword">typename</span> SerDe = serde<T>></div> |
| <div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classdatasketches_1_1var__opt__union.html#a1d0c269c23926e93b1c7a9c00e86af97"> 113</a></span>  vector_bytes <a class="code" href="classdatasketches_1_1var__opt__union.html#a1d0c269c23926e93b1c7a9c00e86af97">serialize</a>(<span class="keywordtype">unsigned</span> header_size_bytes = 0, <span class="keyword">const</span> SerDe& sd = SerDe()) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  </div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">template</span><<span class="keyword">typename</span> SerDe = serde<T>></div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1var__opt__union.html#a1d0c269c23926e93b1c7a9c00e86af97">serialize</a>(std::ostream& os, <span class="keyword">const</span> SerDe& sd = SerDe()) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  </div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">template</span><<span class="keyword">typename</span> SerDe = serde<T>></div> |
| <div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classdatasketches_1_1var__opt__union.html#afc62fc9782cf19d45830a2b2527a6771"> 133</a></span>  <span class="keyword">static</span> <a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a> <a class="code" href="classdatasketches_1_1var__opt__union.html#afc62fc9782cf19d45830a2b2527a6771">deserialize</a>(std::istream& is, <span class="keyword">const</span> SerDe& sd = SerDe(), <span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  </div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keyword">template</span><<span class="keyword">typename</span> SerDe = serde<T>></div> |
| <div class="line"><a name="l00145"></a><span class="lineno"><a class="line" href="classdatasketches_1_1var__opt__union.html#a7293f80212b67942ab29811b299bb8c6"> 145</a></span>  <span class="keyword">static</span> <a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a> <a class="code" href="classdatasketches_1_1var__opt__union.html#a7293f80212b67942ab29811b299bb8c6">deserialize</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* bytes, <span class="keywordtype">size_t</span> size, <span class="keyword">const</span> SerDe& sd = SerDe(), <span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  </div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  string<A> <a class="code" href="classdatasketches_1_1var__opt__union.html#aed372241c10ffd041bee85602edb199a">to_string</a>() <span class="keyword">const</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">private</span>:</div> |
| <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keyword">using</span> AllocSketch = <span class="keyword">typename</span> std::allocator_traits<A>::template rebind_alloc<var_opt_sketch<T, A>>;</div> |
| <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keyword">using</span> AllocDouble = <span class="keyword">typename</span> std::allocator_traits<A>::template rebind_alloc<double>;</div> |
| <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">using</span> AllocBool = <span class="keyword">typename</span> std::allocator_traits<A>::template rebind_alloc<bool>;</div> |
| <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  </div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t PREAMBLE_LONGS_EMPTY = 1;</div> |
| <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t PREAMBLE_LONGS_NON_EMPTY = 4;</div> |
| <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t SER_VER = 2;</div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FAMILY_ID = 14;</div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t EMPTY_FLAG_MASK = 4;</div> |
| <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  </div> |
| <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  uint64_t n_; <span class="comment">// cumulative over all input sketches</span></div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  </div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="comment">// outer tau is the largest tau of any input sketch</span></div> |
| <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keywordtype">double</span> outer_tau_numer_; <span class="comment">// total weight of all input R-zones where tau = outer_tau</span></div> |
| <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  </div> |
| <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="comment">// total cardinality of the same R-zones, or zero if no input sketch was in estimation mode</span></div> |
| <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  uint64_t outer_tau_denom_;</div> |
| <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  </div> |
| <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  uint32_t max_k_;</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>  A allocator_;</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>  <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a> gadget_;</div> |
| <div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  </div> |
| <div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a>(uint64_t n, <span class="keywordtype">double</span> outer_tau_numer, uint64_t outer_tau_denom,</div> |
| <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  uint32_t max_k, <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a>&& gadget, <span class="keyword">const</span> A& allocator = A());</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>  <span class="comment">/*</span></div> |
| <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> IMPORTANT NOTE: the "gadget" in the union object appears to be a varopt sketch,</span></div> |
| <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> but in fact is NOT because it doesn't satisfy the mathematical definition</span></div> |
| <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> of a varopt sketch of the concatenated input streams. Therefore it could be different</span></div> |
| <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> from a true varopt sketch with that value of K, in which case it could easily provide</span></div> |
| <div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> worse estimation accuracy for subset-sum queries.</span></div> |
| <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> This should not surprise you; the approximation guarantees of varopt sketches</span></div> |
| <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> do not apply to things that merely resemble varopt sketches.</span></div> |
| <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> However, even though the gadget is not a varopt sketch, the result</span></div> |
| <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> of the unioning process IS a varopt sketch. It is constructed by a</span></div> |
| <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> somewhat complicated "resolution" process which determines the largest K</span></div> |
| <div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> that a valid varopt sketch could have given the available information,</span></div> |
| <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> then constructs a varopt sketch of that size and returns it.</span></div> |
| <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> However, the gadget itself is not touched during the resolution process,</span></div> |
| <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> and additional sketches could subsequently be merged into the union,</span></div> |
| <div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> at which point a varopt result could again be requested.</span></div> |
| <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  </div> |
| <div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="comment">/*</span></div> |
| <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> Explanation of "marked items" in the union's gadget:</span></div> |
| <div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> The boolean value "true" in an pair indicates that the item</span></div> |
| <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> came from an input sketch's R zone, so it is already the result of sampling.</span></div> |
| <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> Therefore it must not wind up in the H zone of the final result, because</span></div> |
| <div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> that would imply that the item is "exact".</span></div> |
| <div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> However, it is okay for a marked item to hang out in the gadget's H zone for a while.</span></div> |
| <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> And once the item has moved to the gadget's R zone, the mark is never checked again,</span></div> |
| <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> so no effort is made to ensure that its value is preserved or even makes sense.</span></div> |
| <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  </div> |
| <div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="comment">/*</span></div> |
| <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> Note: if the computer could perform exact real-valued arithmetic, the union could finalize</span></div> |
| <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> its result by reducing k until inner_tau > outer_tau. [Due to the vagaries of floating point</span></div> |
| <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> arithmetic, we won't attempt to detect and specially handle the inner_tau = outer_tau special</span></div> |
| <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> case.]</span></div> |
| <div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> In fact, we won't even look at tau while while reducing k. Instead the logic will be based</span></div> |
| <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> on the more robust integer quantity num_marks_in_h_ in the gadget. It is conceivable that due</span></div> |
| <div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> to round-off error we could end up with inner_tau slightly less than outer_tau, but that should</span></div> |
| <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> be fairly harmless since we will have achieved our goal of getting the marked items out of H.</span></div> |
| <div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> Also, you might be wondering why we are bothering to maintain the numerator and denominator</span></div> |
| <div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> separately instead of just having a single variable outer_tau. This allows us (in certain</span></div> |
| <div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> cases) to add an input's entire R-zone weight into the result sketch, as opposed to subdividing</span></div> |
| <div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> it then adding it back up. That would be a source of numerical inaccuracy. And even</span></div> |
| <div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> more importantly, this design choice allows us to exactly re-construct the input sketch</span></div> |
| <div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> when there is only one of them.</span></div> |
| <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> merge_items(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a>& sk);</div> |
| <div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> merge_items(<a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a>&& sk);</div> |
| <div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> resolve_tau(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a>& sketch);</div> |
| <div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  </div> |
| <div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="keywordtype">double</span> get_outer_tau() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  </div> |
| <div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a> simple_gadget_coercer() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  </div> |
| <div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <span class="keywordtype">bool</span> there_exist_unmarked_h_items_lighter_than_target(<span class="keywordtype">double</span> threshold) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <span class="keywordtype">bool</span> detect_and_handle_subcase_of_pseudo_exact(<a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a>& sk) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  <span class="keywordtype">void</span> mark_moving_gadget_coercer(<a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a>& sk) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  <span class="keywordtype">void</span> migrate_marked_items_by_decreasing_k(<a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a>& sk) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  </div> |
| <div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_preamble_longs(uint8_t preamble_longs, uint8_t flags);</div> |
| <div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_family_and_serialization_version(uint8_t family_id, uint8_t ser_ver);</div> |
| <div class="line"><a name="l00250"></a><span class="lineno"> 250</span> };</div> |
| <div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  </div> |
| <div class="line"><a name="l00252"></a><span class="lineno"> 252</span> }</div> |
| <div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  </div> |
| <div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="preprocessor">#include "var_opt_union_impl.hpp"</span></div> |
| <div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  </div> |
| <div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="preprocessor">#endif </span><span class="comment">// _VAR_OPT_UNION_HPP_</span></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html">datasketches::var_opt_sketch< T, A ></a></div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__union_html"><div class="ttname"><a href="classdatasketches_1_1var__opt__union.html">datasketches::var_opt_union</a></div><div class="ttdoc">Provides a unioning operation over var_opt_sketch objects.</div><div class="ttdef"><b>Definition:</b> var_opt_union.hpp:52</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__union_html_a1d0c269c23926e93b1c7a9c00e86af97"><div class="ttname"><a href="classdatasketches_1_1var__opt__union.html#a1d0c269c23926e93b1c7a9c00e86af97">datasketches::var_opt_union::serialize</a></div><div class="ttdeci">vector_bytes serialize(unsigned header_size_bytes=0, const SerDe &sd=SerDe()) const</div><div class="ttdoc">NOTE: This method may be deprecated in a future version.</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__union_html_a28e630639a11dc71d7f72c4e0518b2fe"><div class="ttname"><a href="classdatasketches_1_1var__opt__union.html#a28e630639a11dc71d7f72c4e0518b2fe">datasketches::var_opt_union::get_result</a></div><div class="ttdeci">var_opt_sketch< T, A > get_result() const</div><div class="ttdoc">Gets the varopt sketch resulting from the union of any input sketches.</div><div class="ttdef"><b>Definition:</b> var_opt_union_impl.hpp:425</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__union_html_a34ccfdbae9cae36faf1093e12da38d0c"><div class="ttname"><a href="classdatasketches_1_1var__opt__union.html#a34ccfdbae9cae36faf1093e12da38d0c">datasketches::var_opt_union::update</a></div><div class="ttdeci">void update(const var_opt_sketch< T, A > &sk)</div><div class="ttdoc">Updates this union with the given sketch This method takes an lvalue.</div><div class="ttdef"><b>Definition:</b> var_opt_union_impl.hpp:323</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__union_html_a7293f80212b67942ab29811b299bb8c6"><div class="ttname"><a href="classdatasketches_1_1var__opt__union.html#a7293f80212b67942ab29811b299bb8c6">datasketches::var_opt_union::deserialize</a></div><div class="ttdeci">static var_opt_union deserialize(const void *bytes, size_t size, const SerDe &sd=SerDe(), const A &allocator=A())</div><div class="ttdoc">NOTE: This method may be deprecated in a future version.</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__union_html_a8762fed25b3024f07989976344dd0afb"><div class="ttname"><a href="classdatasketches_1_1var__opt__union.html#a8762fed25b3024f07989976344dd0afb">datasketches::var_opt_union::get_serialized_size_bytes</a></div><div class="ttdeci">size_t get_serialized_size_bytes(const SerDe &sd=SerDe()) const</div><div class="ttdoc">Computes size needed to serialize the current state of the union.</div><div class="ttdef"><b>Definition:</b> var_opt_union_impl.hpp:218</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__union_html_ad20897c5c8bd47f5d4005989bead0e55"><div class="ttname"><a href="classdatasketches_1_1var__opt__union.html#ad20897c5c8bd47f5d4005989bead0e55">datasketches::var_opt_union::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Resets the union to its default, empty state.</div><div class="ttdef"><b>Definition:</b> var_opt_union_impl.hpp:301</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__union_html_aed372241c10ffd041bee85602edb199a"><div class="ttname"><a href="classdatasketches_1_1var__opt__union.html#aed372241c10ffd041bee85602edb199a">datasketches::var_opt_union::to_string</a></div><div class="ttdeci">string< A > to_string() const</div><div class="ttdoc">Prints a summary of the union as a string.</div><div class="ttdef"><b>Definition:</b> var_opt_union_impl.hpp:309</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__union_html_afc62fc9782cf19d45830a2b2527a6771"><div class="ttname"><a href="classdatasketches_1_1var__opt__union.html#afc62fc9782cf19d45830a2b2527a6771">datasketches::var_opt_union::deserialize</a></div><div class="ttdeci">static var_opt_union deserialize(std::istream &is, const SerDe &sd=SerDe(), const A &allocator=A())</div><div class="ttdoc">NOTE: This method may be deprecated in a future version.</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> |
