| <!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: kll/include/kll_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_10f6c93aee96669dfb32574207aeb69c.html">kll</a></li><li class="navelem"><a class="el" href="dir_cf88e39abd5376065d05109bb16db9ef.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">kll_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 KLL_SKETCH_HPP_</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define KLL_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 <memory></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <vector></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 "common_defs.hpp"</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "serde.hpp"</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "quantiles_sorted_view.hpp"</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "optional.hpp"</span></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">namespace </span><a class="code" href="namespacedatasketches.html">datasketches</a> {</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> |
| <div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1kll__constants.html"> 34</a></span> <span class="keyword">namespace </span>kll_constants {</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1kll__constants.html#ac8602cb1bd28fc26ae74b484e81a9a52"> 36</a></span>  <span class="keyword">const</span> uint16_t <a class="code" href="namespacedatasketches_1_1kll__constants.html#ac8602cb1bd28fc26ae74b484e81a9a52">DEFAULT_K</a> = 200;</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">const</span> uint8_t DEFAULT_M = 8;</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1kll__constants.html#ab9f2b631adf46fe04a11814cd1018926"> 39</a></span>  <span class="keyword">const</span> uint16_t <a class="code" href="namespacedatasketches_1_1kll__constants.html#ab9f2b631adf46fe04a11814cd1018926">MIN_K</a> = DEFAULT_M;</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1kll__constants.html#a3bd28528c16e8911658faff9c98b305f"> 41</a></span>  <span class="keyword">const</span> uint16_t <a class="code" href="namespacedatasketches_1_1kll__constants.html#a3bd28528c16e8911658faff9c98b305f">MAX_K</a> = (1 << 16) - 1;</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="l00161"></a><span class="lineno"> 161</span> <span class="keyword">template</span> <</div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keyword">typename</span> T,</div> |
| <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keyword">typename</span> C = std::less<T>, <span class="comment">// strict weak ordering function (see C++ named requirements: Compare)</span></div> |
| <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keyword">typename</span> A = std::allocator<T></div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> ></div> |
| <div class="line"><a name="l00166"></a><span class="lineno"><a class="line" href="classdatasketches_1_1kll__sketch.html"> 166</a></span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a> {</div> |
| <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keyword">using</span> value_type = T;</div> |
| <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keyword">using</span> comparator = C;</div> |
| <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keyword">using</span> allocator_type = A;</div> |
| <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keyword">using</span> vector_u32 = std::vector<uint32_t, typename std::allocator_traits<A>::template rebind_alloc<uint32_t>>;</div> |
| <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keyword">using</span> vector_double = <span class="keyword">typename</span> <a class="code" href="classdatasketches_1_1quantiles__sorted__view.html">quantiles_sorted_view<T, C, A>::vector_double</a>;</div> |
| <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  </div> |
| <div class="line"><a name="l00178"></a><span class="lineno"><a class="line" href="classdatasketches_1_1kll__sketch.html#aa796209b1ef5dc41e83ed8158f77d280"> 178</a></span>  <span class="keyword">using</span> <a class="code" href="classdatasketches_1_1kll__sketch.html#aa796209b1ef5dc41e83ed8158f77d280">quantile_return_type</a> = <span class="keyword">typename</span> <a class="code" href="classdatasketches_1_1quantiles__sorted__view.html">quantiles_sorted_view<T, C, A>::quantile_return_type</a>;</div> |
| <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  </div> |
| <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keyword">explicit</span> <a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a>(uint16_t k = <a class="code" href="namespacedatasketches_1_1kll__constants.html#ac8602cb1bd28fc26ae74b484e81a9a52">kll_constants::DEFAULT_K</a>, <span class="keyword">const</span> C& comparator = C(), <span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  </div> |
| <div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a>& other);</div> |
| <div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  </div> |
| <div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a>(<a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a>&& other) noexcept;</div> |
| <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  </div> |
| <div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  </div> |
| <div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  ~<a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a>();</div> |
| <div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  </div> |
| <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a>& <a class="code" href="classdatasketches_1_1kll__sketch.html#a0d934088182b8615c2fa34a4716d7d44">operator=</a>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a>& other);</div> |
| <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  </div> |
| <div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a>& <a class="code" href="classdatasketches_1_1kll__sketch.html#a0d934088182b8615c2fa34a4716d7d44">operator=</a>(<a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a>&& other);</div> |
| <div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  </div> |
| <div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="comment">/*</span></div> |
| <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * Type converting constructor.</span></div> |
| <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * @param other sketch of a different type</span></div> |
| <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> * @param comparator instance of a Comparator</span></div> |
| <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> * @param allocator instance of an Allocator</span></div> |
| <div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="keyword">template</span><<span class="keyword">typename</span> TT, <span class="keyword">typename</span> CC, <span class="keyword">typename</span> AA></div> |
| <div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  <span class="keyword">explicit</span> <a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch<TT, CC, AA></a>& other, <span class="keyword">const</span> C& comparator = C(), <span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  </div> |
| <div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="keyword">template</span><<span class="keyword">typename</span> FwdT></div> |
| <div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1kll__sketch.html#a5200c74c52ee0f76d0d34c1ca6aec65c">update</a>(FwdT&& item);</div> |
| <div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  </div> |
| <div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  <span class="keyword">template</span><<span class="keyword">typename</span> FwdSk></div> |
| <div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1kll__sketch.html#a49bb19e78f36fb72b8496cd6cff71fec">merge</a>(FwdSk&& other);</div> |
| <div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  </div> |
| <div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <span class="keywordtype">bool</span> <a class="code" href="classdatasketches_1_1kll__sketch.html#a5a2b7a58dc85678d08752945ff655362">is_empty</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  </div> |
| <div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  uint16_t <a class="code" href="classdatasketches_1_1kll__sketch.html#a59f4c39b9f2e762e8e3445ef89e1d264">get_k</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  </div> |
| <div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  uint64_t <a class="code" href="classdatasketches_1_1kll__sketch.html#af857be9469a7565252626f27e1f9d74d">get_n</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  </div> |
| <div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  uint32_t <a class="code" href="classdatasketches_1_1kll__sketch.html#a31fa76458d81a17dbebfcb828e531f14">get_num_retained</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  </div> |
| <div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  <span class="keywordtype">bool</span> <a class="code" href="classdatasketches_1_1kll__sketch.html#ae95a04b1d7dccb3d9b3f3c3d087aa8e6">is_estimation_mode</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  </div> |
| <div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  T <a class="code" href="classdatasketches_1_1kll__sketch.html#aa3f3769ba3fae6fa0e8a0bd65fef5422">get_min_item</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  </div> |
| <div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  T <a class="code" href="classdatasketches_1_1kll__sketch.html#a4cdb10e4f2949d55d29421c6e381a300">get_max_item</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  </div> |
| <div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  C <a class="code" href="classdatasketches_1_1kll__sketch.html#a076f89979daa6471a3868cb97ea99b40">get_comparator</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  </div> |
| <div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  A <a class="code" href="classdatasketches_1_1kll__sketch.html#a9d85cf47c4ecd0580ec623c42006dd1b">get_allocator</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  </div> |
| <div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  <a class="code" href="classdatasketches_1_1kll__sketch.html#aa796209b1ef5dc41e83ed8158f77d280">quantile_return_type</a> <a class="code" href="classdatasketches_1_1kll__sketch.html#ac02fcfb6e706148458a2ef89390223a9">get_quantile</a>(<span class="keywordtype">double</span> rank, <span class="keywordtype">bool</span> inclusive = <span class="keyword">true</span>) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  </div> |
| <div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  <span class="keywordtype">double</span> <a class="code" href="classdatasketches_1_1kll__sketch.html#a849dfa06c183fd2fdfe4fe4a7e29d918">get_rank</a>(<span class="keyword">const</span> T& item, <span class="keywordtype">bool</span> inclusive = <span class="keyword">true</span>) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  </div> |
| <div class="line"><a name="l00348"></a><span class="lineno"> 348</span>  vector_double <a class="code" href="classdatasketches_1_1kll__sketch.html#a44226b755e73883ea2c128876e35b1d1">get_PMF</a>(<span class="keyword">const</span> T* split_points, uint32_t size, <span class="keywordtype">bool</span> inclusive = <span class="keyword">true</span>) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00349"></a><span class="lineno"> 349</span>  </div> |
| <div class="line"><a name="l00375"></a><span class="lineno"> 375</span>  vector_double <a class="code" href="classdatasketches_1_1kll__sketch.html#a20a4d992209b2aa58614c998d143705c">get_CDF</a>(<span class="keyword">const</span> T* split_points, uint32_t size, <span class="keywordtype">bool</span> inclusive = <span class="keyword">true</span>) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00376"></a><span class="lineno"> 376</span>  </div> |
| <div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  <span class="keywordtype">double</span> <a class="code" href="classdatasketches_1_1kll__sketch.html#ae08ba9502b0403ad4448d649ce29b850">get_normalized_rank_error</a>(<span class="keywordtype">bool</span> pmf) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  </div> |
| <div class="line"><a name="l00392"></a><span class="lineno"> 392</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="l00393"></a><span class="lineno"> 393</span>  <span class="keywordtype">size_t</span> <a class="code" href="classdatasketches_1_1kll__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="l00394"></a><span class="lineno"> 394</span>  </div> |
| <div class="line"><a name="l00401"></a><span class="lineno"> 401</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="l00402"></a><span class="lineno"><a class="line" href="classdatasketches_1_1kll__sketch.html#ad9a5259d93d148b5c2050d68e7788716"> 402</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classdatasketches_1_1kll__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="l00403"></a><span class="lineno"> 403</span>  </div> |
| <div class="line"><a name="l00414"></a><span class="lineno"> 414</span>  template<typename TT = T, typename std::enable_if<std::is_arithmetic<TT>::value, <span class="keywordtype">int</span>>::type = 0></div> |
| <div class="line"><a name="l00415"></a><span class="lineno"> 415</span>  <span class="keyword">static</span> <span class="keywordtype">size_t</span> <a class="code" href="classdatasketches_1_1kll__sketch.html#adb2232570b4977756cddd02b4b6b845b">get_max_serialized_size_bytes</a>(uint16_t k, uint64_t n);</div> |
| <div class="line"><a name="l00416"></a><span class="lineno"> 416</span>  </div> |
| <div class="line"><a name="l00428"></a><span class="lineno"> 428</span>  template<typename TT = T, typename std::enable_if<!std::is_arithmetic<TT>::value, <span class="keywordtype">int</span>>::type = 0></div> |
| <div class="line"><a name="l00429"></a><span class="lineno"> 429</span>  <span class="keyword">static</span> <span class="keywordtype">size_t</span> <a class="code" href="classdatasketches_1_1kll__sketch.html#adb2232570b4977756cddd02b4b6b845b">get_max_serialized_size_bytes</a>(uint16_t k, uint64_t n, <span class="keywordtype">size_t</span> max_item_size_bytes);</div> |
| <div class="line"><a name="l00430"></a><span class="lineno"> 430</span>  </div> |
| <div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  <span class="keyword">template</span><<span class="keyword">typename</span> SerDe = serde<T>></div> |
| <div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1kll__sketch.html#a538940c100e4353b3671ad452d3d3056">serialize</a>(std::ostream& os, <span class="keyword">const</span> SerDe& sd = SerDe()) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00438"></a><span class="lineno"> 438</span>  </div> |
| <div class="line"><a name="l00439"></a><span class="lineno"> 439</span>  <span class="comment">// This is a convenience alias for users</span></div> |
| <div class="line"><a name="l00440"></a><span class="lineno"> 440</span>  <span class="comment">// The type returned by the following serialize method</span></div> |
| <div class="line"><a name="l00441"></a><span class="lineno"> 441</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="l00442"></a><span class="lineno"> 442</span>  </div> |
| <div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  <span class="keyword">template</span><<span class="keyword">typename</span> SerDe = serde<T>></div> |
| <div class="line"><a name="l00453"></a><span class="lineno"><a class="line" href="classdatasketches_1_1kll__sketch.html#a1d0c269c23926e93b1c7a9c00e86af97"> 453</a></span>  vector_bytes <a class="code" href="classdatasketches_1_1kll__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="l00454"></a><span class="lineno"> 454</span>  </div> |
| <div class="line"><a name="l00463"></a><span class="lineno"> 463</span>  <span class="keyword">template</span><<span class="keyword">typename</span> SerDe = serde<T>></div> |
| <div class="line"><a name="l00464"></a><span class="lineno"><a class="line" href="classdatasketches_1_1kll__sketch.html#a3f2a0c95cd2c88854ec9b9ab7088f419"> 464</a></span>  <span class="keyword">static</span> <a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a> <a class="code" href="classdatasketches_1_1kll__sketch.html#a3f2a0c95cd2c88854ec9b9ab7088f419">deserialize</a>(std::istream& is, <span class="keyword">const</span> SerDe& sd = SerDe(),</div> |
| <div class="line"><a name="l00465"></a><span class="lineno"> 465</span>  <span class="keyword">const</span> C& comparator = C(), <span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00466"></a><span class="lineno"> 466</span>  </div> |
| <div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  <span class="keyword">template</span><<span class="keyword">typename</span> SerDe = serde<T>></div> |
| <div class="line"><a name="l00477"></a><span class="lineno"><a class="line" href="classdatasketches_1_1kll__sketch.html#afdd7e72ffdee78a8f96d8160a154d81a"> 477</a></span>  <span class="keyword">static</span> <a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a> <a class="code" href="classdatasketches_1_1kll__sketch.html#afdd7e72ffdee78a8f96d8160a154d81a">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(),</div> |
| <div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  <span class="keyword">const</span> C& comparator = C(), <span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  </div> |
| <div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  <span class="comment">/*</span></div> |
| <div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment"> * Gets the normalized rank error given k and pmf.</span></div> |
| <div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="comment"> * k - the configuration parameter</span></div> |
| <div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="comment"> * pmf - if true, returns the "double-sided" normalized rank error for the get_PMF() function.</span></div> |
| <div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment"> * Otherwise, it is the "single-sided" normalized rank error for all the other queries.</span></div> |
| <div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment"> * Constants were derived as the best fit to 99 percentile empirically measured max error in thousands of trials</span></div> |
| <div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  <span class="keyword">static</span> <span class="keywordtype">double</span> <a class="code" href="classdatasketches_1_1kll__sketch.html#ae08ba9502b0403ad4448d649ce29b850">get_normalized_rank_error</a>(uint16_t k, <span class="keywordtype">bool</span> pmf);</div> |
| <div class="line"><a name="l00488"></a><span class="lineno"> 488</span>  </div> |
| <div class="line"><a name="l00494"></a><span class="lineno"> 494</span>  string<A> <a class="code" href="classdatasketches_1_1kll__sketch.html#a592a7af55659ff803b26a45552a68dda">to_string</a>(<span class="keywordtype">bool</span> print_levels = <span class="keyword">false</span>, <span class="keywordtype">bool</span> print_items = <span class="keyword">false</span>) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00495"></a><span class="lineno"> 495</span>  </div> |
| <div class="line"><a name="l00496"></a><span class="lineno"> 496</span>  <span class="keyword">class </span>const_iterator;</div> |
| <div class="line"><a name="l00497"></a><span class="lineno"> 497</span>  </div> |
| <div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  const_iterator <a class="code" href="classdatasketches_1_1kll__sketch.html#a288af208cb43c6bdd67b788dc92037ea">begin</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00504"></a><span class="lineno"> 504</span>  </div> |
| <div class="line"><a name="l00511"></a><span class="lineno"> 511</span>  const_iterator <a class="code" href="classdatasketches_1_1kll__sketch.html#a5194060fd9b11a856cfb47e59801a3eb">end</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00512"></a><span class="lineno"> 512</span>  </div> |
| <div class="line"><a name="l00517"></a><span class="lineno"> 517</span>  <a class="code" href="classdatasketches_1_1quantiles__sorted__view.html">quantiles_sorted_view<T, C, A></a> <a class="code" href="classdatasketches_1_1kll__sketch.html#a0a9c9c240dd591017fd6a80e147b7c00">get_sorted_view</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00518"></a><span class="lineno"> 518</span>  </div> |
| <div class="line"><a name="l00519"></a><span class="lineno"> 519</span>  <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00520"></a><span class="lineno"> 520</span>  <span class="comment">/* Serialized sketch layout:</span></div> |
| <div class="line"><a name="l00521"></a><span class="lineno"> 521</span> <span class="comment"> * Addr:</span></div> |
| <div class="line"><a name="l00522"></a><span class="lineno"> 522</span> <span class="comment"> * || 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |</span></div> |
| <div class="line"><a name="l00523"></a><span class="lineno"> 523</span> <span class="comment"> * 0 || unused | M |--------K--------| Flags | FamID | SerVer | PreambleInts |</span></div> |
| <div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="comment"> * || 15 | 14 | 13 | 12 | 11 | 10 | 9 | 8 |</span></div> |
| <div class="line"><a name="l00525"></a><span class="lineno"> 525</span> <span class="comment"> * 1 ||-----------------------------------N------------------------------------------|</span></div> |
| <div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="comment"> * || 23 | 22 | 21 | 20 | 19 | 18 | 17 | 16 |</span></div> |
| <div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="comment"> * 2 ||---------------data----------------|-unused-|numLevels|-------min K-----------|</span></div> |
| <div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00529"></a><span class="lineno"> 529</span>  </div> |
| <div class="line"><a name="l00530"></a><span class="lineno"> 530</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> EMPTY_SIZE_BYTES = 8;</div> |
| <div class="line"><a name="l00531"></a><span class="lineno"> 531</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> DATA_START_SINGLE_ITEM = 8;</div> |
| <div class="line"><a name="l00532"></a><span class="lineno"> 532</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> DATA_START = 20;</div> |
| <div class="line"><a name="l00533"></a><span class="lineno"> 533</span>  </div> |
| <div class="line"><a name="l00534"></a><span class="lineno"> 534</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t SERIAL_VERSION_1 = 1;</div> |
| <div class="line"><a name="l00535"></a><span class="lineno"> 535</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t SERIAL_VERSION_2 = 2;</div> |
| <div class="line"><a name="l00536"></a><span class="lineno"> 536</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FAMILY = 15;</div> |
| <div class="line"><a name="l00537"></a><span class="lineno"> 537</span>  </div> |
| <div class="line"><a name="l00538"></a><span class="lineno"> 538</span>  <span class="keyword">enum</span> flags { IS_EMPTY, IS_LEVEL_ZERO_SORTED, IS_SINGLE_ITEM };</div> |
| <div class="line"><a name="l00539"></a><span class="lineno"> 539</span>  </div> |
| <div class="line"><a name="l00540"></a><span class="lineno"> 540</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t PREAMBLE_INTS_SHORT = 2; <span class="comment">// for empty and single item</span></div> |
| <div class="line"><a name="l00541"></a><span class="lineno"> 541</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t PREAMBLE_INTS_FULL = 5;</div> |
| <div class="line"><a name="l00542"></a><span class="lineno"> 542</span>  </div> |
| <div class="line"><a name="l00543"></a><span class="lineno"> 543</span>  C comparator_;</div> |
| <div class="line"><a name="l00544"></a><span class="lineno"> 544</span>  A allocator_;</div> |
| <div class="line"><a name="l00545"></a><span class="lineno"> 545</span>  uint16_t k_;</div> |
| <div class="line"><a name="l00546"></a><span class="lineno"> 546</span>  uint8_t m_; <span class="comment">// minimum buffer "width"</span></div> |
| <div class="line"><a name="l00547"></a><span class="lineno"> 547</span>  uint16_t min_k_; <span class="comment">// for error estimation after merging with different k</span></div> |
| <div class="line"><a name="l00548"></a><span class="lineno"> 548</span>  uint8_t num_levels_;</div> |
| <div class="line"><a name="l00549"></a><span class="lineno"> 549</span>  <span class="keywordtype">bool</span> is_level_zero_sorted_;</div> |
| <div class="line"><a name="l00550"></a><span class="lineno"> 550</span>  uint64_t n_;</div> |
| <div class="line"><a name="l00551"></a><span class="lineno"> 551</span>  vector_u32 levels_;</div> |
| <div class="line"><a name="l00552"></a><span class="lineno"> 552</span>  T* items_;</div> |
| <div class="line"><a name="l00553"></a><span class="lineno"> 553</span>  uint32_t items_size_;</div> |
| <div class="line"><a name="l00554"></a><span class="lineno"> 554</span>  optional<T> min_item_;</div> |
| <div class="line"><a name="l00555"></a><span class="lineno"> 555</span>  optional<T> max_item_;</div> |
| <div class="line"><a name="l00556"></a><span class="lineno"> 556</span>  <span class="keyword">mutable</span> <a class="code" href="classdatasketches_1_1quantiles__sorted__view.html">quantiles_sorted_view<T, C, A></a>* sorted_view_;</div> |
| <div class="line"><a name="l00557"></a><span class="lineno"> 557</span>  </div> |
| <div class="line"><a name="l00558"></a><span class="lineno"> 558</span>  <span class="comment">// for deserialization</span></div> |
| <div class="line"><a name="l00559"></a><span class="lineno"> 559</span>  <span class="keyword">class </span>items_deleter;</div> |
| <div class="line"><a name="l00560"></a><span class="lineno"> 560</span>  <a class="code" href="classdatasketches_1_1kll__sketch.html">kll_sketch</a>(uint16_t k, uint16_t min_k, uint64_t n, uint8_t num_levels, vector_u32&& levels,</div> |
| <div class="line"><a name="l00561"></a><span class="lineno"> 561</span>  std::unique_ptr<T, items_deleter> items, uint32_t items_size, optional<T>&& min_item,</div> |
| <div class="line"><a name="l00562"></a><span class="lineno"> 562</span>  optional<T>&& max_item, <span class="keywordtype">bool</span> is_level_zero_sorted, <span class="keyword">const</span> C& comparator);</div> |
| <div class="line"><a name="l00563"></a><span class="lineno"> 563</span>  </div> |
| <div class="line"><a name="l00564"></a><span class="lineno"> 564</span>  <span class="comment">// common update code</span></div> |
| <div class="line"><a name="l00565"></a><span class="lineno"> 565</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> update_min_max(<span class="keyword">const</span> T& item);</div> |
| <div class="line"><a name="l00566"></a><span class="lineno"> 566</span>  <span class="keyword">inline</span> uint32_t internal_update();</div> |
| <div class="line"><a name="l00567"></a><span class="lineno"> 567</span>  </div> |
| <div class="line"><a name="l00568"></a><span class="lineno"> 568</span>  <span class="comment">// The following code is only valid in the special case of exactly reaching capacity while updating.</span></div> |
| <div class="line"><a name="l00569"></a><span class="lineno"> 569</span>  <span class="comment">// It cannot be used while merging, while reducing k, or anything else.</span></div> |
| <div class="line"><a name="l00570"></a><span class="lineno"> 570</span>  <span class="keywordtype">void</span> compress_while_updating(<span class="keywordtype">void</span>);</div> |
| <div class="line"><a name="l00571"></a><span class="lineno"> 571</span>  </div> |
| <div class="line"><a name="l00572"></a><span class="lineno"> 572</span>  uint8_t find_level_to_compact() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00573"></a><span class="lineno"> 573</span>  <span class="keywordtype">void</span> add_empty_top_level_to_completely_full_sketch();</div> |
| <div class="line"><a name="l00574"></a><span class="lineno"> 574</span>  <span class="keywordtype">void</span> sort_level_zero();</div> |
| <div class="line"><a name="l00575"></a><span class="lineno"> 575</span>  </div> |
| <div class="line"><a name="l00576"></a><span class="lineno"> 576</span>  <span class="keyword">template</span><<span class="keyword">typename</span> O> <span class="keywordtype">void</span> merge_higher_levels(O&& other, uint64_t final_n);</div> |
| <div class="line"><a name="l00577"></a><span class="lineno"> 577</span>  </div> |
| <div class="line"><a name="l00578"></a><span class="lineno"> 578</span>  <span class="keyword">template</span><<span class="keyword">typename</span> FwdSk></div> |
| <div class="line"><a name="l00579"></a><span class="lineno"> 579</span>  <span class="keywordtype">void</span> populate_work_arrays(FwdSk&& other, T* workbuf, uint32_t* worklevels, uint8_t provisional_num_levels);</div> |
| <div class="line"><a name="l00580"></a><span class="lineno"> 580</span>  </div> |
| <div class="line"><a name="l00581"></a><span class="lineno"> 581</span>  <span class="keywordtype">void</span> assert_correct_total_weight() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00582"></a><span class="lineno"> 582</span>  uint32_t safe_level_size(uint8_t level) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00583"></a><span class="lineno"> 583</span>  uint32_t get_num_retained_above_level_zero() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00584"></a><span class="lineno"> 584</span>  </div> |
| <div class="line"><a name="l00585"></a><span class="lineno"> 585</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_m(uint8_t m);</div> |
| <div class="line"><a name="l00586"></a><span class="lineno"> 586</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_preamble_ints(uint8_t preamble_ints, uint8_t flags_byte);</div> |
| <div class="line"><a name="l00587"></a><span class="lineno"> 587</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_serial_version(uint8_t serial_version);</div> |
| <div class="line"><a name="l00588"></a><span class="lineno"> 588</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_family_id(uint8_t family_id);</div> |
| <div class="line"><a name="l00589"></a><span class="lineno"> 589</span>  </div> |
| <div class="line"><a name="l00590"></a><span class="lineno"> 590</span>  <span class="keywordtype">void</span> check_sorting() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00591"></a><span class="lineno"> 591</span>  </div> |
| <div class="line"><a name="l00592"></a><span class="lineno"> 592</span>  template<typename TT = T, typename std::enable_if<std::is_floating_point<TT>::value, <span class="keywordtype">int</span>>::type = 0></div> |
| <div class="line"><a name="l00593"></a><span class="lineno"> 593</span>  <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> check_update_item(TT item) {</div> |
| <div class="line"><a name="l00594"></a><span class="lineno"> 594</span>  <span class="keywordflow">return</span> !std::isnan(item);</div> |
| <div class="line"><a name="l00595"></a><span class="lineno"> 595</span>  }</div> |
| <div class="line"><a name="l00596"></a><span class="lineno"> 596</span>  </div> |
| <div class="line"><a name="l00597"></a><span class="lineno"> 597</span>  template<typename TT = T, typename std::enable_if<!std::is_floating_point<TT>::value, <span class="keywordtype">int</span>>::type = 0></div> |
| <div class="line"><a name="l00598"></a><span class="lineno"> 598</span>  <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> check_update_item(TT) {</div> |
| <div class="line"><a name="l00599"></a><span class="lineno"> 599</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div> |
| <div class="line"><a name="l00600"></a><span class="lineno"> 600</span>  }</div> |
| <div class="line"><a name="l00601"></a><span class="lineno"> 601</span>  </div> |
| <div class="line"><a name="l00602"></a><span class="lineno"> 602</span>  <span class="comment">// for type converting constructor</span></div> |
| <div class="line"><a name="l00603"></a><span class="lineno"> 603</span>  <span class="keyword">template</span><<span class="keyword">typename</span> TT, <span class="keyword">typename</span> CC, <span class="keyword">typename</span> AA> <span class="keyword">friend</span> <span class="keyword">class </span>kll_sketch;</div> |
| <div class="line"><a name="l00604"></a><span class="lineno"> 604</span>  </div> |
| <div class="line"><a name="l00605"></a><span class="lineno"> 605</span>  <span class="keywordtype">void</span> setup_sorted_view() <span class="keyword">const</span>; <span class="comment">// modifies mutable state</span></div> |
| <div class="line"><a name="l00606"></a><span class="lineno"> 606</span>  <span class="keywordtype">void</span> reset_sorted_view();</div> |
| <div class="line"><a name="l00607"></a><span class="lineno"> 607</span> };</div> |
| <div class="line"><a name="l00608"></a><span class="lineno"> 608</span>  </div> |
| <div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="keyword">template</span><<span class="keyword">typename</span> T, <span class="keyword">typename</span> C, <span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00610"></a><span class="lineno"> 610</span> <span class="keyword">class </span>kll_sketch<T, C, A>::const_iterator {</div> |
| <div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00612"></a><span class="lineno"> 612</span>  <span class="keyword">using</span> iterator_category = std::input_iterator_tag;</div> |
| <div class="line"><a name="l00613"></a><span class="lineno"> 613</span>  <span class="keyword">using</span> value_type = std::pair<const T&, const uint64_t>;</div> |
| <div class="line"><a name="l00614"></a><span class="lineno"> 614</span>  <span class="keyword">using</span> difference_type = void;</div> |
| <div class="line"><a name="l00615"></a><span class="lineno"> 615</span>  <span class="keyword">using</span> pointer = <span class="keyword">const</span> return_value_holder<value_type>;</div> |
| <div class="line"><a name="l00616"></a><span class="lineno"> 616</span>  <span class="keyword">using</span> reference = <span class="keyword">const</span> value_type;</div> |
| <div class="line"><a name="l00617"></a><span class="lineno"> 617</span>  </div> |
| <div class="line"><a name="l00618"></a><span class="lineno"> 618</span>  <span class="keyword">friend</span> <span class="keyword">class </span>kll_sketch<T, C, A>;</div> |
| <div class="line"><a name="l00619"></a><span class="lineno"> 619</span>  const_iterator& operator++();</div> |
| <div class="line"><a name="l00620"></a><span class="lineno"> 620</span>  const_iterator& operator++(<span class="keywordtype">int</span>);</div> |
| <div class="line"><a name="l00621"></a><span class="lineno"> 621</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="l00622"></a><span class="lineno"> 622</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="l00623"></a><span class="lineno"> 623</span>  reference operator*() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00624"></a><span class="lineno"> 624</span>  pointer operator->() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00625"></a><span class="lineno"> 625</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00626"></a><span class="lineno"> 626</span>  <span class="keyword">const</span> T* items;</div> |
| <div class="line"><a name="l00627"></a><span class="lineno"> 627</span>  <span class="keyword">const</span> uint32_t* levels;</div> |
| <div class="line"><a name="l00628"></a><span class="lineno"> 628</span>  <span class="keyword">const</span> uint8_t num_levels;</div> |
| <div class="line"><a name="l00629"></a><span class="lineno"> 629</span>  uint32_t index;</div> |
| <div class="line"><a name="l00630"></a><span class="lineno"> 630</span>  uint8_t level;</div> |
| <div class="line"><a name="l00631"></a><span class="lineno"> 631</span>  uint64_t weight;</div> |
| <div class="line"><a name="l00632"></a><span class="lineno"> 632</span>  const_iterator(<span class="keyword">const</span> T* items, <span class="keyword">const</span> uint32_t* levels, <span class="keyword">const</span> uint8_t num_levels);</div> |
| <div class="line"><a name="l00633"></a><span class="lineno"> 633</span> };</div> |
| <div class="line"><a name="l00634"></a><span class="lineno"> 634</span>  </div> |
| <div class="line"><a name="l00635"></a><span class="lineno"> 635</span> } <span class="comment">/* namespace datasketches */</span></div> |
| <div class="line"><a name="l00636"></a><span class="lineno"> 636</span>  </div> |
| <div class="line"><a name="l00637"></a><span class="lineno"> 637</span> <span class="preprocessor">#include "kll_sketch_impl.hpp"</span></div> |
| <div class="line"><a name="l00638"></a><span class="lineno"> 638</span>  </div> |
| <div class="line"><a name="l00639"></a><span class="lineno"> 639</span> <span class="preprocessor">#endif</span></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html">datasketches::kll_sketch</a></div><div class="ttdoc">Implementation of a very compact quantiles sketch with lazy compaction scheme and nearly optimal accu...</div><div class="ttdef"><b>Definition:</b> kll_sketch.hpp:166</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a076f89979daa6471a3868cb97ea99b40"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a076f89979daa6471a3868cb97ea99b40">datasketches::kll_sketch::get_comparator</a></div><div class="ttdeci">C get_comparator() const</div><div class="ttdoc">Returns an instance of the comparator for this sketch.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:271</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a0a9c9c240dd591017fd6a80e147b7c00"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a0a9c9c240dd591017fd6a80e147b7c00">datasketches::kll_sketch::get_sorted_view</a></div><div class="ttdeci">quantiles_sorted_view< T, C, A > get_sorted_view() const</div><div class="ttdoc">Gets the sorted view of this sketch.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:760</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a0d934088182b8615c2fa34a4716d7d44"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a0d934088182b8615c2fa34a4716d7d44">datasketches::kll_sketch::operator=</a></div><div class="ttdeci">kll_sketch & operator=(const kll_sketch &other)</div><div class="ttdoc">Copy assignment.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:102</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a1d0c269c23926e93b1c7a9c00e86af97"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a1d0c269c23926e93b1c7a9c00e86af97">datasketches::kll_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_1kll__sketch_html_a20a4d992209b2aa58614c998d143705c"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a20a4d992209b2aa58614c998d143705c">datasketches::kll_sketch::get_CDF</a></div><div class="ttdeci">vector_double get_CDF(const T *split_points, uint32_t size, bool inclusive=true) const</div><div class="ttdoc">Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analo...</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:295</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a288af208cb43c6bdd67b788dc92037ea"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a288af208cb43c6bdd67b788dc92037ea">datasketches::kll_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> kll_sketch_impl.hpp:956</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a31fa76458d81a17dbebfcb828e531f14"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a31fa76458d81a17dbebfcb828e531f14">datasketches::kll_sketch::get_num_retained</a></div><div class="ttdeci">uint32_t get_num_retained() const</div><div class="ttdoc">Returns the number of retained items (samples) in the sketch.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:249</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a3f2a0c95cd2c88854ec9b9ab7088f419"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a3f2a0c95cd2c88854ec9b9ab7088f419">datasketches::kll_sketch::deserialize</a></div><div class="ttdeci">static kll_sketch deserialize(std::istream &is, const SerDe &sd=SerDe(), const C &comparator=C(), 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_1kll__sketch_html_a44226b755e73883ea2c128876e35b1d1"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a44226b755e73883ea2c128876e35b1d1">datasketches::kll_sketch::get_PMF</a></div><div class="ttdeci">vector_double get_PMF(const T *split_points, uint32_t size, bool inclusive=true) const</div><div class="ttdoc">Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of sp...</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:288</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a49bb19e78f36fb72b8496cd6cff71fec"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a49bb19e78f36fb72b8496cd6cff71fec">datasketches::kll_sketch::merge</a></div><div class="ttdeci">void merge(FwdSk &&other)</div><div class="ttdoc">Merges another sketch into this one.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:209</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a4cdb10e4f2949d55d29421c6e381a300"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a4cdb10e4f2949d55d29421c6e381a300">datasketches::kll_sketch::get_max_item</a></div><div class="ttdeci">T get_max_item() const</div><div class="ttdoc">Returns the max item of the stream.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:265</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a5194060fd9b11a856cfb47e59801a3eb"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a5194060fd9b11a856cfb47e59801a3eb">datasketches::kll_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> kll_sketch_impl.hpp:961</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a5200c74c52ee0f76d0d34c1ca6aec65c"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a5200c74c52ee0f76d0d34c1ca6aec65c">datasketches::kll_sketch::update</a></div><div class="ttdeci">void update(FwdT &&item)</div><div class="ttdoc">Updates this sketch with the given data item.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:180</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a538940c100e4353b3671ad452d3d3056"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a538940c100e4353b3671ad452d3d3056">datasketches::kll_sketch::serialize</a></div><div class="ttdeci">void serialize(std::ostream &os, const SerDe &sd=SerDe()) 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> kll_sketch_impl.hpp:367</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a592a7af55659ff803b26a45552a68dda"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a592a7af55659ff803b26a45552a68dda">datasketches::kll_sketch::to_string</a></div><div class="ttdeci">string< A > to_string(bool print_levels=false, bool print_items=false) const</div><div class="ttdoc">Prints a summary of the sketch.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:904</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a59f4c39b9f2e762e8e3445ef89e1d264"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a59f4c39b9f2e762e8e3445ef89e1d264">datasketches::kll_sketch::get_k</a></div><div class="ttdeci">uint16_t get_k() const</div><div class="ttdoc">Returns configured parameter k.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:239</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a5a2b7a58dc85678d08752945ff655362"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a5a2b7a58dc85678d08752945ff655362">datasketches::kll_sketch::is_empty</a></div><div class="ttdeci">bool is_empty() const</div><div class="ttdoc">Returns true if this sketch is empty.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:234</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a849dfa06c183fd2fdfe4fe4a7e29d918"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a849dfa06c183fd2fdfe4fe4a7e29d918">datasketches::kll_sketch::get_rank</a></div><div class="ttdeci">double get_rank(const T &item, bool inclusive=true) const</div><div class="ttdoc">Returns an approximation to the normalized rank of the given item from 0 to 1, inclusive.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:281</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_a9d85cf47c4ecd0580ec623c42006dd1b"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#a9d85cf47c4ecd0580ec623c42006dd1b">datasketches::kll_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> kll_sketch_impl.hpp:276</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_aa3f3769ba3fae6fa0e8a0bd65fef5422"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#aa3f3769ba3fae6fa0e8a0bd65fef5422">datasketches::kll_sketch::get_min_item</a></div><div class="ttdeci">T get_min_item() const</div><div class="ttdoc">Returns the min item of the stream.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:259</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_aa796209b1ef5dc41e83ed8158f77d280"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#aa796209b1ef5dc41e83ed8158f77d280">datasketches::kll_sketch::quantile_return_type</a></div><div class="ttdeci">typename quantiles_sorted_view< T, C, A >::quantile_return_type quantile_return_type</div><div class="ttdoc">Quantile return type.</div><div class="ttdef"><b>Definition:</b> kll_sketch.hpp:178</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_ac02fcfb6e706148458a2ef89390223a9"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#ac02fcfb6e706148458a2ef89390223a9">datasketches::kll_sketch::get_quantile</a></div><div class="ttdeci">quantile_return_type get_quantile(double rank, bool inclusive=true) const</div><div class="ttdoc">Returns an item from the sketch that is the best approximation to an item from the original stream wi...</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:302</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_ad9a5259d93d148b5c2050d68e7788716"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#ad9a5259d93d148b5c2050d68e7788716">datasketches::kll_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> kll_sketch_impl.hpp:320</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_adb2232570b4977756cddd02b4b6b845b"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#adb2232570b4977756cddd02b4b6b845b">datasketches::kll_sketch::get_max_serialized_size_bytes</a></div><div class="ttdeci">static size_t get_max_serialized_size_bytes(uint16_t k, uint64_t n)</div><div class="ttdoc">Returns upper bound on the serialized size of a sketch given a parameter k and stream length.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:348</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_ae08ba9502b0403ad4448d649ce29b850"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#ae08ba9502b0403ad4448d649ce29b850">datasketches::kll_sketch::get_normalized_rank_error</a></div><div class="ttdeci">double get_normalized_rank_error(bool pmf) const</div><div class="ttdoc">Gets the approximate rank error of this sketch normalized as a fraction between zero and one.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:313</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_ae95a04b1d7dccb3d9b3f3c3d087aa8e6"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#ae95a04b1d7dccb3d9b3f3c3d087aa8e6">datasketches::kll_sketch::is_estimation_mode</a></div><div class="ttdeci">bool is_estimation_mode() const</div><div class="ttdoc">Returns true if this sketch is in estimation mode.</div><div class="ttdef"><b>Definition:</b> kll_sketch_impl.hpp:254</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_af857be9469a7565252626f27e1f9d74d"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#af857be9469a7565252626f27e1f9d74d">datasketches::kll_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> kll_sketch_impl.hpp:244</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1kll__sketch_html_afdd7e72ffdee78a8f96d8160a154d81a"><div class="ttname"><a href="classdatasketches_1_1kll__sketch.html#afdd7e72ffdee78a8f96d8160a154d81a">datasketches::kll_sketch::deserialize</a></div><div class="ttdeci">static kll_sketch deserialize(const void *bytes, size_t size, const SerDe &sd=SerDe(), const C &comparator=C(), 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_1quantiles__sorted__view_html"><div class="ttname"><a href="classdatasketches_1_1quantiles__sorted__view.html">datasketches::quantiles_sorted_view</a></div><div class="ttdoc">Sorted view for quantiles sketches (REQ, KLL and Quantiles)</div><div class="ttdef"><b>Definition:</b> quantiles_sorted_view.hpp:38</div></div> |
| <div class="ttc" id="anamespacedatasketches_1_1kll__constants_html_a3bd28528c16e8911658faff9c98b305f"><div class="ttname"><a href="namespacedatasketches_1_1kll__constants.html#a3bd28528c16e8911658faff9c98b305f">datasketches::kll_constants::MAX_K</a></div><div class="ttdeci">const uint16_t MAX_K</div><div class="ttdoc">max value of parameter K</div><div class="ttdef"><b>Definition:</b> kll_sketch.hpp:41</div></div> |
| <div class="ttc" id="anamespacedatasketches_1_1kll__constants_html_ab9f2b631adf46fe04a11814cd1018926"><div class="ttname"><a href="namespacedatasketches_1_1kll__constants.html#ab9f2b631adf46fe04a11814cd1018926">datasketches::kll_constants::MIN_K</a></div><div class="ttdeci">const uint16_t MIN_K</div><div class="ttdoc">min value of parameter K</div><div class="ttdef"><b>Definition:</b> kll_sketch.hpp:39</div></div> |
| <div class="ttc" id="anamespacedatasketches_1_1kll__constants_html_ac8602cb1bd28fc26ae74b484e81a9a52"><div class="ttname"><a href="namespacedatasketches_1_1kll__constants.html#ac8602cb1bd28fc26ae74b484e81a9a52">datasketches::kll_constants::DEFAULT_K</a></div><div class="ttdeci">const uint16_t DEFAULT_K</div><div class="ttdoc">default value of parameter K</div><div class="ttdef"><b>Definition:</b> kll_sketch.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><!-- 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> |