blob: 18c921fbbb3339fdfa6e47a2e7922c213f09e877 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>datasketches-cpp: sampling/include/ebpps_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 id="projectrow">
<td id="projectalign">
<div id="projectname">datasketches-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_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">ebpps_sketch.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef _EBPPS_SKETCH_HPP_</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define _EBPPS_SKETCH_HPP_</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &quot;common_defs.hpp&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &quot;ebpps_sample.hpp&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &quot;optional.hpp&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include &quot;serde.hpp&quot;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;random&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacedatasketches.html">datasketches</a> {</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="foldopen" id="foldopen00035" data-start="{" data-end="}">
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1ebpps__constants.html"> 35</a></span><span class="keyword">namespace </span>ebpps_constants {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1ebpps__constants.html#aef0073265694689f2a7281205c133523"> 37</a></span> <span class="keyword">const</span> uint32_t <a class="code hl_variable" href="namespacedatasketches_1_1ebpps__constants.html#aef0073265694689f2a7281205c133523">MAX_K</a> = ((uint32_t) 1 &lt;&lt; 31) - 2;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>}</div>
</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="keyword">template</span>&lt;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">typename</span> T,</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">typename</span> A = std::allocator&lt;T&gt;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span>&gt;</div>
<div class="foldopen" id="foldopen00059" data-start="{" data-end="};">
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classdatasketches_1_1ebpps__sketch.html"> 59</a></span><span class="keyword">class </span><a class="code hl_class" href="classdatasketches_1_1ebpps__sketch.html">ebpps_sketch</a> {</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t MAX_K = <a class="code hl_variable" href="namespacedatasketches_1_1ebpps__constants.html#aef0073265694689f2a7281205c133523">ebpps_constants::MAX_K</a>;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classdatasketches_1_1ebpps__sketch.html">ebpps_sketch</a>(uint32_t k, <span class="keyword">const</span> A&amp; allocator = A());</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#a1125ed18baf3f257b5796321c7ec0f8f">update</a>(<span class="keyword">const</span> T&amp; item, <span class="keywordtype">double</span> weight = 1.0);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#a1125ed18baf3f257b5796321c7ec0f8f">update</a>(T&amp;&amp; item, <span class="keywordtype">double</span> weight = 1.0);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#aa3e3042bdaf5a90eb65767f1a392125a">merge</a>(<span class="keyword">const</span> <a class="code hl_class" href="classdatasketches_1_1ebpps__sketch.html">ebpps_sketch&lt;T, A&gt;</a>&amp; sketch);</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#aa3e3042bdaf5a90eb65767f1a392125a">merge</a>(<a class="code hl_class" href="classdatasketches_1_1ebpps__sketch.html">ebpps_sketch&lt;T, A&gt;</a>&amp;&amp; sketch);</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keyword">using </span>result_type = <span class="keyword">typename</span> ebpps_sample&lt;T,A&gt;::result_type;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> result_type <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#af55091df8eaaa2a9dc834f1e1d5340e7">get_result</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="keyword">inline</span> uint32_t <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#af561f5cd76ff61773713c627bc53b0a2">get_k</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="keyword">inline</span> uint64_t <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#af857be9469a7565252626f27e1f9d74d">get_n</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <span class="keyword">inline</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#a8c7e54338adc46e68f7c53676bcecde8">get_cumulative_weight</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="keyword">inline</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#ad9a95d52fa46cfa85b026802397b2154">get_c</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#a5a2b7a58dc85678d08752945ff655362">is_empty</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> A <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#a9d85cf47c4ecd0580ec623c42006dd1b">get_allocator</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a>();</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> </div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SerDe = serde&lt;T&gt;&gt;</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#a8762fed25b3024f07989976344dd0afb">get_serialized_size_bytes</a>(<span class="keyword">const</span> SerDe&amp; sd = SerDe()) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> </div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> <span class="comment">// This is a convenience alias for users</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> <span class="comment">// The type returned by the following serialize method</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> <span class="keyword">using </span>vector_bytes = std::vector&lt;uint8_t, typename std::allocator_traits&lt;A&gt;::template rebind_alloc&lt;uint8_t&gt;&gt;;</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> </div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SerDe = serde&lt;T&gt;&gt;</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"><a class="line" href="classdatasketches_1_1ebpps__sketch.html#a1d0c269c23926e93b1c7a9c00e86af97"> 179</a></span> vector_bytes <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#a1d0c269c23926e93b1c7a9c00e86af97">serialize</a>(<span class="keywordtype">unsigned</span> header_size_bytes = 0, <span class="keyword">const</span> SerDe&amp; sd = SerDe()) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SerDe = serde&lt;T&gt;&gt;</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#a1d0c269c23926e93b1c7a9c00e86af97">serialize</a>(std::ostream&amp; os, <span class="keyword">const</span> SerDe&amp; sd = SerDe()) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> </div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SerDe = serde&lt;T&gt;&gt;</div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"><a class="line" href="classdatasketches_1_1ebpps__sketch.html#ab70ba7338cb96e92d62399fbc1b774e6"> 198</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classdatasketches_1_1ebpps__sketch.html">ebpps_sketch</a> <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#ab70ba7338cb96e92d62399fbc1b774e6">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&amp; sd = SerDe(), <span class="keyword">const</span> A&amp; allocator = A());</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> </div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SerDe = serde&lt;T&gt;&gt;</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"><a class="line" href="classdatasketches_1_1ebpps__sketch.html#ada2a7bf12915615ea1d15ccfdcc525d2"> 208</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classdatasketches_1_1ebpps__sketch.html">ebpps_sketch</a> <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#ada2a7bf12915615ea1d15ccfdcc525d2">deserialize</a>(std::istream&amp; is, <span class="keyword">const</span> SerDe&amp; sd = SerDe(), <span class="keyword">const</span> A&amp; allocator = A());</div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> </div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> string&lt;A&gt; <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#aed372241c10ffd041bee85602edb199a">to_string</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> </div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> string&lt;A&gt; <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#a0fa52dd153f1e3cac57d4742e2fef6fc">items_to_string</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> </div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> <span class="keyword">typename</span> ebpps_sample&lt;T,A&gt;::const_iterator <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#a7f1f04c52ad57d836463132e260dee2f">begin</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span> </div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span> <span class="keyword">typename</span> ebpps_sample&lt;T,A&gt;::const_iterator <a class="code hl_function" href="classdatasketches_1_1ebpps__sketch.html#a42825c759c3dec7ece362973012123a2">end</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span> </div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno"> 242</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t PREAMBLE_LONGS_EMPTY = 1;</div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t PREAMBLE_LONGS_FULL = 5; <span class="comment">// C is part of sample_</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t SER_VER = 1;</div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"> 245</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FAMILY_ID = 19;</div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t EMPTY_FLAG_MASK = 4;</div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t HAS_PARTIAL_ITEM_MASK = 8;</div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno"> 248</span> </div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span> A allocator_;</div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno"> 250</span> uint32_t k_; <span class="comment">// max size of sketch, in items</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno"> 251</span> uint64_t n_; <span class="comment">// total number of items processed by the sketch</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span> </div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span> <span class="keywordtype">double</span> cumulative_wt_; <span class="comment">// total weight of items processed by the sketch</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span> <span class="keywordtype">double</span> wt_max_; <span class="comment">// maximum weight seen so far</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span> <span class="keywordtype">double</span> rho_; <span class="comment">// latest scaling parameter for downsampling</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span> </div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno"> 257</span> ebpps_sample&lt;T,A&gt; sample_; <span class="comment">// Object holding the current state of the sample</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno"> 258</span> </div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno"> 259</span> ebpps_sample&lt;T,A&gt; tmp_; <span class="comment">// Temporary sample of size 1 used in updates</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno"> 260</span> </div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno"> 261</span> <span class="comment">// handles merge after ensuring other.cumulative_wt_ &lt;= this-&gt;cumulative_wt_</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno"> 262</span> <span class="comment">// so we can send items in individually</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno"> 263</span> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> O&gt;</div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno"> 264</span> <span class="keywordtype">void</span> internal_merge(O&amp;&amp; other);</div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno"> 265</span> </div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span> <a class="code hl_class" href="classdatasketches_1_1ebpps__sketch.html">ebpps_sketch</a>(uint32_t k, uint64_t n, <span class="keywordtype">double</span> cumulative_wt, <span class="keywordtype">double</span> wt_max, <span class="keywordtype">double</span> rho,</div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span> ebpps_sample&lt;T,A&gt;&amp;&amp; sample, <span class="keyword">const</span> A&amp; allocator = A());</div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span> </div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> FwdItem&gt;</div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno"> 270</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> internal_update(FwdItem&amp;&amp; item, <span class="keywordtype">double</span> weight);</div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno"> 271</span> </div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno"> 272</span> <span class="comment">// validation</span></div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno"> 273</span> <span class="keyword">static</span> uint32_t check_k(uint32_t k);</div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno"> 274</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 id="l00275" name="l00275"></a><span class="lineno"> 275</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 id="l00276" name="l00276"></a><span class="lineno"> 276</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 id="l00277" name="l00277"></a><span class="lineno"> 277</span>};</div>
</div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> </div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno"> 279</span>} <span class="comment">// namespace datasketches</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno"> 280</span> </div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno"> 281</span><span class="preprocessor">#include &quot;ebpps_sketch_impl.hpp&quot;</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno"> 282</span> </div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno"> 283</span><span class="preprocessor">#endif </span><span class="comment">// _EBPPS_SKETCH_HPP_</span></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html">datasketches::ebpps_sketch</a></div><div class="ttdoc">An implementation of an Exact and Bounded Sampling Proportional to Size sketch.</div><div class="ttdef"><b>Definition</b> ebpps_sketch.hpp:59</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_a0fa52dd153f1e3cac57d4742e2fef6fc"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#a0fa52dd153f1e3cac57d4742e2fef6fc">datasketches::ebpps_sketch::items_to_string</a></div><div class="ttdeci">string&lt; A &gt; items_to_string() const</div><div class="ttdoc">Prints the raw sketch items to a string.</div><div class="ttdef"><b>Definition</b> ebpps_sketch_impl.hpp:112</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_a1125ed18baf3f257b5796321c7ec0f8f"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#a1125ed18baf3f257b5796321c7ec0f8f">datasketches::ebpps_sketch::update</a></div><div class="ttdeci">void update(const T &amp;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> ebpps_sketch_impl.hpp:127</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_a1d0c269c23926e93b1c7a9c00e86af97"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#a1d0c269c23926e93b1c7a9c00e86af97">datasketches::ebpps_sketch::serialize</a></div><div class="ttdeci">vector_bytes serialize(unsigned header_size_bytes=0, const SerDe &amp;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_1ebpps__sketch_html_a42825c759c3dec7ece362973012123a2"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#a42825c759c3dec7ece362973012123a2">datasketches::ebpps_sketch::end</a></div><div class="ttdeci">ebpps_sample&lt; T, A &gt;::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> ebpps_sketch_impl.hpp:524</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_a5a2b7a58dc85678d08752945ff655362"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#a5a2b7a58dc85678d08752945ff655362">datasketches::ebpps_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> ebpps_sketch_impl.hpp:82</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_a7f1f04c52ad57d836463132e260dee2f"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#a7f1f04c52ad57d836463132e260dee2f">datasketches::ebpps_sketch::begin</a></div><div class="ttdeci">ebpps_sample&lt; T, A &gt;::const_iterator begin() const</div><div class="ttdoc">Iterator pointing to the first item in the sketch.</div><div class="ttdef"><b>Definition</b> ebpps_sketch_impl.hpp:519</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_a8762fed25b3024f07989976344dd0afb"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#a8762fed25b3024f07989976344dd0afb">datasketches::ebpps_sketch::get_serialized_size_bytes</a></div><div class="ttdeci">size_t get_serialized_size_bytes(const SerDe &amp;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> ebpps_sketch_impl.hpp:320</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_a8c7e54338adc46e68f7c53676bcecde8"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#a8c7e54338adc46e68f7c53676bcecde8">datasketches::ebpps_sketch::get_cumulative_weight</a></div><div class="ttdeci">double get_cumulative_weight() const</div><div class="ttdoc">Returns the cumulative weight of items processed by the sketch.</div><div class="ttdef"><b>Definition</b> ebpps_sketch_impl.hpp:77</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_a9d85cf47c4ecd0580ec623c42006dd1b"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#a9d85cf47c4ecd0580ec623c42006dd1b">datasketches::ebpps_sketch::get_allocator</a></div><div class="ttdeci">A get_allocator() const</div><div class="ttdoc">Returns an instance of the allocator for this sketch.</div><div class="ttdef"><b>Definition</b> ebpps_sketch_impl.hpp:122</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_aa3e3042bdaf5a90eb65767f1a392125a"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#aa3e3042bdaf5a90eb65767f1a392125a">datasketches::ebpps_sketch::merge</a></div><div class="ttdeci">void merge(const ebpps_sketch&lt; T, A &gt; &amp;sketch)</div><div class="ttdoc">Merges the provided sketch into the current one.</div><div class="ttdef"><b>Definition</b> ebpps_sketch_impl.hpp:199</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_ab70ba7338cb96e92d62399fbc1b774e6"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#ab70ba7338cb96e92d62399fbc1b774e6">datasketches::ebpps_sketch::deserialize</a></div><div class="ttdeci">static ebpps_sketch deserialize(const void *bytes, size_t size, const SerDe &amp;sd=SerDe(), const A &amp;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_1ebpps__sketch_html_ad20897c5c8bd47f5d4005989bead0e55"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#ad20897c5c8bd47f5d4005989bead0e55">datasketches::ebpps_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> ebpps_sketch_impl.hpp:87</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_ad9a95d52fa46cfa85b026802397b2154"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#ad9a95d52fa46cfa85b026802397b2154">datasketches::ebpps_sketch::get_c</a></div><div class="ttdeci">double get_c() const</div><div class="ttdoc">Returns the expected number of samples returned upon a call to get_result() or the creation of an ite...</div><div class="ttdef"><b>Definition</b> ebpps_sketch_impl.hpp:72</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_ada2a7bf12915615ea1d15ccfdcc525d2"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#ada2a7bf12915615ea1d15ccfdcc525d2">datasketches::ebpps_sketch::deserialize</a></div><div class="ttdeci">static ebpps_sketch deserialize(std::istream &amp;is, const SerDe &amp;sd=SerDe(), const A &amp;allocator=A())</div><div class="ttdoc">This method deserializes a sketch from a given stream.</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_aed372241c10ffd041bee85602edb199a"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#aed372241c10ffd041bee85602edb199a">datasketches::ebpps_sketch::to_string</a></div><div class="ttdeci">string&lt; A &gt; to_string() const</div><div class="ttdoc">Prints a summary of the sketch.</div><div class="ttdef"><b>Definition</b> ebpps_sketch_impl.hpp:96</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_af55091df8eaaa2a9dc834f1e1d5340e7"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#af55091df8eaaa2a9dc834f1e1d5340e7">datasketches::ebpps_sketch::get_result</a></div><div class="ttdeci">result_type get_result() const</div><div class="ttdoc">Returns a copy of the current sample, as a std::vector.</div><div class="ttdef"><b>Definition</b> ebpps_sketch_impl.hpp:163</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_af561f5cd76ff61773713c627bc53b0a2"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#af561f5cd76ff61773713c627bc53b0a2">datasketches::ebpps_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> ebpps_sketch_impl.hpp:62</div></div>
<div class="ttc" id="aclassdatasketches_1_1ebpps__sketch_html_af857be9469a7565252626f27e1f9d74d"><div class="ttname"><a href="classdatasketches_1_1ebpps__sketch.html#af857be9469a7565252626f27e1f9d74d">datasketches::ebpps_sketch::get_n</a></div><div class="ttdeci">uint64_t get_n() const</div><div class="ttdoc">Returns the number of items processed by the sketch, regardless of item weight.</div><div class="ttdef"><b>Definition</b> ebpps_sketch_impl.hpp:67</div></div>
<div class="ttc" id="anamespacedatasketches_1_1ebpps__constants_html_aef0073265694689f2a7281205c133523"><div class="ttname"><a href="namespacedatasketches_1_1ebpps__constants.html#aef0073265694689f2a7281205c133523">datasketches::ebpps_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> ebpps_sketch.hpp:37</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&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>