| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>datasketches-cpp: theta/include/theta_intersection.hpp Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">datasketches-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_e96b5dfe115c13cdeb36484e37aec42e.html">theta</a></li><li class="navelem"><a class="el" href="dir_3f8742d40c9573c3b90638004faf146b.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">theta_intersection.hpp</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef THETA_INTERSECTION_HPP_</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define THETA_INTERSECTION_HPP_</span></div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include "theta_sketch.hpp"</span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include "theta_intersection_base.hpp"</span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacedatasketches.html">datasketches</a> {</div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">// forward declaration</span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">template</span><<span class="keyword">typename</span> A> <span class="keyword">class </span>theta_intersection_alloc;</div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment">// alias with default allocator for convenience</span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">using </span>theta_intersection = theta_intersection_alloc<std::allocator<uint64_t>>;</div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">template</span><<span class="keyword">typename</span> Allocator = std::allocator<u<span class="keywordtype">int</span>64_t>></div> |
| <div class="foldopen" id="foldopen00039" data-start="{" data-end="};"> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classdatasketches_1_1theta__intersection__alloc.html"> 39</a></span><span class="keyword">class </span><a class="code hl_class" href="classdatasketches_1_1theta__intersection__alloc.html">theta_intersection_alloc</a> {</div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">using </span>Entry = uint64_t;</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">using </span>ExtractKey = trivial_extract_key;</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">using </span><a class="code hl_class" href="classdatasketches_1_1theta__sketch__alloc.html">Sketch</a> = <a class="code hl_class" href="classdatasketches_1_1theta__sketch__alloc.html">theta_sketch_alloc<Allocator></a>;</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">using </span><a class="code hl_class" href="classdatasketches_1_1compact__theta__sketch__alloc.html">CompactSketch</a> = <a class="code hl_class" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc<Allocator></a>;</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// there is no payload in Theta sketch entry</span></div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">struct </span>nop_policy {</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">void</span> operator()(uint64_t internal_entry, uint64_t incoming_entry)<span class="keyword"> const </span>{</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> unused(incoming_entry);</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> unused(internal_entry);</div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> }</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> };</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">using </span>State = theta_intersection_base<Entry, ExtractKey, nop_policy, Sketch, CompactSketch, Allocator>;</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classdatasketches_1_1theta__intersection__alloc.html">theta_intersection_alloc</a>(uint64_t seed = DEFAULT_SEED, <span class="keyword">const</span> Allocator& allocator = Allocator());</div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">template</span><<span class="keyword">typename</span> FwdSketch></div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classdatasketches_1_1theta__intersection__alloc.html#a4fac8167b04c9b5dbaeb5ccbd053703c">update</a>(FwdSketch&& sketch);</div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <a class="code hl_class" href="classdatasketches_1_1compact__theta__sketch__alloc.html">CompactSketch</a> <a class="code hl_function" href="classdatasketches_1_1theta__intersection__alloc.html#a037835e8f8e6b5233fa0f0996bba6a99">get_result</a>(<span class="keywordtype">bool</span> ordered = <span class="keyword">true</span>) <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classdatasketches_1_1theta__intersection__alloc.html#a4ef54f76786bbe6e50c2597943874de3">has_result</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> State state_;</div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>};</div> |
| </div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span>} <span class="comment">/* namespace datasketches */</span></div> |
| <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="preprocessor">#include "theta_intersection_impl.hpp"</span></div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="preprocessor">#endif</span></div> |
| <div class="ttc" id="aclassdatasketches_1_1compact__theta__sketch__alloc_html"><div class="ttname"><a href="classdatasketches_1_1compact__theta__sketch__alloc.html">datasketches::compact_theta_sketch_alloc</a></div><div class="ttdoc">Compact Theta sketch.</div><div class="ttdef"><b>Definition</b> theta_sketch.hpp:359</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1theta__intersection__alloc_html"><div class="ttname"><a href="classdatasketches_1_1theta__intersection__alloc.html">datasketches::theta_intersection_alloc</a></div><div class="ttdoc">Theta intersection.</div><div class="ttdef"><b>Definition</b> theta_intersection.hpp:39</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1theta__intersection__alloc_html_a037835e8f8e6b5233fa0f0996bba6a99"><div class="ttname"><a href="classdatasketches_1_1theta__intersection__alloc.html#a037835e8f8e6b5233fa0f0996bba6a99">datasketches::theta_intersection_alloc::get_result</a></div><div class="ttdeci">CompactSketch get_result(bool ordered=true) const</div><div class="ttdoc">Produces a copy of the current state of the intersection.</div><div class="ttdef"><b>Definition</b> theta_intersection_impl.hpp:37</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1theta__intersection__alloc_html_a4ef54f76786bbe6e50c2597943874de3"><div class="ttname"><a href="classdatasketches_1_1theta__intersection__alloc.html#a4ef54f76786bbe6e50c2597943874de3">datasketches::theta_intersection_alloc::has_result</a></div><div class="ttdeci">bool has_result() const</div><div class="ttdoc">Returns true if the state of the intersection is defined (not infinite "universe").</div><div class="ttdef"><b>Definition</b> theta_intersection_impl.hpp:42</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1theta__intersection__alloc_html_a4fac8167b04c9b5dbaeb5ccbd053703c"><div class="ttname"><a href="classdatasketches_1_1theta__intersection__alloc.html#a4fac8167b04c9b5dbaeb5ccbd053703c">datasketches::theta_intersection_alloc::update</a></div><div class="ttdeci">void update(FwdSketch &&sketch)</div><div class="ttdoc">Updates the intersection with a given sketch.</div><div class="ttdef"><b>Definition</b> theta_intersection_impl.hpp:32</div></div> |
| <div class="ttc" id="aclassdatasketches_1_1theta__sketch__alloc_html"><div class="ttname"><a href="classdatasketches_1_1theta__sketch__alloc.html">datasketches::theta_sketch_alloc</a></div><div class="ttdoc">Base class for the Theta Sketch, a generalization of the Kth Minimum Value (KMV) sketch.</div><div class="ttdef"><b>Definition</b> theta_sketch.hpp:127</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.8 |
| </small></address> |
| </body> |
| </html> |
