blob: 7efb4e62f1e9c33d8b0a07e27b9b6fe21e44ec3c [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: theta_union_alloc&lt; 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_1theta__union__alloc.html">theta_union_alloc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classdatasketches_1_1theta__union__alloc-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">theta_union_alloc&lt; Allocator &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Theta Union.
<a href="classdatasketches_1_1theta__union__alloc.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="theta__union_8hpp_source.html">theta_union.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__union__alloc_1_1builder.html">builder</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Theta union builder. <a href="classdatasketches_1_1theta__union__alloc_1_1builder.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a4fac8167b04c9b5dbaeb5ccbd053703c"><td class="memTemplParams" colspan="2">template&lt;typename FwdSketch &gt; </td></tr>
<tr class="memitem:a4fac8167b04c9b5dbaeb5ccbd053703c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__union__alloc.html#a4fac8167b04c9b5dbaeb5ccbd053703c">update</a> (FwdSketch &amp;&amp;sketch)</td></tr>
<tr class="memdesc:a4fac8167b04c9b5dbaeb5ccbd053703c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update the union with a given sketch. <a href="classdatasketches_1_1theta__union__alloc.html#a4fac8167b04c9b5dbaeb5ccbd053703c">More...</a><br /></td></tr>
<tr class="separator:a4fac8167b04c9b5dbaeb5ccbd053703c"><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__theta__sketch__alloc.html">CompactSketch</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__union__alloc.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 union as a compact sketch. <a href="classdatasketches_1_1theta__union__alloc.html#a037835e8f8e6b5233fa0f0996bba6a99">More...</a><br /></td></tr>
<tr class="separator:a037835e8f8e6b5233fa0f0996bba6a99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad20897c5c8bd47f5d4005989bead0e55"><td class="memItemLeft" align="right" valign="top"><a id="ad20897c5c8bd47f5d4005989bead0e55"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__union__alloc.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a> ()</td></tr>
<tr class="memdesc:ad20897c5c8bd47f5d4005989bead0e55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the union to the initial empty state. <br /></td></tr>
<tr class="separator:ad20897c5c8bd47f5d4005989bead0e55"><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 Allocator = std::allocator&lt;uint64_t&gt;&gt;<br />
class datasketches::theta_union_alloc&lt; Allocator &gt;</h3>
<p>Theta Union. </p>
<p>Computes union of Theta sketches. There is no constructor. Use builder instead. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a4fac8167b04c9b5dbaeb5ccbd053703c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fac8167b04c9b5dbaeb5ccbd053703c">&#9670;&nbsp;</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 &amp;&amp;&#160;</td>
<td class="paramname"><em>sketch</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update the union with a given sketch. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sketch</td><td>to update the union with </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<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 union as a compact sketch. </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 union </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__union_8hpp_source.html">theta_union.hpp</a></li>
<li>theta/include/<a class="el" href="theta__union__impl_8hpp_source.html">theta_union_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>