| <!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: theta_intersection_alloc< Allocator > Class Template Reference</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="namespacedatasketches.html">datasketches</a></li><li class="navelem"><a class="el" href="classdatasketches_1_1theta__intersection__alloc.html">theta_intersection_alloc</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classdatasketches_1_1theta__intersection__alloc-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">theta_intersection_alloc< Allocator > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Theta intersection. |
| <a href="classdatasketches_1_1theta__intersection__alloc.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="theta__intersection_8hpp_source.html">theta_intersection.hpp</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a47ac95e76c9f21fb19108e3ab9c21012"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__intersection__alloc.html#a47ac95e76c9f21fb19108e3ab9c21012">theta_intersection_alloc</a> (uint64_t seed=DEFAULT_SEED, const Allocator &allocator=Allocator())</td></tr> |
| <tr class="memdesc:a47ac95e76c9f21fb19108e3ab9c21012"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classdatasketches_1_1theta__intersection__alloc.html#a47ac95e76c9f21fb19108e3ab9c21012">More...</a><br /></td></tr> |
| <tr class="separator:a47ac95e76c9f21fb19108e3ab9c21012"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4fac8167b04c9b5dbaeb5ccbd053703c"><td class="memTemplParams" colspan="2">template<typename FwdSketch > </td></tr> |
| <tr class="memitem:a4fac8167b04c9b5dbaeb5ccbd053703c"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__intersection__alloc.html#a4fac8167b04c9b5dbaeb5ccbd053703c">update</a> (FwdSketch &&sketch)</td></tr> |
| <tr class="memdesc:a4fac8167b04c9b5dbaeb5ccbd053703c"><td class="mdescLeft"> </td><td class="mdescRight">Updates the intersection with a given sketch. <a href="classdatasketches_1_1theta__intersection__alloc.html#a4fac8167b04c9b5dbaeb5ccbd053703c">More...</a><br /></td></tr> |
| <tr class="separator:a4fac8167b04c9b5dbaeb5ccbd053703c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a037835e8f8e6b5233fa0f0996bba6a99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">CompactSketch</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__intersection__alloc.html#a037835e8f8e6b5233fa0f0996bba6a99">get_result</a> (bool ordered=true) const</td></tr> |
| <tr class="memdesc:a037835e8f8e6b5233fa0f0996bba6a99"><td class="mdescLeft"> </td><td class="mdescRight">Produces a copy of the current state of the intersection. <a href="classdatasketches_1_1theta__intersection__alloc.html#a037835e8f8e6b5233fa0f0996bba6a99">More...</a><br /></td></tr> |
| <tr class="separator:a037835e8f8e6b5233fa0f0996bba6a99"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4ef54f76786bbe6e50c2597943874de3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__intersection__alloc.html#a4ef54f76786bbe6e50c2597943874de3">has_result</a> () const</td></tr> |
| <tr class="memdesc:a4ef54f76786bbe6e50c2597943874de3"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the state of the intersection is defined (not infinite "universe"). <a href="classdatasketches_1_1theta__intersection__alloc.html#a4ef54f76786bbe6e50c2597943874de3">More...</a><br /></td></tr> |
| <tr class="separator:a4ef54f76786bbe6e50c2597943874de3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<typename Allocator = std::allocator<uint64_t>><br /> |
| class datasketches::theta_intersection_alloc< Allocator ></h3> |
| |
| <p>Theta intersection. </p> |
| <p>Computes intersection of Theta sketches. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a47ac95e76c9f21fb19108e3ab9c21012"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a47ac95e76c9f21fb19108e3ab9c21012">◆ </a></span>theta_intersection_alloc()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdatasketches_1_1theta__intersection__alloc.html">theta_intersection_alloc</a> </td> |
| <td>(</td> |
| <td class="paramtype">uint64_t </td> |
| <td class="paramname"><em>seed</em> = <code>DEFAULT_SEED</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const Allocator & </td> |
| <td class="paramname"><em>allocator</em> = <code>Allocator()</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">seed</td><td>for the hash function that was used to create the sketch </td></tr> |
| <tr><td class="paramname">allocator</td><td>to use for allocating and deallocating memory </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a4fac8167b04c9b5dbaeb5ccbd053703c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4fac8167b04c9b5dbaeb5ccbd053703c">◆ </a></span>update()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void update </td> |
| <td>(</td> |
| <td class="paramtype">FwdSketch && </td> |
| <td class="paramname"><em>sketch</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Updates the intersection with a given sketch. </p> |
| <p>The intersection can be viewed as starting from the "universe" set, and every update can reduce the current set to leave the overlapping subset only. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">sketch</td><td>represents input set for the intersection </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a037835e8f8e6b5233fa0f0996bba6a99"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a037835e8f8e6b5233fa0f0996bba6a99">◆ </a></span>get_result()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">auto get_result </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>ordered</em> = <code>true</code></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Produces a copy of the current state of the intersection. </p> |
| <p>If <a class="el" href="classdatasketches_1_1theta__intersection__alloc.html#a4fac8167b04c9b5dbaeb5ccbd053703c" title="Updates the intersection with a given sketch.">update()</a> was not called, the state is the infinite "universe", which is considered an undefined state, and throws an exception. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ordered</td><td>optional flag to specify if an ordered sketch should be produced </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the result of the intersection </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a4ef54f76786bbe6e50c2597943874de3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4ef54f76786bbe6e50c2597943874de3">◆ </a></span>has_result()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool has_result</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns true if the state of the intersection is defined (not infinite "universe"). </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if the state is valid </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>theta/include/<a class="el" href="theta__intersection_8hpp_source.html">theta_intersection.hpp</a></li> |
| <li>theta/include/<a class="el" href="theta__intersection__impl_8hpp_source.html">theta_intersection_impl.hpp</a></li> |
| </ul> |
| </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> |
