| <!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_sketch.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_sketch.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_SKETCH_HPP_</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define _VAR_OPT_SKETCH_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 "common_defs.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="preprocessor">#include <iterator></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> <span class="keyword">template</span><<span class="keyword">typename</span> A> <span class="keyword">using</span> vector_u8 = std::vector<uint8_t, AllocU8<A>>;</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> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * A struct to hold the result of subset sum queries</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">struct </span>subset_summary {</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">double</span> lower_bound;</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">double</span> estimate;</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">double</span> upper_bound;</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">double</span> total_sketch_weight;</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> };</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T, <span class="keyword">typename</span> A> <span class="keyword">class </span>var_opt_union; <span class="comment">// forward declaration</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div> |
| <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1var__opt__constants.html"> 47</a></span> <span class="keyword">namespace </span>var_opt_constants {</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1var__opt__constants.html#a02799eee5e87428b1c72e6c4c282d68e"> 49</a></span>  <span class="keyword">const</span> resize_factor <a class="code" href="namespacedatasketches_1_1var__opt__constants.html#a02799eee5e87428b1c72e6c4c282d68e">DEFAULT_RESIZE_FACTOR</a> = resize_factor::X8;</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1var__opt__constants.html#aef0073265694689f2a7281205c133523"> 51</a></span>  <span class="keyword">const</span> uint32_t <a class="code" href="namespacedatasketches_1_1var__opt__constants.html#aef0073265694689f2a7281205c133523">MAX_K</a> = ((uint32_t) 1 << 31) - 2;</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> }</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">template</span><</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">typename</span> T,</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">typename</span> A = std::allocator<T></div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> ></div> |
| <div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classdatasketches_1_1var__opt__sketch.html"> 67</a></span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch</a> {</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">static</span> <span class="keyword">const</span> resize_factor DEFAULT_RESIZE_FACTOR = <a class="code" href="namespacedatasketches_1_1var__opt__constants.html#a02799eee5e87428b1c72e6c4c282d68e">var_opt_constants::DEFAULT_RESIZE_FACTOR</a>;</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint32_t MAX_K = <a class="code" href="namespacedatasketches_1_1var__opt__constants.html#aef0073265694689f2a7281205c133523">var_opt_constants::MAX_K</a>;</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">explicit</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a6df9f2226b7197a0f612ee4aec0233e7">var_opt_sketch</a>(uint32_t k,</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  resize_factor rf = <a class="code" href="namespacedatasketches_1_1var__opt__constants.html#a02799eee5e87428b1c72e6c4c282d68e">var_opt_constants::DEFAULT_RESIZE_FACTOR</a>,</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a6df9f2226b7197a0f612ee4aec0233e7">var_opt_sketch</a>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch</a>& other);</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a6df9f2226b7197a0f612ee4aec0233e7">var_opt_sketch</a>(<a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch</a>&& other) noexcept;</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>  ~<a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch</a>();</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch</a>& <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a247dd627502e887562ae763adfe863ff">operator=</a>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch</a>& other);</div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  </div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch</a>& <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a247dd627502e887562ae763adfe863ff">operator=</a>(<a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch</a>&& other);</div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a1125ed18baf3f257b5796321c7ec0f8f">update</a>(<span class="keyword">const</span> T& item, <span class="keywordtype">double</span> weight = 1.0);</div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  </div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a1125ed18baf3f257b5796321c7ec0f8f">update</a>(T&& item, <span class="keywordtype">double</span> weight = 1.0);</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">inline</span> uint32_t <a class="code" href="classdatasketches_1_1var__opt__sketch.html#af561f5cd76ff61773713c627bc53b0a2">get_k</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </div> |
| <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">inline</span> uint64_t <a class="code" href="classdatasketches_1_1var__opt__sketch.html#af857be9469a7565252626f27e1f9d74d">get_n</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  </div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">inline</span> uint32_t <a class="code" href="classdatasketches_1_1var__opt__sketch.html#ac481918ec96d79b27813d32bcc2a247d">get_num_samples</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  </div> |
| <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keyword">template</span><<span class="keyword">typename</span> P></div> |
| <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  subset_summary <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a71f1302dd93f895508f65893f96796fa">estimate_subset_sum</a>(P predicate) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  </div> |
| <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a5a2b7a58dc85678d08752945ff655362">is_empty</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  </div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a>();</div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  </div> |
| <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keyword">template</span><<span class="keyword">typename</span> TT = T, <span class="keyword">typename</span> SerDe = serde<T>, <span class="keyword">typename</span> std::enable_if<std::is_arithmetic<TT>::value, <span class="keywordtype">int</span>>::type = 0></div> |
| <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html#ad9a5259d93d148b5c2050d68e7788716">get_serialized_size_bytes</a>(<span class="keyword">const</span> SerDe& sd = SerDe()) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  </div> |
| <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keyword">template</span><<span class="keyword">typename</span> TT = T, <span class="keyword">typename</span> SerDe = serde<T>, <span class="keyword">typename</span> std::enable_if<!std::is_arithmetic<TT>::value, <span class="keywordtype">int</span>>::type = 0></div> |
| <div class="line"><a name="l00183"></a><span class="lineno"><a class="line" href="classdatasketches_1_1var__opt__sketch.html#ad9a5259d93d148b5c2050d68e7788716"> 183</a></span>  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html#ad9a5259d93d148b5c2050d68e7788716">get_serialized_size_bytes</a>(<span class="keyword">const</span> SerDe& sd = SerDe()) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  </div> |
| <div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="comment">// This is a convenience alias for users</span></div> |
| <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="comment">// The type returned by the following serialize method</span></div> |
| <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keyword">using</span> vector_bytes = vector_u8<A>;</div> |
| <div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  </div> |
| <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keyword">template</span><<span class="keyword">typename</span> SerDe = serde<T>></div> |
| <div class="line"><a name="l00198"></a><span class="lineno"><a class="line" href="classdatasketches_1_1var__opt__sketch.html#a1d0c269c23926e93b1c7a9c00e86af97"> 198</a></span>  vector_bytes <a class="code" href="classdatasketches_1_1var__opt__sketch.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="l00199"></a><span class="lineno"> 199</span>  </div> |
| <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keyword">template</span><<span class="keyword">typename</span> SerDe = serde<T>></div> |
| <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.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="l00207"></a><span class="lineno"> 207</span>  </div> |
| <div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keyword">template</span><<span class="keyword">typename</span> SerDe = serde<T>></div> |
| <div class="line"><a name="l00216"></a><span class="lineno"><a class="line" href="classdatasketches_1_1var__opt__sketch.html#aea8f1c4a6d0189de0db5b5cd085c39b1"> 216</a></span>  <span class="keyword">static</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch</a> <a class="code" href="classdatasketches_1_1var__opt__sketch.html#aea8f1c4a6d0189de0db5b5cd085c39b1">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="l00217"></a><span class="lineno"> 217</span>  </div> |
| <div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keyword">template</span><<span class="keyword">typename</span> SerDe = serde<T>></div> |
| <div class="line"><a name="l00227"></a><span class="lineno"><a class="line" href="classdatasketches_1_1var__opt__sketch.html#ab0856fc62bc5f6b154feae4a09e7d422"> 227</a></span>  <span class="keyword">static</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch</a> <a class="code" href="classdatasketches_1_1var__opt__sketch.html#ab0856fc62bc5f6b154feae4a09e7d422">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="l00228"></a><span class="lineno"> 228</span>  </div> |
| <div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  string<A> <a class="code" href="classdatasketches_1_1var__opt__sketch.html#aed372241c10ffd041bee85602edb199a">to_string</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  </div> |
| <div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  string<A> <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a0fa52dd153f1e3cac57d4742e2fef6fc">items_to_string</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  </div> |
| <div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  <span class="keyword">class </span>const_iterator;</div> |
| <div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  </div> |
| <div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  const_iterator <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a0faac62cb9f27b09afc849def518f5cc">begin</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  </div> |
| <div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  const_iterator <a class="code" href="classdatasketches_1_1var__opt__sketch.html#ae9e1e5356b5d10a177fa50f7bdfdfd96">end</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  </div> |
| <div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> std::allocator_traits<A>::template rebind_alloc<double> AllocDouble;</div> |
| <div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> std::allocator_traits<A>::template rebind_alloc<bool> AllocBool;</div> |
| <div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  </div> |
| <div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint32_t MIN_LG_ARR_ITEMS = 3;</div> |
| <div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  </div> |
| <div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t PREAMBLE_LONGS_EMPTY = 1;</div> |
| <div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t PREAMBLE_LONGS_WARMUP = 3;</div> |
| <div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t PREAMBLE_LONGS_FULL = 4;</div> |
| <div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t SER_VER = 2;</div> |
| <div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FAMILY_ID = 13;</div> |
| <div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t EMPTY_FLAG_MASK = 4;</div> |
| <div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t GADGET_FLAG_MASK = 128;</div> |
| <div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  </div> |
| <div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  <span class="comment">// Number of standard deviations to use for subset sum error bounds</span></div> |
| <div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  constexpr <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">double</span> DEFAULT_KAPPA = 2.0;</div> |
| <div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  </div> |
| <div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  <span class="comment">// TODO: should probably rearrange a bit to minimize gaps once aligned</span></div> |
| <div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  uint32_t k_; <span class="comment">// max size of sketch, in items</span></div> |
| <div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  </div> |
| <div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  uint32_t h_; <span class="comment">// number of items in heap</span></div> |
| <div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  uint32_t m_; <span class="comment">// number of items in middle region</span></div> |
| <div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  uint32_t r_; <span class="comment">// number of items in reservoir-like region</span></div> |
| <div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  </div> |
| <div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  uint64_t n_; <span class="comment">// total number of items processed by sketch</span></div> |
| <div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  <span class="keywordtype">double</span> total_wt_r_; <span class="comment">// total weight of items in reservoir-like area</span></div> |
| <div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  </div> |
| <div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  resize_factor rf_; <span class="comment">// resize factor</span></div> |
| <div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  </div> |
| <div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  uint32_t curr_items_alloc_; <span class="comment">// currently allocated array size</span></div> |
| <div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  <span class="keywordtype">bool</span> filled_data_; <span class="comment">// true if we've explicitly set all entries in data_</span></div> |
| <div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  </div> |
| <div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  A allocator_;</div> |
| <div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  T* data_; <span class="comment">// stored sampled items</span></div> |
| <div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  <span class="keywordtype">double</span>* weights_; <span class="comment">// weights for sampled items</span></div> |
| <div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  </div> |
| <div class="line"><a name="l00298"></a><span class="lineno"> 298</span>  <span class="comment">// The next two fields are hidden from the user because they are part of the state of the</span></div> |
| <div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  <span class="comment">// unioning algorithm, NOT part of a varopt sketch, or even of a varopt "gadget" (our name for</span></div> |
| <div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  <span class="comment">// the potentially invalid sketch that is maintained by the unioning algorithm). It would make</span></div> |
| <div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  <span class="comment">// more sense logically for these fields to be declared in the unioning object (whose entire</span></div> |
| <div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  <span class="comment">// purpose is storing the state of the unioning algorithm) but for reasons of programming</span></div> |
| <div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  <span class="comment">// convenience we are currently declaring them here. However, that could change in the future.</span></div> |
| <div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  </div> |
| <div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  <span class="comment">// Following int is:</span></div> |
| <div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  <span class="comment">// 1. Zero (for a varopt sketch)</span></div> |
| <div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  <span class="comment">// 2. Count of marked items in H region, if part of a unioning algo's gadget</span></div> |
| <div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  uint32_t num_marks_in_h_;</div> |
| <div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  </div> |
| <div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  <span class="comment">// The following array is absent in a varopt sketch, and notionally present in a gadget</span></div> |
| <div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  <span class="comment">// (although it really belongs in the unioning object). If the array were to be made explicit,</span></div> |
| <div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  <span class="comment">// some additional coding would need to be done to ensure that all of the necessary data motion</span></div> |
| <div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  <span class="comment">// occurs and is properly tracked.</span></div> |
| <div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  <span class="keywordtype">bool</span>* marks_;</div> |
| <div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  </div> |
| <div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  <span class="comment">// used during deserialization to avoid memory leaks upon errors</span></div> |
| <div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  <span class="keyword">class </span>items_deleter;</div> |
| <div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  <span class="keyword">class </span>weights_deleter;</div> |
| <div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <span class="keyword">class </span>marks_deleter;</div> |
| <div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  </div> |
| <div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a6df9f2226b7197a0f612ee4aec0233e7">var_opt_sketch</a>(uint32_t k, resize_factor rf, <span class="keywordtype">bool</span> is_gadget, <span class="keyword">const</span> A& allocator);</div> |
| <div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a6df9f2226b7197a0f612ee4aec0233e7">var_opt_sketch</a>(uint32_t k, uint32_t h, uint32_t m, uint32_t r, uint64_t n, <span class="keywordtype">double</span> total_wt_r, resize_factor rf,</div> |
| <div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  uint32_t curr_items_alloc, <span class="keywordtype">bool</span> filled_data, std::unique_ptr<T, items_deleter> items,</div> |
| <div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  std::unique_ptr<double, weights_deleter> weights, uint32_t num_marks_in_h,</div> |
| <div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  std::unique_ptr<bool, marks_deleter> marks, <span class="keyword">const</span> A& allocator);</div> |
| <div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  </div> |
| <div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a><T, A>;</div> |
| <div class="line"><a name="l00328"></a><span class="lineno"> 328</span>  <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a6df9f2226b7197a0f612ee4aec0233e7">var_opt_sketch</a>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch</a>& other, <span class="keywordtype">bool</span> as_sketch, uint64_t adjusted_n);</div> |
| <div class="line"><a name="l00329"></a><span class="lineno"> 329</span>  </div> |
| <div class="line"><a name="l00330"></a><span class="lineno"> 330</span>  string<A> <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a0fa52dd153f1e3cac57d4742e2fef6fc">items_to_string</a>(<span class="keywordtype">bool</span> print_gap) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00331"></a><span class="lineno"> 331</span>  </div> |
| <div class="line"><a name="l00332"></a><span class="lineno"> 332</span>  <span class="comment">// internal-use-only update</span></div> |
| <div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  <span class="keyword">template</span><<span class="keyword">typename</span> O></div> |
| <div class="line"><a name="l00334"></a><span class="lineno"> 334</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html#a1125ed18baf3f257b5796321c7ec0f8f">update</a>(O&& item, <span class="keywordtype">double</span> weight, <span class="keywordtype">bool</span> mark);</div> |
| <div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  </div> |
| <div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  <span class="keyword">template</span><<span class="keyword">typename</span> O></div> |
| <div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> update_warmup_phase(O&& item, <span class="keywordtype">double</span> weight, <span class="keywordtype">bool</span> mark);</div> |
| <div class="line"><a name="l00338"></a><span class="lineno"> 338</span>  </div> |
| <div class="line"><a name="l00339"></a><span class="lineno"> 339</span>  <span class="keyword">template</span><<span class="keyword">typename</span> O></div> |
| <div class="line"><a name="l00340"></a><span class="lineno"> 340</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> update_light(O&& item, <span class="keywordtype">double</span> weight, <span class="keywordtype">bool</span> mark);</div> |
| <div class="line"><a name="l00341"></a><span class="lineno"> 341</span>  </div> |
| <div class="line"><a name="l00342"></a><span class="lineno"> 342</span>  <span class="keyword">template</span><<span class="keyword">typename</span> O></div> |
| <div class="line"><a name="l00343"></a><span class="lineno"> 343</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> update_heavy_r_eq1(O&& item, <span class="keywordtype">double</span> weight, <span class="keywordtype">bool</span> mark);</div> |
| <div class="line"><a name="l00344"></a><span class="lineno"> 344</span>  </div> |
| <div class="line"><a name="l00345"></a><span class="lineno"> 345</span>  <span class="keyword">template</span><<span class="keyword">typename</span> O></div> |
| <div class="line"><a name="l00346"></a><span class="lineno"> 346</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> update_heavy_general(O&& item, <span class="keywordtype">double</span> weight, <span class="keywordtype">bool</span> mark);</div> |
| <div class="line"><a name="l00347"></a><span class="lineno"> 347</span>  </div> |
| <div class="line"><a name="l00348"></a><span class="lineno"> 348</span>  <span class="keyword">inline</span> <span class="keywordtype">double</span> get_tau() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00349"></a><span class="lineno"> 349</span>  <span class="keyword">inline</span> <span class="keywordtype">double</span> peek_min() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00350"></a><span class="lineno"> 350</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> is_marked(uint32_t idx) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00351"></a><span class="lineno"> 351</span>  </div> |
| <div class="line"><a name="l00352"></a><span class="lineno"> 352</span>  <span class="keyword">inline</span> uint32_t pick_random_slot_in_r() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  <span class="keyword">inline</span> uint32_t choose_delete_slot(<span class="keywordtype">double</span> wt_cand, uint32_t num_cand) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00354"></a><span class="lineno"> 354</span>  <span class="keyword">inline</span> uint32_t choose_weighted_delete_slot(<span class="keywordtype">double</span> wt_cand, uint32_t num_cand) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  </div> |
| <div class="line"><a name="l00356"></a><span class="lineno"> 356</span>  <span class="keyword">template</span><<span class="keyword">typename</span> O></div> |
| <div class="line"><a name="l00357"></a><span class="lineno"> 357</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> push(O&& item, <span class="keywordtype">double</span> wt, <span class="keywordtype">bool</span> mark);</div> |
| <div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> transition_from_warmup();</div> |
| <div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> convert_to_heap();</div> |
| <div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> restore_towards_leaves(uint32_t slot_in);</div> |
| <div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> restore_towards_root(uint32_t slot_in);</div> |
| <div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> pop_min_to_m_region();</div> |
| <div class="line"><a name="l00363"></a><span class="lineno"> 363</span>  <span class="keywordtype">void</span> grow_candidate_set(<span class="keywordtype">double</span> wt_cands, uint32_t num_cands); </div> |
| <div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  <span class="keywordtype">void</span> decrease_k_by_1();</div> |
| <div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  <span class="keywordtype">void</span> strip_marks();</div> |
| <div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  <span class="keywordtype">void</span> force_set_k(uint32_t k); <span class="comment">// used to resolve union gadget into sketch</span></div> |
| <div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  <span class="keywordtype">void</span> downsample_candidate_set(<span class="keywordtype">double</span> wt_cands, uint32_t num_cands);</div> |
| <div class="line"><a name="l00368"></a><span class="lineno"> 368</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> swap_values(uint32_t src, uint32_t dst);</div> |
| <div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  <span class="keywordtype">void</span> grow_data_arrays();</div> |
| <div class="line"><a name="l00370"></a><span class="lineno"> 370</span>  <span class="keywordtype">void</span> allocate_data_arrays(uint32_t tgt_size, <span class="keywordtype">bool</span> use_marks);</div> |
| <div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  </div> |
| <div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  <span class="comment">// validation</span></div> |
| <div class="line"><a name="l00373"></a><span class="lineno"> 373</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="l00374"></a><span class="lineno"> 374</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="l00375"></a><span class="lineno"> 375</span>  <span class="keyword">static</span> uint32_t validate_and_get_target_size(uint32_t preamble_longs, uint32_t k, uint64_t n,</div> |
| <div class="line"><a name="l00376"></a><span class="lineno"> 376</span>  uint32_t h, uint32_t r, resize_factor rf);</div> |
| <div class="line"><a name="l00377"></a><span class="lineno"> 377</span>  </div> |
| <div class="line"><a name="l00378"></a><span class="lineno"> 378</span>  <span class="comment">// things to move to common and be shared among sketches</span></div> |
| <div class="line"><a name="l00379"></a><span class="lineno"> 379</span>  <span class="keyword">static</span> uint32_t get_adjusted_size(uint32_t max_size, uint32_t resize_target);</div> |
| <div class="line"><a name="l00380"></a><span class="lineno"> 380</span>  <span class="keyword">static</span> uint32_t starting_sub_multiple(uint32_t lg_target, uint32_t lg_rf, uint32_t lg_min);</div> |
| <div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">double</span> pseudo_hypergeometric_ub_on_p(uint64_t n, uint32_t k, <span class="keywordtype">double</span> sampling_rate);</div> |
| <div class="line"><a name="l00382"></a><span class="lineno"> 382</span>  <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">double</span> pseudo_hypergeometric_lb_on_p(uint64_t n, uint32_t k, <span class="keywordtype">double</span> sampling_rate);</div> |
| <div class="line"><a name="l00383"></a><span class="lineno"> 383</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> is_power_of_2(uint32_t v);</div> |
| <div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  <span class="keyword">static</span> uint32_t to_log_2(uint32_t v);</div> |
| <div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  <span class="keyword">static</span> <span class="keyword">inline</span> uint32_t next_int(uint32_t max_value);</div> |
| <div class="line"><a name="l00386"></a><span class="lineno"> 386</span>  <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">double</span> next_double_exclude_zero();</div> |
| <div class="line"><a name="l00387"></a><span class="lineno"> 387</span>  </div> |
| <div class="line"><a name="l00388"></a><span class="lineno"> 388</span>  <span class="keyword">class </span>iterator;</div> |
| <div class="line"><a name="l00389"></a><span class="lineno"> 389</span> };</div> |
| <div class="line"><a name="l00390"></a><span class="lineno"> 390</span>  </div> |
| <div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="keyword">template</span><<span class="keyword">typename</span> T, <span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch</a><T, A>::const_iterator {</div> |
| <div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00394"></a><span class="lineno"> 394</span>  <span class="keyword">using</span> iterator_category = std::input_iterator_tag;</div> |
| <div class="line"><a name="l00395"></a><span class="lineno"> 395</span>  <span class="keyword">using</span> value_type = std::pair<const T&, const double>;</div> |
| <div class="line"><a name="l00396"></a><span class="lineno"> 396</span>  <span class="keyword">using</span> difference_type = void;</div> |
| <div class="line"><a name="l00397"></a><span class="lineno"> 397</span>  <span class="keyword">using</span> pointer = <span class="keyword">const</span> return_value_holder<value_type>;</div> |
| <div class="line"><a name="l00398"></a><span class="lineno"> 398</span>  <span class="keyword">using</span> reference = <span class="keyword">const</span> value_type;</div> |
| <div class="line"><a name="l00399"></a><span class="lineno"> 399</span>  </div> |
| <div class="line"><a name="l00400"></a><span class="lineno"> 400</span>  const_iterator(<span class="keyword">const</span> const_iterator& other);</div> |
| <div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  const_iterator& operator++();</div> |
| <div class="line"><a name="l00402"></a><span class="lineno"> 402</span>  const_iterator& operator++(<span class="keywordtype">int</span>);</div> |
| <div class="line"><a name="l00403"></a><span class="lineno"> 403</span>  <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> const_iterator& other) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00404"></a><span class="lineno"> 404</span>  <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> const_iterator& other) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00405"></a><span class="lineno"> 405</span>  reference operator*() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00406"></a><span class="lineno"> 406</span>  pointer operator->() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00407"></a><span class="lineno"> 407</span>  </div> |
| <div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00409"></a><span class="lineno"> 409</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch</a><T, A>;</div> |
| <div class="line"><a name="l00410"></a><span class="lineno"> 410</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1var__opt__union.html">var_opt_union</a><T, A>;</div> |
| <div class="line"><a name="l00411"></a><span class="lineno"> 411</span>  </div> |
| <div class="line"><a name="l00412"></a><span class="lineno"> 412</span>  <span class="comment">// default iterator over full sketch</span></div> |
| <div class="line"><a name="l00413"></a><span class="lineno"> 413</span>  const_iterator(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a>& sk, <span class="keywordtype">bool</span> is_end);</div> |
| <div class="line"><a name="l00414"></a><span class="lineno"> 414</span>  </div> |
| <div class="line"><a name="l00415"></a><span class="lineno"> 415</span>  <span class="comment">// iterates over only one of the H or R regions</span></div> |
| <div class="line"><a name="l00416"></a><span class="lineno"> 416</span>  <span class="comment">// does not apply weight correction</span></div> |
| <div class="line"><a name="l00417"></a><span class="lineno"> 417</span>  const_iterator(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1var__opt__sketch.html">var_opt_sketch<T, A></a>& sk, <span class="keywordtype">bool</span> is_end, <span class="keywordtype">bool</span> use_r_region);</div> |
| <div class="line"><a name="l00418"></a><span class="lineno"> 418</span>  </div> |
| <div class="line"><a name="l00419"></a><span class="lineno"> 419</span>  <span class="keywordtype">bool</span> get_mark() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00420"></a><span class="lineno"> 420</span>  </div> |
| <div class="line"><a name="l00421"></a><span class="lineno"> 421</span>  <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="l00422"></a><span class="lineno"> 422</span>  <span class="keywordtype">double</span> cum_r_weight_; <span class="comment">// used for weight correction</span></div> |
| <div class="line"><a name="l00423"></a><span class="lineno"> 423</span>  <span class="keywordtype">double</span> r_item_wt_;</div> |
| <div class="line"><a name="l00424"></a><span class="lineno"> 424</span>  <span class="keywordtype">size_t</span> idx_;</div> |
| <div class="line"><a name="l00425"></a><span class="lineno"> 425</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> final_idx_;</div> |
| <div class="line"><a name="l00426"></a><span class="lineno"> 426</span> };</div> |
| <div class="line"><a name="l00427"></a><span class="lineno"> 427</span>  </div> |
| <div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment">// non-const iterator for internal use</span></div> |
| <div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="keyword">template</span><<span class="keyword">typename</span> T, <span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="keyword">class </span>var_opt_sketch<T, A>::iterator {</div> |
| <div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00432"></a><span class="lineno"> 432</span>  <span class="keyword">using</span> iterator_category = std::input_iterator_tag;</div> |
| <div class="line"><a name="l00433"></a><span class="lineno"> 433</span>  <span class="keyword">using</span> value_type = std::pair<T&, double>;</div> |
| <div class="line"><a name="l00434"></a><span class="lineno"> 434</span>  <span class="keyword">using</span> difference_type = void;</div> |
| <div class="line"><a name="l00435"></a><span class="lineno"> 435</span>  <span class="keyword">using</span> pointer = return_value_holder<value_type>;</div> |
| <div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  <span class="keyword">using</span> reference = value_type;</div> |
| <div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  </div> |
| <div class="line"><a name="l00438"></a><span class="lineno"> 438</span>  iterator(<span class="keyword">const</span> iterator& other);</div> |
| <div class="line"><a name="l00439"></a><span class="lineno"> 439</span>  iterator& operator++();</div> |
| <div class="line"><a name="l00440"></a><span class="lineno"> 440</span>  iterator& operator++(<span class="keywordtype">int</span>);</div> |
| <div class="line"><a name="l00441"></a><span class="lineno"> 441</span>  <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> iterator& other) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> iterator& other) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00443"></a><span class="lineno"> 443</span>  reference operator*();</div> |
| <div class="line"><a name="l00444"></a><span class="lineno"> 444</span>  pointer operator->();</div> |
| <div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  </div> |
| <div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1var__opt__sketch.html#a6df9f2226b7197a0f612ee4aec0233e7">var_opt_sketch</a><T, A>;</div> |
| <div class="line"><a name="l00448"></a><span class="lineno"> 448</span>  <span class="keyword">friend</span> <span class="keyword">class </span>var_opt_union<T, A>;</div> |
| <div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  </div> |
| <div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  <span class="comment">// iterates over only one of the H or R region, applying weight correction</span></div> |
| <div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  <span class="comment">// if iterating over R region (can correct for numerical precision issues)</span></div> |
| <div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  iterator(<span class="keyword">const</span> var_opt_sketch<T, A>& sk, <span class="keywordtype">bool</span> is_end, <span class="keywordtype">bool</span> use_r_region);</div> |
| <div class="line"><a name="l00453"></a><span class="lineno"> 453</span>  </div> |
| <div class="line"><a name="l00454"></a><span class="lineno"> 454</span>  <span class="keywordtype">bool</span> get_mark() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00455"></a><span class="lineno"> 455</span>  </div> |
| <div class="line"><a name="l00456"></a><span class="lineno"> 456</span>  <span class="keyword">const</span> var_opt_sketch<T, A>* sk_;</div> |
| <div class="line"><a name="l00457"></a><span class="lineno"> 457</span>  <span class="keywordtype">double</span> cum_r_weight_; <span class="comment">// used for weight correction</span></div> |
| <div class="line"><a name="l00458"></a><span class="lineno"> 458</span>  <span class="keywordtype">double</span> r_item_wt_;</div> |
| <div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  <span class="keywordtype">size_t</span> idx_;</div> |
| <div class="line"><a name="l00460"></a><span class="lineno"> 460</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> final_idx_;</div> |
| <div class="line"><a name="l00461"></a><span class="lineno"> 461</span> };</div> |
| <div class="line"><a name="l00462"></a><span class="lineno"> 462</span>  </div> |
| <div class="line"><a name="l00463"></a><span class="lineno"> 463</span>  </div> |
| <div class="line"><a name="l00464"></a><span class="lineno"> 464</span> } <span class="comment">// namespace datasketches</span></div> |
| <div class="line"><a name="l00465"></a><span class="lineno"> 465</span>  </div> |
| <div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="preprocessor">#include "var_opt_sketch_impl.hpp"</span></div> |
| <div class="line"><a name="l00467"></a><span class="lineno"> 467</span>  </div> |
| <div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="preprocessor">#endif </span><span class="comment">// _VAR_OPT_SKETCH_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</a></div><div class="ttdoc">This sketch samples data from a stream of items.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch.hpp:67</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_a0fa52dd153f1e3cac57d4742e2fef6fc"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#a0fa52dd153f1e3cac57d4742e2fef6fc">datasketches::var_opt_sketch::items_to_string</a></div><div class="ttdeci">string< A > items_to_string() const</div><div class="ttdoc">Prints the raw sketch items to a string.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:735</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_a0faac62cb9f27b09afc849def518f5cc"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#a0faac62cb9f27b09afc849def518f5cc">datasketches::var_opt_sketch::begin</a></div><div class="ttdeci">const_iterator begin() const</div><div class="ttdoc">Iterator pointing to the first item in the sketch.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:1486</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_a1125ed18baf3f257b5796321c7ec0f8f"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#a1125ed18baf3f257b5796321c7ec0f8f">datasketches::var_opt_sketch::update</a></div><div class="ttdeci">void update(const T &item, double weight=1.0)</div><div class="ttdoc">Updates this sketch with the given data item with the given weight.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:709</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_a1d0c269c23926e93b1c7a9c00e86af97"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#a1d0c269c23926e93b1c7a9c00e86af97">datasketches::var_opt_sketch::serialize</a></div><div class="ttdeci">vector_bytes serialize(unsigned header_size_bytes=0, const SerDe &sd=SerDe()) const</div><div class="ttdoc">This method serializes the sketch as a vector of bytes.</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_a247dd627502e887562ae763adfe863ff"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#a247dd627502e887562ae763adfe863ff">datasketches::var_opt_sketch::operator=</a></div><div class="ttdeci">var_opt_sketch & operator=(const var_opt_sketch &other)</div><div class="ttdoc">Copy assignment.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:217</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_a5a2b7a58dc85678d08752945ff655362"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#a5a2b7a58dc85678d08752945ff655362">datasketches::var_opt_sketch::is_empty</a></div><div class="ttdeci">bool is_empty() const</div><div class="ttdoc">Returns true if the sketch is empty.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:643</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_a6df9f2226b7197a0f612ee4aec0233e7"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#a6df9f2226b7197a0f612ee4aec0233e7">datasketches::var_opt_sketch::var_opt_sketch</a></div><div class="ttdeci">var_opt_sketch(uint32_t k, resize_factor rf=var_opt_constants::DEFAULT_RESIZE_FACTOR, const A &allocator=A())</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:46</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_a71f1302dd93f895508f65893f96796fa"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#a71f1302dd93f895508f65893f96796fa">datasketches::var_opt_sketch::estimate_subset_sum</a></div><div class="ttdeci">subset_summary estimate_subset_sum(P predicate) const</div><div class="ttdoc">Computes an estimated subset sum from the entire stream for objects matching a given predicate.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:1381</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_ab0856fc62bc5f6b154feae4a09e7d422"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#ab0856fc62bc5f6b154feae4a09e7d422">datasketches::var_opt_sketch::deserialize</a></div><div class="ttdeci">static var_opt_sketch deserialize(const void *bytes, size_t size, const SerDe &sd=SerDe(), const A &allocator=A())</div><div class="ttdoc">This method deserializes a sketch from a given array of bytes.</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_ac481918ec96d79b27813d32bcc2a247d"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#ac481918ec96d79b27813d32bcc2a247d">datasketches::var_opt_sketch::get_num_samples</a></div><div class="ttdeci">uint32_t get_num_samples() const</div><div class="ttdoc">Returns the number of samples currently in the sketch.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:703</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_ad20897c5c8bd47f5d4005989bead0e55"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#ad20897c5c8bd47f5d4005989bead0e55">datasketches::var_opt_sketch::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Resets the sketch to its default, empty state.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:648</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_ad9a5259d93d148b5c2050d68e7788716"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#ad9a5259d93d148b5c2050d68e7788716">datasketches::var_opt_sketch::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 sketch.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:297</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_ae9e1e5356b5d10a177fa50f7bdfdfd96"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#ae9e1e5356b5d10a177fa50f7bdfdfd96">datasketches::var_opt_sketch::end</a></div><div class="ttdeci">const_iterator end() const</div><div class="ttdoc">Iterator pointing to the past-the-end item in the sketch.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:1491</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_aea8f1c4a6d0189de0db5b5cd085c39b1"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#aea8f1c4a6d0189de0db5b5cd085c39b1">datasketches::var_opt_sketch::deserialize</a></div><div class="ttdeci">static var_opt_sketch deserialize(std::istream &is, const SerDe &sd=SerDe(), const A &allocator=A())</div><div class="ttdoc">This method deserializes a sketch from a given stream.</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_aed372241c10ffd041bee85602edb199a"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#aed372241c10ffd041bee85602edb199a">datasketches::var_opt_sketch::to_string</a></div><div class="ttdeci">string< A > to_string() const</div><div class="ttdoc">Prints a summary of the sketch.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:719</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_af561f5cd76ff61773713c627bc53b0a2"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#af561f5cd76ff61773713c627bc53b0a2">datasketches::var_opt_sketch::get_k</a></div><div class="ttdeci">uint32_t get_k() const</div><div class="ttdoc">Returns the configured maximum sample size.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:698</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1var__opt__sketch_html_af857be9469a7565252626f27e1f9d74d"><div class="ttname"><a href="classdatasketches_1_1var__opt__sketch.html#af857be9469a7565252626f27e1f9d74d">datasketches::var_opt_sketch::get_n</a></div><div class="ttdeci">uint64_t get_n() const</div><div class="ttdoc">Returns the length of the input stream.</div><div class="ttdef"><b>Definition:</b> var_opt_sketch_impl.hpp:693</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="anamespacedatasketches_1_1var__opt__constants_html_a02799eee5e87428b1c72e6c4c282d68e"><div class="ttname"><a href="namespacedatasketches_1_1var__opt__constants.html#a02799eee5e87428b1c72e6c4c282d68e">datasketches::var_opt_constants::DEFAULT_RESIZE_FACTOR</a></div><div class="ttdeci">const resize_factor DEFAULT_RESIZE_FACTOR</div><div class="ttdoc">default resize factor</div><div class="ttdef"><b>Definition:</b> var_opt_sketch.hpp:49</div></div> |
| <div class="ttc" id="anamespacedatasketches_1_1var__opt__constants_html_aef0073265694689f2a7281205c133523"><div class="ttname"><a href="namespacedatasketches_1_1var__opt__constants.html#aef0073265694689f2a7281205c133523">datasketches::var_opt_constants::MAX_K</a></div><div class="ttdeci">const uint32_t MAX_K</div><div class="ttdoc">maximum value of parameter K</div><div class="ttdef"><b>Definition:</b> var_opt_sketch.hpp:51</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> |