| <!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: cpc/include/cpc_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_82f3a10095a8f2296c0cf5c491a57b02.html">cpc</a></li><li class="navelem"><a class="el" href="dir_fabb7854c43508dcbf81254d1daad42f.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">cpc_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 CPC_SKETCH_HPP_</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define CPC_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 <iostream></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <functional></span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "u32_table.hpp"</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "cpc_common.hpp"</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "cpc_compressor.hpp"</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "cpc_confidence.hpp"</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "common_defs.hpp"</span></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="keyword">namespace </span><a class="code" href="namespacedatasketches.html">datasketches</a> {</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// forward declarations</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">template</span><<span class="keyword">typename</span> A> <span class="keyword">class </span>cpc_sketch_alloc;</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">template</span><<span class="keyword">typename</span> A> <span class="keyword">class </span>cpc_union_alloc;</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="namespacedatasketches.html#a17c863577957f2cb099dc8be4f222aa6"> 41</a></span> <span class="keyword">using</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch</a> = <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc<std::allocator<uint8_t></a>>;</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">template</span><<span class="keyword">typename</span> A> <span class="keywordtype">void</span> <a class="code" href="namespacedatasketches.html#a3a7ac5efb6156547a8da91e937a06b07">cpc_init</a>();</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classdatasketches_1_1cpc__sketch__alloc.html"> 64</a></span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc</a> {</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">using</span> allocator_type = A;</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">using</span> vector_bytes = std::vector<uint8_t, typename std::allocator_traits<A>::template rebind_alloc<uint8_t>>;</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">using</span> vector_u64 = std::vector<uint64_t, typename std::allocator_traits<A>::template rebind_alloc<uint64_t>>;</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">explicit</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a39d6cd5eff1a9af78f58108ba5297b47">cpc_sketch_alloc</a>(uint8_t lg_k = <a class="code" href="namespacedatasketches_1_1cpc__constants.html#a78468167a70640384c2de5e04fabe4fd">cpc_constants::DEFAULT_LG_K</a>, uint64_t seed = DEFAULT_SEED, <span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  A <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a9d85cf47c4ecd0580ec623c42006dd1b">get_allocator</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  uint8_t <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a8f8b2691781d682411a6de23996a8be2">get_lg_k</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">bool</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a5a2b7a58dc85678d08752945ff655362">is_empty</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">double</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a2afb71f2ef2d82290be4c8eafc08f2a2">get_estimate</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">double</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#ab43d2075a173e631d757b07da971fe3d">get_lower_bound</a>(<span class="keywordtype">unsigned</span> kappa) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">double</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#adbfa99fa21d0f4acb1ba00ced8d8d858">get_upper_bound</a>(<span class="keywordtype">unsigned</span> kappa) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a58c0f2372495a3163616cb0f539395ea">update</a>(<span class="keyword">const</span> std::string& value);</div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a58c0f2372495a3163616cb0f539395ea">update</a>(uint64_t value);</div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  </div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a58c0f2372495a3163616cb0f539395ea">update</a>(int64_t value);</div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  </div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a58c0f2372495a3163616cb0f539395ea">update</a>(uint32_t value);</div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </div> |
| <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a58c0f2372495a3163616cb0f539395ea">update</a>(int32_t value);</div> |
| <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  </div> |
| <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a58c0f2372495a3163616cb0f539395ea">update</a>(uint16_t value);</div> |
| <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  </div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a58c0f2372495a3163616cb0f539395ea">update</a>(int16_t value);</div> |
| <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  </div> |
| <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a58c0f2372495a3163616cb0f539395ea">update</a>(uint8_t value);</div> |
| <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  </div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a58c0f2372495a3163616cb0f539395ea">update</a>(int8_t value);</div> |
| <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  </div> |
| <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a58c0f2372495a3163616cb0f539395ea">update</a>(<span class="keywordtype">double</span> value);</div> |
| <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  </div> |
| <div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a58c0f2372495a3163616cb0f539395ea">update</a>(<span class="keywordtype">float</span> value);</div> |
| <div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  </div> |
| <div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a58c0f2372495a3163616cb0f539395ea">update</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* value, <span class="keywordtype">size_t</span> size);</div> |
| <div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  </div> |
| <div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  string<A> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#aed372241c10ffd041bee85602edb199a">to_string</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  </div> |
| <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a1bcdd98ee6e6eb9b501b8dc5de5e8924">serialize</a>(std::ostream& os) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  </div> |
| <div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  vector_bytes <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a1bcdd98ee6e6eb9b501b8dc5de5e8924">serialize</a>(<span class="keywordtype">unsigned</span> header_size_bytes = 0) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  </div> |
| <div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keyword">static</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc<A></a> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a54ceaffd48627a356af3f72a7cc1d4ae">deserialize</a>(std::istream& is, uint64_t seed = DEFAULT_SEED, <span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  </div> |
| <div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keyword">static</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc<A></a> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a54ceaffd48627a356af3f72a7cc1d4ae">deserialize</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* bytes, <span class="keywordtype">size_t</span> size, uint64_t seed = DEFAULT_SEED, <span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  </div> |
| <div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  <span class="keyword">static</span> <span class="keywordtype">size_t</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a7fcd4a0f58526cadbf7557c5c7f540dc">get_max_serialized_size_bytes</a>(uint8_t lg_k);</div> |
| <div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  </div> |
| <div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  uint32_t get_num_coupons() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  </div> |
| <div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  <span class="comment">// this should catch some forms of corruption during serialization-deserialization</span></div> |
| <div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  <span class="keywordtype">bool</span> validate() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  </div> |
| <div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t SERIAL_VERSION = 1;</div> |
| <div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FAMILY = 16;</div> |
| <div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  </div> |
| <div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keyword">enum</span> flags { IS_BIG_ENDIAN, IS_COMPRESSED, HAS_HIP, HAS_TABLE, HAS_WINDOW };</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="comment">// Note: except for brief transitional moments, these sketches always obey</span></div> |
| <div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="comment">// the following strict mapping between the flavor of a sketch and the</span></div> |
| <div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <span class="comment">// number of coupons that it has collected</span></div> |
| <div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  <span class="keyword">enum</span> flavor {</div> |
| <div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  EMPTY, <span class="comment">// 0 == C < 1</span></div> |
| <div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  SPARSE, <span class="comment">// 1 <= C < 3K/32</span></div> |
| <div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  HYBRID, <span class="comment">// 3K/32 <= C < K/2</span></div> |
| <div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  PINNED, <span class="comment">// K/2 <= C < 27K/8 [NB: 27/8 = 3 + 3/8]</span></div> |
| <div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  SLIDING <span class="comment">// 27K/8 <= C</span></div> |
| <div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  };</div> |
| <div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  </div> |
| <div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  uint8_t lg_k;</div> |
| <div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  uint64_t seed;</div> |
| <div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  <span class="keywordtype">bool</span> was_merged; <span class="comment">// is the sketch the result of merging?</span></div> |
| <div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  uint32_t num_coupons; <span class="comment">// the number of coupons collected so far</span></div> |
| <div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  </div> |
| <div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  u32_table<A> surprising_value_table;</div> |
| <div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  vector_bytes sliding_window;</div> |
| <div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  uint8_t window_offset; <span class="comment">// derivable from num_coupons, but made explicit for speed</span></div> |
| <div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  uint8_t first_interesting_column; <span class="comment">// This is part of a speed optimization</span></div> |
| <div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  </div> |
| <div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  <span class="keywordtype">double</span> kxp;</div> |
| <div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  <span class="keywordtype">double</span> hip_est_accum;</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>  <span class="comment">// for deserialization and cpc_union::get_result()</span></div> |
| <div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html#a39d6cd5eff1a9af78f58108ba5297b47">cpc_sketch_alloc</a>(uint8_t lg_k, uint32_t num_coupons, uint8_t first_interesting_column, u32_table<A>&& table,</div> |
| <div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  vector_bytes&& window, <span class="keywordtype">bool</span> has_hip, <span class="keywordtype">double</span> kxp, <span class="keywordtype">double</span> hip_est_accum, uint64_t seed);</div> |
| <div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  </div> |
| <div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> row_col_update(uint32_t row_col);</div> |
| <div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> update_sparse(uint32_t row_col);</div> |
| <div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> update_windowed(uint32_t row_col);</div> |
| <div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> update_hip(uint32_t row_col);</div> |
| <div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  <span class="keywordtype">void</span> promote_sparse_to_windowed();</div> |
| <div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  <span class="keywordtype">void</span> move_window();</div> |
| <div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  <span class="keywordtype">void</span> refresh_kxp(<span class="keyword">const</span> uint64_t* bit_matrix);</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="keyword">friend</span> <span class="keywordtype">double</span> get_hip_confidence_lb<A>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc<A></a>& sketch, <span class="keywordtype">int</span> kappa);</div> |
| <div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  <span class="keyword">friend</span> <span class="keywordtype">double</span> get_hip_confidence_ub<A>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc<A></a>& sketch, <span class="keywordtype">int</span> kappa);</div> |
| <div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  <span class="keyword">friend</span> <span class="keywordtype">double</span> get_icon_confidence_lb<A>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc<A></a>& sketch, <span class="keywordtype">int</span> kappa);</div> |
| <div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  <span class="keyword">friend</span> <span class="keywordtype">double</span> get_icon_confidence_ub<A>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc<A></a>& sketch, <span class="keywordtype">int</span> kappa);</div> |
| <div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  <span class="keywordtype">double</span> get_hip_estimate() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  <span class="keywordtype">double</span> get_icon_estimate() <span class="keyword">const</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="keyword">inline</span> flavor determine_flavor() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  <span class="keyword">static</span> <span class="keyword">inline</span> flavor determine_flavor(uint8_t lg_k, uint64_t c);</div> |
| <div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  </div> |
| <div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <span class="keyword">static</span> <span class="keyword">inline</span> uint8_t determine_correct_offset(uint8_t lg_k, uint64_t c);</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">// this produces a full-size k-by-64 bit matrix</span></div> |
| <div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  vector_u64 build_bit_matrix() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  </div> |
| <div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  <span class="keyword">static</span> uint8_t get_preamble_ints(uint32_t num_coupons, <span class="keywordtype">bool</span> has_hip, <span class="keywordtype">bool</span> has_table, <span class="keywordtype">bool</span> has_window);</div> |
| <div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> write_hip(std::ostream& os) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> copy_hip_to_mem(<span class="keywordtype">void</span>* dst) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  </div> |
| <div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_lg_k(uint8_t lg_k);</div> |
| <div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  </div> |
| <div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <span class="keyword">friend</span> cpc_compressor<A>;</div> |
| <div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  <span class="keyword">friend</span> <a class="code" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc<A></a>;</div> |
| <div class="line"><a name="l00321"></a><span class="lineno"> 321</span> };</div> |
| <div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  </div> |
| <div class="line"><a name="l00323"></a><span class="lineno"> 323</span> } <span class="comment">/* namespace datasketches */</span></div> |
| <div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  </div> |
| <div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="preprocessor">#include "cpc_sketch_impl.hpp"</span></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="preprocessor">#endif</span></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html">datasketches::cpc_sketch_alloc</a></div><div class="ttdoc">High performance C++ implementation of Compressed Probabilistic Counting (CPC) Sketch.</div><div class="ttdef"><b>Definition:</b> cpc_sketch.hpp:64</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html_a1bcdd98ee6e6eb9b501b8dc5de5e8924"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html#a1bcdd98ee6e6eb9b501b8dc5de5e8924">datasketches::cpc_sketch_alloc::serialize</a></div><div class="ttdeci">void serialize(std::ostream &os) const</div><div class="ttdoc">This method serializes the sketch into a given stream in a binary form.</div><div class="ttdef"><b>Definition:</b> cpc_sketch_impl.hpp:408</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html_a2afb71f2ef2d82290be4c8eafc08f2a2"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html#a2afb71f2ef2d82290be4c8eafc08f2a2">datasketches::cpc_sketch_alloc::get_estimate</a></div><div class="ttdeci">double get_estimate() const</div><div class="ttdef"><b>Definition:</b> cpc_sketch_impl.hpp:75</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html_a39d6cd5eff1a9af78f58108ba5297b47"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html#a39d6cd5eff1a9af78f58108ba5297b47">datasketches::cpc_sketch_alloc::cpc_sketch_alloc</a></div><div class="ttdeci">cpc_sketch_alloc(uint8_t lg_k=cpc_constants::DEFAULT_LG_K, uint64_t seed=DEFAULT_SEED, const A &allocator=A())</div><div class="ttdoc">Creates an instance of the sketch given the lg_k parameter and hash seed.</div><div class="ttdef"><b>Definition:</b> cpc_sketch_impl.hpp:44</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html_a54ceaffd48627a356af3f72a7cc1d4ae"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html#a54ceaffd48627a356af3f72a7cc1d4ae">datasketches::cpc_sketch_alloc::deserialize</a></div><div class="ttdeci">static cpc_sketch_alloc< A > deserialize(std::istream &is, uint64_t seed=DEFAULT_SEED, const A &allocator=A())</div><div class="ttdoc">This method deserializes a sketch from a given stream.</div><div class="ttdef"><b>Definition:</b> cpc_sketch_impl.hpp:519</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html_a58c0f2372495a3163616cb0f539395ea"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html#a58c0f2372495a3163616cb0f539395ea">datasketches::cpc_sketch_alloc::update</a></div><div class="ttdeci">void update(const std::string &value)</div><div class="ttdoc">Update this sketch with a given string.</div><div class="ttdef"><b>Definition:</b> cpc_sketch_impl.hpp:109</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html_a5a2b7a58dc85678d08752945ff655362"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html#a5a2b7a58dc85678d08752945ff655362">datasketches::cpc_sketch_alloc::is_empty</a></div><div class="ttdeci">bool is_empty() const</div><div class="ttdef"><b>Definition:</b> cpc_sketch_impl.hpp:70</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html_a7fcd4a0f58526cadbf7557c5c7f540dc"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html#a7fcd4a0f58526cadbf7557c5c7f540dc">datasketches::cpc_sketch_alloc::get_max_serialized_size_bytes</a></div><div class="ttdeci">static size_t get_max_serialized_size_bytes(uint8_t lg_k)</div><div class="ttdoc">The actual size of a compressed CPC sketch has a small random variance, but the following empirically...</div><div class="ttdef"><b>Definition:</b> cpc_sketch_impl.hpp:713</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html_a8f8b2691781d682411a6de23996a8be2"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html#a8f8b2691781d682411a6de23996a8be2">datasketches::cpc_sketch_alloc::get_lg_k</a></div><div class="ttdeci">uint8_t get_lg_k() const</div><div class="ttdef"><b>Definition:</b> cpc_sketch_impl.hpp:65</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html_a9d85cf47c4ecd0580ec623c42006dd1b"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html#a9d85cf47c4ecd0580ec623c42006dd1b">datasketches::cpc_sketch_alloc::get_allocator</a></div><div class="ttdeci">A get_allocator() const</div><div class="ttdef"><b>Definition:</b> cpc_sketch_impl.hpp:60</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html_ab43d2075a173e631d757b07da971fe3d"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html#ab43d2075a173e631d757b07da971fe3d">datasketches::cpc_sketch_alloc::get_lower_bound</a></div><div class="ttdeci">double get_lower_bound(unsigned kappa) const</div><div class="ttdoc">Returns the approximate lower error bound given a parameter kappa (1, 2 or 3).</div><div class="ttdef"><b>Definition:</b> cpc_sketch_impl.hpp:91</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html_adbfa99fa21d0f4acb1ba00ced8d8d858"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html#adbfa99fa21d0f4acb1ba00ced8d8d858">datasketches::cpc_sketch_alloc::get_upper_bound</a></div><div class="ttdeci">double get_upper_bound(unsigned kappa) const</div><div class="ttdoc">Returns the approximate upper error bound given a parameter kappa (1, 2 or 3).</div><div class="ttdef"><b>Definition:</b> cpc_sketch_impl.hpp:100</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html_aed372241c10ffd041bee85602edb199a"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html#aed372241c10ffd041bee85602edb199a">datasketches::cpc_sketch_alloc::to_string</a></div><div class="ttdeci">string< A > to_string() const</div><div class="ttdoc">Returns a human-readable summary of this sketch.</div><div class="ttdef"><b>Definition:</b> cpc_sketch_impl.hpp:383</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__union__alloc_html"><div class="ttname"><a href="classdatasketches_1_1cpc__union__alloc.html">datasketches::cpc_union_alloc</a></div><div class="ttdoc">High performance C++ implementation of Compressed Probabilistic Counting (CPC) Union.</div><div class="ttdef"><b>Definition:</b> cpc_union.hpp:40</div></div> |
| <div class="ttc" id="anamespacedatasketches_1_1cpc__constants_html_a78468167a70640384c2de5e04fabe4fd"><div class="ttname"><a href="namespacedatasketches_1_1cpc__constants.html#a78468167a70640384c2de5e04fabe4fd">datasketches::cpc_constants::DEFAULT_LG_K</a></div><div class="ttdeci">const uint8_t DEFAULT_LG_K</div><div class="ttdoc">default log2 of K</div><div class="ttdef"><b>Definition:</b> cpc_common.hpp:36</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 class="ttc" id="anamespacedatasketches_html_a3a7ac5efb6156547a8da91e937a06b07"><div class="ttname"><a href="namespacedatasketches.html#a3a7ac5efb6156547a8da91e937a06b07">datasketches::cpc_init</a></div><div class="ttdeci">void cpc_init()</div><div class="ttdoc">Allocation and initialization of global decompression (decoding) tables.</div><div class="ttdef"><b>Definition:</b> cpc_sketch_impl.hpp:39</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> |
