| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>datasketches-cpp: cpc/include/cpc_union.hpp Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">datasketches-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_82f3a10095a8f2296c0cf5c491a57b02.html">cpc</a></li><li class="navelem"><a class="el" href="dir_fabb7854c43508dcbf81254d1daad42f.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">cpc_union.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * under the License.</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef CPC_UNION_HPP_</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define CPC_UNION_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 <string></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "cpc_sketch.hpp"</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>  </div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespacedatasketches.html">datasketches</a> {</div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div> |
| <div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="namespacedatasketches.html#ae1a38b6677f3d0d4f9b3e310413aa395"> 31</a></span> <span class="keyword">using</span> <a class="code" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union</a> = <a class="code" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc<std::allocator<uint8_t></a>>;</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">template</span><<span class="keyword">typename</span> A></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classdatasketches_1_1cpc__union__alloc.html"> 40</a></span> <span class="keyword">class </span><a class="code" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a> {</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</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="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">using</span> vector_u64 = std::vector<uint64_t, typename std::allocator_traits<A>::template rebind_alloc<uint64_t>>;</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">explicit</span> <a class="code" href="classdatasketches_1_1cpc__union__alloc.html#a7d54d46a338588afe9fb768cb0e22082">cpc_union_alloc</a>(uint8_t lg_k = <a class="code" href="namespacedatasketches_1_1cpc__constants.html#a78468167a70640384c2de5e04fabe4fd">cpc_constants::DEFAULT_LG_K</a>, uint64_t seed = DEFAULT_SEED, <span class="keyword">const</span> A& allocator = A());</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classdatasketches_1_1cpc__union__alloc.html#a7d54d46a338588afe9fb768cb0e22082">cpc_union_alloc</a>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc<A></a>& other);</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classdatasketches_1_1cpc__union__alloc.html#a7d54d46a338588afe9fb768cb0e22082">cpc_union_alloc</a>(<a class="code" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc<A></a>&& other) noexcept;</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  ~<a class="code" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a>();</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc<A></a>& <a class="code" href="classdatasketches_1_1cpc__union__alloc.html#ae7b219e0931e711ebea10684e30cb538">operator=</a>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc<A></a>& other);</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc<A></a>& <a class="code" href="classdatasketches_1_1cpc__union__alloc.html#ae7b219e0931e711ebea10684e30cb538">operator=</a>(<a class="code" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc<A></a>&& other) noexcept;</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__union__alloc.html#a3f9778e8f70f04ba8fbb0e1ccacc9fea">update</a>(<span class="keyword">const</span> <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc<A></a>& sketch);</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">void</span> <a class="code" href="classdatasketches_1_1cpc__union__alloc.html#a3f9778e8f70f04ba8fbb0e1ccacc9fea">update</a>(<a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc<A></a>&& sketch);</div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc<A></a> <a class="code" href="classdatasketches_1_1cpc__union__alloc.html#a5ea0b7d39e7f95016af67975b743ec8b">get_result</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">using</span> AllocU8 = <span class="keyword">typename</span> std::allocator_traits<A>::template rebind_alloc<uint8_t>;</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">using</span> AllocU64 = <span class="keyword">typename</span> std::allocator_traits<A>::template rebind_alloc<uint64_t>;</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">using</span> AllocCpc = <span class="keyword">typename</span> std::allocator_traits<A>::template rebind_alloc<cpc_sketch_alloc<A>>;</div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  </div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  uint8_t lg_k;</div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  uint64_t seed;</div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc<A></a>* accumulator;</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  vector_u64 bit_matrix;</div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">template</span><<span class="keyword">typename</span> S> <span class="keywordtype">void</span> internal_update(S&& sketch); <span class="comment">// to support both rvalue and lvalue</span></div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc<A></a> get_result_from_accumulator() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="code" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc<A></a> get_result_from_bit_matrix() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">void</span> switch_to_bit_matrix();</div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">void</span> walk_table_updating_sketch(<span class="keyword">const</span> u32_table<A>& table);</div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">void</span> or_table_into_matrix(<span class="keyword">const</span> u32_table<A>& table);</div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">void</span> or_window_into_matrix(<span class="keyword">const</span> vector_bytes& sliding_window, uint8_t offset, uint8_t src_lg_k);</div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">void</span> or_matrix_into_matrix(<span class="keyword">const</span> vector_u64& src_matrix, uint8_t src_lg_k);</div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">void</span> reduce_k(uint8_t new_lg_k);</div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> };</div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  </div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> } <span class="comment">/* namespace datasketches */</span></div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  </div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#include "cpc_union_impl.hpp"</span></div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  </div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor">#endif</span></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__sketch__alloc_html"><div class="ttname"><a href="classdatasketches_1_1cpc__sketch__alloc.html">datasketches::cpc_sketch_alloc</a></div><div class="ttdoc">High performance C++ implementation of Compressed Probabilistic Counting (CPC) Sketch.</div><div class="ttdef"><b>Definition:</b> cpc_sketch.hpp:64</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__union__alloc_html"><div class="ttname"><a href="classdatasketches_1_1cpc__union__alloc.html">datasketches::cpc_union_alloc</a></div><div class="ttdoc">High performance C++ implementation of Compressed Probabilistic Counting (CPC) Union.</div><div class="ttdef"><b>Definition:</b> cpc_union.hpp:40</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__union__alloc_html_a3f9778e8f70f04ba8fbb0e1ccacc9fea"><div class="ttname"><a href="classdatasketches_1_1cpc__union__alloc.html#a3f9778e8f70f04ba8fbb0e1ccacc9fea">datasketches::cpc_union_alloc::update</a></div><div class="ttdeci">void update(const cpc_sketch_alloc< A > &sketch)</div><div class="ttdoc">This method is to update the union with a given sketch (lvalue)</div><div class="ttdef"><b>Definition:</b> cpc_union_impl.hpp:93</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__union__alloc_html_a5ea0b7d39e7f95016af67975b743ec8b"><div class="ttname"><a href="classdatasketches_1_1cpc__union__alloc.html#a5ea0b7d39e7f95016af67975b743ec8b">datasketches::cpc_union_alloc::get_result</a></div><div class="ttdeci">cpc_sketch_alloc< A > get_result() const</div><div class="ttdoc">This method produces a copy of the current state of the union as a sketch.</div><div class="ttdef"><b>Definition:</b> cpc_union_impl.hpp:174</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__union__alloc_html_a7d54d46a338588afe9fb768cb0e22082"><div class="ttname"><a href="classdatasketches_1_1cpc__union__alloc.html#a7d54d46a338588afe9fb768cb0e22082">datasketches::cpc_union_alloc::cpc_union_alloc</a></div><div class="ttdeci">cpc_union_alloc(uint8_t lg_k=cpc_constants::DEFAULT_LG_K, uint64_t seed=DEFAULT_SEED, const A &allocator=A())</div><div class="ttdoc">Creates an instance of the union given the lg_k parameter and hash seed.</div><div class="ttdef"><b>Definition:</b> cpc_union_impl.hpp:30</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1cpc__union__alloc_html_ae7b219e0931e711ebea10684e30cb538"><div class="ttname"><a href="classdatasketches_1_1cpc__union__alloc.html#ae7b219e0931e711ebea10684e30cb538">datasketches::cpc_union_alloc::operator=</a></div><div class="ttdeci">cpc_union_alloc< A > & operator=(const cpc_union_alloc< A > &other)</div><div class="ttdoc">Copy assignment.</div><div class="ttdef"><b>Definition:</b> cpc_union_impl.hpp:74</div></div> |
| <div class="ttc" id="anamespacedatasketches_1_1cpc__constants_html_a78468167a70640384c2de5e04fabe4fd"><div class="ttname"><a href="namespacedatasketches_1_1cpc__constants.html#a78468167a70640384c2de5e04fabe4fd">datasketches::cpc_constants::DEFAULT_LG_K</a></div><div class="ttdeci">const uint8_t DEFAULT_LG_K</div><div class="ttdoc">default log2 of K</div><div class="ttdef"><b>Definition:</b> cpc_common.hpp:36</div></div> |
| <div class="ttc" id="anamespacedatasketches_html"><div class="ttname"><a href="namespacedatasketches.html">datasketches</a></div><div class="ttdoc">DataSketches namespace.</div><div class="ttdef"><b>Definition:</b> binomial_bounds.hpp:38</div></div> |
| </div><!-- 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> |
