blob: 729638a7dd4dd61269516e489e3f57d15c1edc52 [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_a_not_b&lt; Array, 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__a__not__b.html">array_tuple_a_not_b</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__a__not__b-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">array_tuple_a_not_b&lt; Array, Allocator &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>array tuple A-not-B
<a href="classdatasketches_1_1array__tuple__a__not__b.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="array__tuple__a__not__b_8hpp_source.html">array_tuple_a_not_b.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for array_tuple_a_not_b&lt; Array, Allocator &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classdatasketches_1_1array__tuple__a__not__b.png" usemap="#array_5Ftuple_5Fa_5Fnot_5Fb_3C_20Array_2C_20Allocator_20_3E_map" alt=""/>
<map id="array_5Ftuple_5Fa_5Fnot_5Fb_3C_20Array_2C_20Allocator_20_3E_map" name="array_5Ftuple_5Fa_5Fnot_5Fb_3C_20Array_2C_20Allocator_20_3E_map">
<area href="classdatasketches_1_1tuple__a__not__b.html" alt="tuple_a_not_b&lt; Array, typename Array::allocator_type &gt;" shape="rect" coords="0,0,335,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:afc12166e05f904485a0fd4fe84436336"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1array__tuple__a__not__b.html#afc12166e05f904485a0fd4fe84436336">array_tuple_a_not_b</a> (uint64_t seed=DEFAULT_SEED, const Allocator &amp;allocator=Allocator())</td></tr>
<tr class="memdesc:afc12166e05f904485a0fd4fe84436336"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classdatasketches_1_1array__tuple__a__not__b.html#afc12166e05f904485a0fd4fe84436336">More...</a><br /></td></tr>
<tr class="separator:afc12166e05f904485a0fd4fe84436336"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ee0c8ec70c980979f84c68065da3d9b"><td class="memTemplParams" colspan="2">template&lt;typename FwdSketch , typename Sketch &gt; </td></tr>
<tr class="memitem:a3ee0c8ec70c980979f84c68065da3d9b"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1compact__array__tuple__sketch.html">CompactSketch</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1array__tuple__a__not__b.html#a3ee0c8ec70c980979f84c68065da3d9b">compute</a> (FwdSketch &amp;&amp;a, const Sketch &amp;b, bool ordered=true) const</td></tr>
<tr class="memdesc:a3ee0c8ec70c980979f84c68065da3d9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the A-not-B set operation given two sketches. <a href="classdatasketches_1_1array__tuple__a__not__b.html#a3ee0c8ec70c980979f84c68065da3d9b">More...</a><br /></td></tr>
<tr class="separator:a3ee0c8ec70c980979f84c68065da3d9b"><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 Allocator = typename Array::allocator_type&gt;<br />
class datasketches::array_tuple_a_not_b&lt; Array, Allocator &gt;</h3>
<p>array tuple A-not-B </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="afc12166e05f904485a0fd4fe84436336"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc12166e05f904485a0fd4fe84436336">&#9670;&nbsp;</a></span>array_tuple_a_not_b()</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__a__not__b.html">array_tuple_a_not_b</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 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">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="a3ee0c8ec70c980979f84c68065da3d9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ee0c8ec70c980979f84c68065da3d9b">&#9670;&nbsp;</a></span>compute()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdatasketches_1_1compact__array__tuple__sketch.html">CompactSketch</a> compute </td>
<td>(</td>
<td class="paramtype">FwdSketch &amp;&amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Sketch &amp;&#160;</td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>ordered</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Computes the A-not-B set operation given two sketches. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>sketch A </td></tr>
<tr><td class="paramname">b</td><td>sketch B </td></tr>
<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 A-not-B 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__a__not__b_8hpp_source.html">array_tuple_a_not_b.hpp</a></li>
<li>tuple/include/<a class="el" href="array__tuple__a__not__b__impl_8hpp_source.html">array_tuple_a_not_b_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>