| <!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: density/include/density_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_14b95f261231c5f650b9b0a09b57a6c5.html">density</a></li><li class="navelem"><a class="el" href="dir_e0b5a940fd5435f299127cc9babd5c8d.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">density_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 DENSITY_SKETCH_HPP_</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define DENSITY_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 <type_traits></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> <span class="preprocessor">#include <functional></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <numeric></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <cmath></span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "common_defs.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="l00033"></a><span class="lineno"> 33</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">struct </span>gaussian_kernel {</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  T operator()(<span class="keyword">const</span> std::vector<T>& v1, <span class="keyword">const</span> std::vector<T>& v2)<span class="keyword"> const </span>{</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">return</span> exp(-std::inner_product(v1.begin(), v1.end(), v2.begin(), 0.0, std::plus<T>(), [](T a, T b){return (a-b)*(a-b);}));</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  }</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> };</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">template</span><</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">typename</span> T,</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">typename</span> Kernel = gaussian_kernel<T>,</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">typename</span> Allocator = std::allocator<T></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> ></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classdatasketches_1_1density__sketch.html"> 57</a></span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1density__sketch.html">density_sketch</a> {</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  static_assert(std::is_floating_point<T>::value, <span class="stringliteral">"Floating point type expected"</span>);</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">using</span> Vector = std::vector<T, Allocator>;</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">using</span> Level = std::vector<Vector, typename std::allocator_traits<Allocator>::template rebind_alloc<Vector>>;</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">using</span> Levels = std::vector<Level, typename std::allocator_traits<Allocator>::template rebind_alloc<Level>>;</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div> |
| <div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classdatasketches_1_1density__sketch.html#a08daaa6a0d62a61b612a0dbbbd0b22d5"> 72</a></span>  <a class="code" href="classdatasketches_1_1density__sketch.html#a08daaa6a0d62a61b612a0dbbbd0b22d5">density_sketch</a>(uint16_t k, uint32_t dim, <span class="keyword">const</span> Kernel& kernel = Kernel(), <span class="keyword">const</span> Allocator& allocator = Allocator());</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  uint16_t <a class="code" href="classdatasketches_1_1density__sketch.html#a59f4c39b9f2e762e8e3445ef89e1d264">get_k</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  uint32_t <a class="code" href="classdatasketches_1_1density__sketch.html#a57bff8d89cd2bde903090aa30208f610">get_dim</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">bool</span> <a class="code" href="classdatasketches_1_1density__sketch.html#a5a2b7a58dc85678d08752945ff655362">is_empty</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  uint64_t <a class="code" href="classdatasketches_1_1density__sketch.html#af857be9469a7565252626f27e1f9d74d">get_n</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  uint32_t <a class="code" href="classdatasketches_1_1density__sketch.html#a31fa76458d81a17dbebfcb828e531f14">get_num_retained</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  </div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">bool</span> <a class="code" href="classdatasketches_1_1density__sketch.html#ae95a04b1d7dccb3d9b3f3c3d087aa8e6">is_estimation_mode</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keyword">template</span><<span class="keyword">typename</span> FwdVector></div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1density__sketch.html#a5e26f9aae4a59c1345549f9ce512d253">update</a>(FwdVector&& point);</div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  </div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">template</span><<span class="keyword">typename</span> FwdSketch></div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1density__sketch.html#a1defe87981c9505d416392690b3125c6">merge</a>(FwdSketch&& other);</div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  </div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  T <a class="code" href="classdatasketches_1_1density__sketch.html#a1ae5f35215393f3272f1b284ec782ef5">get_estimate</a>(<span class="keyword">const</span> std::vector<T>& point) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  </div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  Allocator <a class="code" href="classdatasketches_1_1density__sketch.html#a9d85cf47c4ecd0580ec623c42006dd1b">get_allocator</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div> |
| <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1density__sketch.html#a1bcdd98ee6e6eb9b501b8dc5de5e8924">serialize</a>(std::ostream& os) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  </div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">using</span> vector_bytes = std::vector<uint8_t, typename std::allocator_traits<Allocator>::template rebind_alloc<uint8_t>>;</div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  </div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  vector_bytes <a class="code" href="classdatasketches_1_1density__sketch.html#a1bcdd98ee6e6eb9b501b8dc5de5e8924">serialize</a>(<span class="keywordtype">unsigned</span> header_size_bytes = 0) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  </div> |
| <div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="classdatasketches_1_1density__sketch.html#ae1111c0a71921687c58dd661a3c341e2"> 160</a></span>  <span class="keyword">static</span> <a class="code" href="classdatasketches_1_1density__sketch.html">density_sketch</a> <a class="code" href="classdatasketches_1_1density__sketch.html#ae1111c0a71921687c58dd661a3c341e2">deserialize</a>(std::istream& is,</div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keyword">const</span> Kernel& kernel=Kernel(), <span class="keyword">const</span> Allocator& allocator = Allocator());</div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  </div> |
| <div class="line"><a name="l00171"></a><span class="lineno"><a class="line" href="classdatasketches_1_1density__sketch.html#a1efc2f9373fce7d3ea1b8654b3d862a7"> 171</a></span>  <span class="keyword">static</span> <a class="code" href="classdatasketches_1_1density__sketch.html">density_sketch</a> <a class="code" href="classdatasketches_1_1density__sketch.html#a1efc2f9373fce7d3ea1b8654b3d862a7">deserialize</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* bytes, <span class="keywordtype">size_t</span> size,</div> |
| <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keyword">const</span> Kernel& kernel=Kernel(), <span class="keyword">const</span> Allocator& allocator = Allocator());</div> |
| <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  </div> |
| <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  string<Allocator> <a class="code" href="classdatasketches_1_1density__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="l00180"></a><span class="lineno"> 180</span>  </div> |
| <div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keyword">class </span>const_iterator;</div> |
| <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  </div> |
| <div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  const_iterator <a class="code" href="classdatasketches_1_1density__sketch.html#ad5c959a538216a09ab28c5283585956c">begin</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  </div> |
| <div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  const_iterator <a class="code" href="classdatasketches_1_1density__sketch.html#ae11e60e117300685401961e36f196f7a">end</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  </div> |
| <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="keyword">enum</span> flags { RESERVED0, RESERVED1, IS_EMPTY };</div> |
| <div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t PREAMBLE_INTS_SHORT = 3;</div> |
| <div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t PREAMBLE_INTS_LONG = 6;</div> |
| <div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FAMILY_ID = 19;</div> |
| <div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t SERIAL_VERSION = 1;</div> |
| <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> LEVELS_ARRAY_START = 5;</div> |
| <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  </div> |
| <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  Allocator allocator_;</div> |
| <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  Kernel kernel_;</div> |
| <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  uint16_t k_;</div> |
| <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  uint32_t dim_;</div> |
| <div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  uint32_t num_retained_;</div> |
| <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  uint64_t n_;</div> |
| <div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  Levels levels_;</div> |
| <div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  </div> |
| <div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="keywordtype">void</span> compact();</div> |
| <div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keywordtype">void</span> compact_level(<span class="keywordtype">unsigned</span> height);</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="keyword">static</span> <span class="keywordtype">void</span> check_k(uint16_t k);</div> |
| <div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_serial_version(uint8_t serial_version);</div> |
| <div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_family_id(uint8_t family_id);</div> |
| <div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_header_validity(uint8_t preamble_ints, uint8_t flags_byte, uint8_t serial_version);</div> |
| <div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  </div> |
| <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <a class="code" href="classdatasketches_1_1density__sketch.html#a08daaa6a0d62a61b612a0dbbbd0b22d5">density_sketch</a>(uint16_t k, uint32_t dim, uint32_t num_retained, uint64_t n, Levels&& levels,</div> |
| <div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="keyword">const</span> Kernel& kernel = Kernel());</div> |
| <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> };</div> |
| <div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  </div> |
| <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="keyword">template</span><<span class="keyword">typename</span> T, <span class="keyword">typename</span> K, <span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="keyword">class </span>density_sketch<T, K, A>::const_iterator {</div> |
| <div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <span class="keyword">using</span> Vector = density_sketch<T, K, A>::Vector;</div> |
| <div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="keyword">using</span> iterator_category = std::input_iterator_tag;</div> |
| <div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="keyword">using</span> value_type = std::pair<const Vector&, const uint64_t>;</div> |
| <div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="keyword">using</span> difference_type = void;</div> |
| <div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keyword">using</span> pointer = return_value_holder<value_type>;</div> |
| <div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <span class="keyword">using</span> reference = <span class="keyword">const</span> value_type;</div> |
| <div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  const_iterator& operator++();</div> |
| <div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  const_iterator& operator++(<span class="keywordtype">int</span>);</div> |
| <div class="line"><a name="l00237"></a><span class="lineno"> 237</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="l00238"></a><span class="lineno"> 238</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="l00239"></a><span class="lineno"> 239</span>  <span class="keyword">const</span> value_type operator*() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keyword">const</span> return_value_holder<value_type> operator->() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="keyword">using</span> LevelsIterator = <span class="keyword">typename</span> density_sketch<T, K, A>::Levels::const_iterator;</div> |
| <div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <span class="keyword">using</span> LevelIterator = <span class="keyword">typename</span> density_sketch<T, K, A>::Level::const_iterator;</div> |
| <div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  LevelsIterator levels_it_;</div> |
| <div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  LevelsIterator levels_end_;</div> |
| <div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  LevelIterator level_it_;</div> |
| <div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  <span class="keywordtype">unsigned</span> height_;</div> |
| <div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1density__sketch.html#a08daaa6a0d62a61b612a0dbbbd0b22d5">density_sketch</a><T, K, A>;</div> |
| <div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  const_iterator(LevelsIterator <a class="code" href="classdatasketches_1_1density__sketch.html#ad5c959a538216a09ab28c5283585956c">begin</a>, LevelsIterator <a class="code" href="classdatasketches_1_1density__sketch.html#ae11e60e117300685401961e36f196f7a">end</a>);</div> |
| <div class="line"><a name="l00250"></a><span class="lineno"> 250</span> };</div> |
| <div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  </div> |
| <div class="line"><a name="l00252"></a><span class="lineno"> 252</span> } <span class="comment">/* namespace datasketches */</span></div> |
| <div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  </div> |
| <div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="preprocessor">#include "density_sketch_impl.hpp"</span></div> |
| <div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  </div> |
| <div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="preprocessor">#endif</span></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html">datasketches::density_sketch</a></div><div class="ttdoc">Density sketch.</div><div class="ttdef"><b>Definition:</b> density_sketch.hpp:57</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_a08daaa6a0d62a61b612a0dbbbd0b22d5"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#a08daaa6a0d62a61b612a0dbbbd0b22d5">datasketches::density_sketch::density_sketch</a></div><div class="ttdeci">density_sketch(uint16_t k, uint32_t dim, const Kernel &kernel=Kernel(), const Allocator &allocator=Allocator())</div><div class="ttdoc">Constructor.</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_a1ae5f35215393f3272f1b284ec782ef5"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#a1ae5f35215393f3272f1b284ec782ef5">datasketches::density_sketch::get_estimate</a></div><div class="ttdeci">T get_estimate(const std::vector< T > &point) const</div><div class="ttdoc">Density estimate at a given point.</div><div class="ttdef"><b>Definition:</b> density_sketch_impl.hpp:115</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_a1bcdd98ee6e6eb9b501b8dc5de5e8924"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#a1bcdd98ee6e6eb9b501b8dc5de5e8924">datasketches::density_sketch::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> density_sketch_impl.hpp:184</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_a1defe87981c9505d416392690b3125c6"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#a1defe87981c9505d416392690b3125c6">datasketches::density_sketch::merge</a></div><div class="ttdeci">void merge(FwdSketch &&other)</div><div class="ttdoc">Merges another sketch into this one.</div><div class="ttdef"><b>Definition:</b> density_sketch_impl.hpp:98</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_a1efc2f9373fce7d3ea1b8654b3d862a7"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#a1efc2f9373fce7d3ea1b8654b3d862a7">datasketches::density_sketch::deserialize</a></div><div class="ttdeci">static density_sketch deserialize(const void *bytes, size_t size, const Kernel &kernel=Kernel(), const Allocator &allocator=Allocator())</div><div class="ttdoc">This method deserializes a sketch from a given array of bytes.</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_a31fa76458d81a17dbebfcb828e531f14"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#a31fa76458d81a17dbebfcb828e531f14">datasketches::density_sketch::get_num_retained</a></div><div class="ttdeci">uint32_t get_num_retained() const</div><div class="ttdoc">Returns the number of retained points in the sketch.</div><div class="ttdef"><b>Definition:</b> density_sketch_impl.hpp:77</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_a57bff8d89cd2bde903090aa30208f610"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#a57bff8d89cd2bde903090aa30208f610">datasketches::density_sketch::get_dim</a></div><div class="ttdeci">uint32_t get_dim() const</div><div class="ttdoc">Returns configured dimensions.</div><div class="ttdef"><b>Definition:</b> density_sketch_impl.hpp:62</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_a592a7af55659ff803b26a45552a68dda"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#a592a7af55659ff803b26a45552a68dda">datasketches::density_sketch::to_string</a></div><div class="ttdeci">string< Allocator > 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> density_sketch_impl.hpp:420</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_a59f4c39b9f2e762e8e3445ef89e1d264"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#a59f4c39b9f2e762e8e3445ef89e1d264">datasketches::density_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> density_sketch_impl.hpp:57</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_a5a2b7a58dc85678d08752945ff655362"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#a5a2b7a58dc85678d08752945ff655362">datasketches::density_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> density_sketch_impl.hpp:67</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_a5e26f9aae4a59c1345549f9ce512d253"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#a5e26f9aae4a59c1345549f9ce512d253">datasketches::density_sketch::update</a></div><div class="ttdeci">void update(FwdVector &&point)</div><div class="ttdoc">Updates this sketch with a given point.</div><div class="ttdef"><b>Definition:</b> density_sketch_impl.hpp:88</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_a9d85cf47c4ecd0580ec623c42006dd1b"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#a9d85cf47c4ecd0580ec623c42006dd1b">datasketches::density_sketch::get_allocator</a></div><div class="ttdeci">Allocator get_allocator() const</div><div class="ttdoc">Returns an instance of the allocator for this sketch.</div><div class="ttdef"><b>Definition:</b> density_sketch_impl.hpp:127</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_ad5c959a538216a09ab28c5283585956c"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#ad5c959a538216a09ab28c5283585956c">datasketches::density_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> density_sketch_impl.hpp:468</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_ae1111c0a71921687c58dd661a3c341e2"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#ae1111c0a71921687c58dd661a3c341e2">datasketches::density_sketch::deserialize</a></div><div class="ttdeci">static density_sketch deserialize(std::istream &is, const Kernel &kernel=Kernel(), const Allocator &allocator=Allocator())</div><div class="ttdoc">This method deserializes a sketch from a given stream.</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_ae11e60e117300685401961e36f196f7a"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#ae11e60e117300685401961e36f196f7a">datasketches::density_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> density_sketch_impl.hpp:473</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_ae95a04b1d7dccb3d9b3f3c3d087aa8e6"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#ae95a04b1d7dccb3d9b3f3c3d087aa8e6">datasketches::density_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> density_sketch_impl.hpp:82</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1density__sketch_html_af857be9469a7565252626f27e1f9d74d"><div class="ttname"><a href="classdatasketches_1_1density__sketch.html#af857be9469a7565252626f27e1f9d74d">datasketches::density_sketch::get_n</a></div><div class="ttdeci">uint64_t get_n() const</div><div class="ttdoc">Returns the length of the input stream (number of points observed by this sketch).</div><div class="ttdef"><b>Definition:</b> density_sketch_impl.hpp:72</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> |
