Google Git
Sign in
apache / datasketches-cpp / 13384f8d3b370ee394a2e4678bb2b49cd8e0e98f / . / docs / master / classdatasketches_1_1array__tuple__intersection.html
blob: 177a66181beb506b18034f51cf6e67b98398bbcc [file] [log] [blame]
<!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: array_tuple_intersection&lt; Array, Policy, Allocator &gt; 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&amp;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&amp;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_1array__tuple__intersection.html">array_tuple_intersection</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classdatasketches_1_1array__tuple__intersection-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">array_tuple_intersection&lt; Array, Policy, Allocator &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>array tuple intersection
<a href="classdatasketches_1_1array__tuple__intersection.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="array__tuple__intersection_8hpp_source.html">array_tuple_intersection.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for array_tuple_intersection&lt; Array, Policy, Allocator &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classdatasketches_1_1array__tuple__intersection.png" usemap="#array_5Ftuple_5Fintersection_3C_20Array_2C_20Policy_2C_20Allocator_20_3E_map" alt=""/>
<map id="array_5Ftuple_5Fintersection_3C_20Array_2C_20Policy_2C_20Allocator_20_3E_map" name="array_5Ftuple_5Fintersection_3C_20Array_2C_20Policy_2C_20Allocator_20_3E_map">
<area href="classdatasketches_1_1tuple__intersection.html" alt="tuple_intersection&lt; Array, Policy, typename Array::allocator_type &gt;" shape="rect" coords="0,0,399,24"/>
</map>
</div></div>
<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:af032c7e2eeeafda87bf316647465ba4a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1array__tuple__intersection.html#af032c7e2eeeafda87bf316647465ba4a">array_tuple_intersection</a> (uint64_t seed=DEFAULT_SEED, const Policy &amp;policy=Policy(), const Allocator &amp;allocator=Allocator())</td></tr>
<tr class="memdesc:af032c7e2eeeafda87bf316647465ba4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classdatasketches_1_1array__tuple__intersection.html#af032c7e2eeeafda87bf316647465ba4a">More...</a><br /></td></tr>
<tr class="separator:af032c7e2eeeafda87bf316647465ba4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a037835e8f8e6b5233fa0f0996bba6a99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1compact__array__tuple__sketch.html">CompactSketch</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1array__tuple__intersection.html#a037835e8f8e6b5233fa0f0996bba6a99">get_result</a> (bool ordered=true) const</td></tr>
<tr class="memdesc:a037835e8f8e6b5233fa0f0996bba6a99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Produces a copy of the current state of the intersection. <a href="classdatasketches_1_1array__tuple__intersection.html#a037835e8f8e6b5233fa0f0996bba6a99">More...</a><br /></td></tr>
<tr class="separator:a037835e8f8e6b5233fa0f0996bba6a99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classdatasketches_1_1tuple__intersection"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classdatasketches_1_1tuple__intersection')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classdatasketches_1_1tuple__intersection.html">tuple_intersection&lt; Array, Policy, typename Array::allocator_type &gt;</a></td></tr>
<tr class="memitem:a4cff2978362ac6d1c74a1a69c3b3843f inherit pub_methods_classdatasketches_1_1tuple__intersection"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__intersection.html#a4cff2978362ac6d1c74a1a69c3b3843f">tuple_intersection</a> (uint64_t seed=DEFAULT_SEED, const Policy &amp;policy=Policy(), const typename Array::allocator_type &amp;allocator=typename Array::allocator_type())</td></tr>
<tr class="memdesc:a4cff2978362ac6d1c74a1a69c3b3843f inherit pub_methods_classdatasketches_1_1tuple__intersection"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classdatasketches_1_1tuple__intersection.html#a4cff2978362ac6d1c74a1a69c3b3843f">More...</a><br /></td></tr>
<tr class="separator:a4cff2978362ac6d1c74a1a69c3b3843f inherit pub_methods_classdatasketches_1_1tuple__intersection"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fac8167b04c9b5dbaeb5ccbd053703c inherit pub_methods_classdatasketches_1_1tuple__intersection"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__intersection.html#a4fac8167b04c9b5dbaeb5ccbd053703c">update</a> (FwdSketch &amp;&amp;sketch)</td></tr>
<tr class="memdesc:a4fac8167b04c9b5dbaeb5ccbd053703c inherit pub_methods_classdatasketches_1_1tuple__intersection"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the intersection with a given sketch. <a href="classdatasketches_1_1tuple__intersection.html#a4fac8167b04c9b5dbaeb5ccbd053703c">More...</a><br /></td></tr>
<tr class="separator:a4fac8167b04c9b5dbaeb5ccbd053703c inherit pub_methods_classdatasketches_1_1tuple__intersection"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a037835e8f8e6b5233fa0f0996bba6a99 inherit pub_methods_classdatasketches_1_1tuple__intersection"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">CompactSketch</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__intersection.html#a037835e8f8e6b5233fa0f0996bba6a99">get_result</a> (bool ordered=true) const</td></tr>
<tr class="memdesc:a037835e8f8e6b5233fa0f0996bba6a99 inherit pub_methods_classdatasketches_1_1tuple__intersection"><td class="mdescLeft">&#160;</td><td class="mdescRight">Produces a copy of the current state of the intersection. <a href="classdatasketches_1_1tuple__intersection.html#a037835e8f8e6b5233fa0f0996bba6a99">More...</a><br /></td></tr>
<tr class="separator:a037835e8f8e6b5233fa0f0996bba6a99 inherit pub_methods_classdatasketches_1_1tuple__intersection"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ef54f76786bbe6e50c2597943874de3 inherit pub_methods_classdatasketches_1_1tuple__intersection"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__intersection.html#a4ef54f76786bbe6e50c2597943874de3">has_result</a> () const</td></tr>
<tr class="memdesc:a4ef54f76786bbe6e50c2597943874de3 inherit pub_methods_classdatasketches_1_1tuple__intersection"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the state of the intersection is defined (not infinite "universe"). <a href="classdatasketches_1_1tuple__intersection.html#a4ef54f76786bbe6e50c2597943874de3">More...</a><br /></td></tr>
<tr class="separator:a4ef54f76786bbe6e50c2597943874de3 inherit pub_methods_classdatasketches_1_1tuple__intersection"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Array, typename Policy, typename Allocator = typename Array::allocator_type&gt;<br />
class datasketches::array_tuple_intersection&lt; Array, Policy, Allocator &gt;</h3>
<p>array tuple intersection </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af032c7e2eeeafda87bf316647465ba4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af032c7e2eeeafda87bf316647465ba4a">&#9670;&nbsp;</a></span>array_tuple_intersection()</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_1array__tuple__intersection.html">array_tuple_intersection</a> </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>seed</em> = <code>DEFAULT_SEED</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Policy &amp;&#160;</td>
<td class="paramname"><em>policy</em> = <code>Policy()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Allocator &amp;&#160;</td>
<td class="paramname"><em>allocator</em> = <code>Allocator()</code>&#160;</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">policy</td><td>user-defined way of combining Summary during intersection </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="a037835e8f8e6b5233fa0f0996bba6a99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a037835e8f8e6b5233fa0f0996bba6a99">&#9670;&nbsp;</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&#160;</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_1tuple__intersection.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 as a compact sketch </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>tuple/include/<a class="el" href="array__tuple__intersection_8hpp_source.html">array_tuple_intersection.hpp</a></li>
<li>tuple/include/<a class="el" href="array__tuple__intersection__impl_8hpp_source.html">array_tuple_intersection_impl.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>