Google Git
Sign in
apache / datasketches-cpp / refs/heads/gh-pages / . / docs / 5.2.0 / classdatasketches_1_1compact__tuple__sketch.html
blob: e6f96206939e081542d56058926deafc5c78476f [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" 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: compact_tuple_sketch&lt; Summary, 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 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&amp;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&amp;dn=expat.txt MIT */
$(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">
<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="namespacedatasketches.html">datasketches</a></li><li class="navelem"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classdatasketches_1_1compact__tuple__sketch-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">compact_tuple_sketch&lt; Summary, Allocator &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Compact Tuple sketch.
<a href="classdatasketches_1_1compact__tuple__sketch.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="tuple__sketch_8hpp_source.html">tuple_sketch.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for compact_tuple_sketch&lt; Summary, Allocator &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classdatasketches_1_1compact__tuple__sketch.png" usemap="#compact_5Ftuple_5Fsketch_3C_20Summary_2C_20Allocator_20_3E_map" alt=""/>
<map id="compact_5Ftuple_5Fsketch_3C_20Summary_2C_20Allocator_20_3E_map" name="compact_5Ftuple_5Fsketch_3C_20Summary_2C_20Allocator_20_3E_map">
<area href="classdatasketches_1_1tuple__sketch.html" title="Base class for Tuple sketch." alt="tuple_sketch&lt; Summary, Allocator &gt;" shape="rect" coords="0,0,314,24"/>
<area href="classdatasketches_1_1compact__array__tuple__sketch.html" title="Compact array tuple sketch." alt="compact_array_tuple_sketch&lt; Array, Allocator &gt;" shape="rect" coords="0,112,314,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a919843136e9bb921acd40bfea4ed5aef" id="r_a919843136e9bb921acd40bfea4ed5aef"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a919843136e9bb921acd40bfea4ed5aef">compact_tuple_sketch</a> (const <a class="el" href="classdatasketches_1_1tuple__sketch.html">Base</a> &amp;other, bool ordered)</td></tr>
<tr class="memdesc:a919843136e9bb921acd40bfea4ed5aef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:a919843136e9bb921acd40bfea4ed5aef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae38beebc4e0badbf382971d635dee089" id="r_ae38beebc4e0badbf382971d635dee089"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#ae38beebc4e0badbf382971d635dee089">compact_tuple_sketch</a> (const <a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> &amp;other)=default</td></tr>
<tr class="memdesc:ae38beebc4e0badbf382971d635dee089"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:ae38beebc4e0badbf382971d635dee089"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35916bac524f4ff4ff02739553bd4622" id="r_a35916bac524f4ff4ff02739553bd4622"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a35916bac524f4ff4ff02739553bd4622">compact_tuple_sketch</a> (<a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> &amp;&amp;) noexcept</td></tr>
<tr class="memdesc:a35916bac524f4ff4ff02739553bd4622"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move constructor. <br /></td></tr>
<tr class="separator:a35916bac524f4ff4ff02739553bd4622"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7e1c0ebe44ec17179ce5d006ba4b357" id="r_af7e1c0ebe44ec17179ce5d006ba4b357"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#af7e1c0ebe44ec17179ce5d006ba4b357">operator=</a> (const <a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> &amp;other)=default</td></tr>
<tr class="memdesc:af7e1c0ebe44ec17179ce5d006ba4b357"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy assignment. <br /></td></tr>
<tr class="separator:af7e1c0ebe44ec17179ce5d006ba4b357"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5296c590aa61837d6680ff943aa0dd6" id="r_ab5296c590aa61837d6680ff943aa0dd6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#ab5296c590aa61837d6680ff943aa0dd6">operator=</a> (<a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> &amp;&amp;other)=default</td></tr>
<tr class="memdesc:ab5296c590aa61837d6680ff943aa0dd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move assignment. <br /></td></tr>
<tr class="separator:ab5296c590aa61837d6680ff943aa0dd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a519b06cb3b46caf95b967ce404246105" id="r_a519b06cb3b46caf95b967ce404246105"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a519b06cb3b46caf95b967ce404246105">compact_tuple_sketch</a> (const <a class="el" href="classdatasketches_1_1theta__sketch__alloc.html">theta_sketch_alloc</a>&lt; AllocU64 &gt; &amp;other, const Summary &amp;summary, bool ordered=true)</td></tr>
<tr class="memdesc:a519b06cb3b46caf95b967ce404246105"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor from Theta sketch. <br /></td></tr>
<tr class="separator:a519b06cb3b46caf95b967ce404246105"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d85cf47c4ecd0580ec623c42006dd1b" id="r_a9d85cf47c4ecd0580ec623c42006dd1b"><td class="memItemLeft" align="right" valign="top">virtual Allocator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a9d85cf47c4ecd0580ec623c42006dd1b">get_allocator</a> () const</td></tr>
<tr class="separator:a9d85cf47c4ecd0580ec623c42006dd1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a2b7a58dc85678d08752945ff655362" id="r_a5a2b7a58dc85678d08752945ff655362"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a5a2b7a58dc85678d08752945ff655362">is_empty</a> () const</td></tr>
<tr class="separator:a5a2b7a58dc85678d08752945ff655362"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f5b393314c0c1819f79b73232a506e8" id="r_a5f5b393314c0c1819f79b73232a506e8"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a5f5b393314c0c1819f79b73232a506e8">is_ordered</a> () const</td></tr>
<tr class="separator:a5f5b393314c0c1819f79b73232a506e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b072fe55377eb51a6ee477827fc3b95" id="r_a2b072fe55377eb51a6ee477827fc3b95"><td class="memItemLeft" align="right" valign="top">virtual uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a2b072fe55377eb51a6ee477827fc3b95">get_theta64</a> () const</td></tr>
<tr class="separator:a2b072fe55377eb51a6ee477827fc3b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31fa76458d81a17dbebfcb828e531f14" id="r_a31fa76458d81a17dbebfcb828e531f14"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a31fa76458d81a17dbebfcb828e531f14">get_num_retained</a> () const</td></tr>
<tr class="separator:a31fa76458d81a17dbebfcb828e531f14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f69b50bc13da11d255d0e583e2376ba" id="r_a6f69b50bc13da11d255d0e583e2376ba"><td class="memItemLeft" align="right" valign="top">virtual uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a6f69b50bc13da11d255d0e583e2376ba">get_seed_hash</a> () const</td></tr>
<tr class="separator:a6f69b50bc13da11d255d0e583e2376ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45b4c825a3545299d8bfeeadc70708c3" id="r_a45b4c825a3545299d8bfeeadc70708c3"><td class="memTemplParams" colspan="2">template&lt;typename Predicate &gt; </td></tr>
<tr class="memitem:a45b4c825a3545299d8bfeeadc70708c3"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a45b4c825a3545299d8bfeeadc70708c3">filter</a> (const Predicate &amp;predicate) const</td></tr>
<tr class="memdesc:a45b4c825a3545299d8bfeeadc70708c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Produces a Compact Tuple sketch from this sketch by applying a given predicate to each entry. <br /></td></tr>
<tr class="separator:a45b4c825a3545299d8bfeeadc70708c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a538940c100e4353b3671ad452d3d3056" id="r_a538940c100e4353b3671ad452d3d3056"><td class="memTemplParams" colspan="2">template&lt;typename SerDe = serde&lt;Summary&gt;&gt; </td></tr>
<tr class="memitem:a538940c100e4353b3671ad452d3d3056"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a538940c100e4353b3671ad452d3d3056">serialize</a> (std::ostream &amp;os, const SerDe &amp;sd=SerDe()) const</td></tr>
<tr class="memdesc:a538940c100e4353b3671ad452d3d3056"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method serializes the sketch into a given stream in a binary form. <br /></td></tr>
<tr class="separator:a538940c100e4353b3671ad452d3d3056"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d0c269c23926e93b1c7a9c00e86af97" id="r_a1d0c269c23926e93b1c7a9c00e86af97"><td class="memTemplParams" colspan="2">template&lt;typename SerDe = serde&lt;Summary&gt;&gt; </td></tr>
<tr class="memitem:a1d0c269c23926e93b1c7a9c00e86af97"><td class="memTemplItemLeft" align="right" valign="top">vector_bytes&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a1d0c269c23926e93b1c7a9c00e86af97">serialize</a> (unsigned header_size_bytes=0, const SerDe &amp;sd=SerDe()) const</td></tr>
<tr class="memdesc:a1d0c269c23926e93b1c7a9c00e86af97"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method serializes the sketch as a vector of bytes. <br /></td></tr>
<tr class="separator:a1d0c269c23926e93b1c7a9c00e86af97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad950587c89b4306f927b08b5e5cb7e89" id="r_ad950587c89b4306f927b08b5e5cb7e89"><td class="memItemLeft" align="right" valign="top">virtual iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#ad950587c89b4306f927b08b5e5cb7e89">begin</a> ()</td></tr>
<tr class="memdesc:ad950587c89b4306f927b08b5e5cb7e89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterator over entries in this sketch. <br /></td></tr>
<tr class="separator:ad950587c89b4306f927b08b5e5cb7e89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7727305d5e1ec66a181e22c43af9a581" id="r_a7727305d5e1ec66a181e22c43af9a581"><td class="memItemLeft" align="right" valign="top">virtual iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a7727305d5e1ec66a181e22c43af9a581">end</a> ()</td></tr>
<tr class="memdesc:a7727305d5e1ec66a181e22c43af9a581"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterator pointing past the valid range. <br /></td></tr>
<tr class="separator:a7727305d5e1ec66a181e22c43af9a581"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5c959a538216a09ab28c5283585956c" id="r_ad5c959a538216a09ab28c5283585956c"><td class="memItemLeft" align="right" valign="top">virtual const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#ad5c959a538216a09ab28c5283585956c">begin</a> () const</td></tr>
<tr class="memdesc:ad5c959a538216a09ab28c5283585956c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Const iterator over entries in this sketch. <br /></td></tr>
<tr class="separator:ad5c959a538216a09ab28c5283585956c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae11e60e117300685401961e36f196f7a" id="r_ae11e60e117300685401961e36f196f7a"><td class="memItemLeft" align="right" valign="top">virtual const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#ae11e60e117300685401961e36f196f7a">end</a> () const</td></tr>
<tr class="memdesc:ae11e60e117300685401961e36f196f7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Const iterator pointing past the valid range. <br /></td></tr>
<tr class="separator:ae11e60e117300685401961e36f196f7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classdatasketches_1_1tuple__sketch"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classdatasketches_1_1tuple__sketch')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classdatasketches_1_1tuple__sketch.html">tuple_sketch&lt; Summary, Allocator &gt;</a></td></tr>
<tr class="memitem:a2afb71f2ef2d82290be4c8eafc08f2a2 inherit pub_methods_classdatasketches_1_1tuple__sketch" id="r_a2afb71f2ef2d82290be4c8eafc08f2a2"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__sketch.html#a2afb71f2ef2d82290be4c8eafc08f2a2">get_estimate</a> () const</td></tr>
<tr class="separator:a2afb71f2ef2d82290be4c8eafc08f2a2 inherit pub_methods_classdatasketches_1_1tuple__sketch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5019c0a76c448aa70679ec9009c9c096 inherit pub_methods_classdatasketches_1_1tuple__sketch" id="r_a5019c0a76c448aa70679ec9009c9c096"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__sketch.html#a5019c0a76c448aa70679ec9009c9c096">get_lower_bound</a> (uint8_t num_std_devs, uint32_t num_subset_entries) const</td></tr>
<tr class="memdesc:a5019c0a76c448aa70679ec9009c9c096 inherit pub_methods_classdatasketches_1_1tuple__sketch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the approximate lower error bound given a number of standard deviations over an arbitrary number of items stored in the sketch. <br /></td></tr>
<tr class="separator:a5019c0a76c448aa70679ec9009c9c096 inherit pub_methods_classdatasketches_1_1tuple__sketch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e5c990494331d901c3b38cd4eb316e6 inherit pub_methods_classdatasketches_1_1tuple__sketch" id="r_a2e5c990494331d901c3b38cd4eb316e6"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__sketch.html#a2e5c990494331d901c3b38cd4eb316e6">get_lower_bound</a> (uint8_t num_std_devs) const</td></tr>
<tr class="memdesc:a2e5c990494331d901c3b38cd4eb316e6 inherit pub_methods_classdatasketches_1_1tuple__sketch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the approximate lower error bound given a number of standard deviations. <br /></td></tr>
<tr class="separator:a2e5c990494331d901c3b38cd4eb316e6 inherit pub_methods_classdatasketches_1_1tuple__sketch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0526cde38fc4f1bc32839293567c8717 inherit pub_methods_classdatasketches_1_1tuple__sketch" id="r_a0526cde38fc4f1bc32839293567c8717"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__sketch.html#a0526cde38fc4f1bc32839293567c8717">get_upper_bound</a> (uint8_t num_std_devs, uint32_t num_subset_entries) const</td></tr>
<tr class="memdesc:a0526cde38fc4f1bc32839293567c8717 inherit pub_methods_classdatasketches_1_1tuple__sketch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the approximate upper error bound given a number of standard deviations over an arbitrary number of items stored in the sketch. <br /></td></tr>
<tr class="separator:a0526cde38fc4f1bc32839293567c8717 inherit pub_methods_classdatasketches_1_1tuple__sketch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa408e90fef0f988eca7d132875c7c7e1 inherit pub_methods_classdatasketches_1_1tuple__sketch" id="r_aa408e90fef0f988eca7d132875c7c7e1"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__sketch.html#aa408e90fef0f988eca7d132875c7c7e1">get_upper_bound</a> (uint8_t num_std_devs) const</td></tr>
<tr class="memdesc:aa408e90fef0f988eca7d132875c7c7e1 inherit pub_methods_classdatasketches_1_1tuple__sketch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the approximate upper error bound given a number of standard deviations. <br /></td></tr>
<tr class="separator:aa408e90fef0f988eca7d132875c7c7e1 inherit pub_methods_classdatasketches_1_1tuple__sketch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae95a04b1d7dccb3d9b3f3c3d087aa8e6 inherit pub_methods_classdatasketches_1_1tuple__sketch" id="r_ae95a04b1d7dccb3d9b3f3c3d087aa8e6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__sketch.html#ae95a04b1d7dccb3d9b3f3c3d087aa8e6">is_estimation_mode</a> () const</td></tr>
<tr class="separator:ae95a04b1d7dccb3d9b3f3c3d087aa8e6 inherit pub_methods_classdatasketches_1_1tuple__sketch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa784d7f8ac02e9c4e26e7fe9f177a7aa inherit pub_methods_classdatasketches_1_1tuple__sketch" id="r_aa784d7f8ac02e9c4e26e7fe9f177a7aa"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__sketch.html#aa784d7f8ac02e9c4e26e7fe9f177a7aa">get_theta</a> () const</td></tr>
<tr class="separator:aa784d7f8ac02e9c4e26e7fe9f177a7aa inherit pub_methods_classdatasketches_1_1tuple__sketch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60a5fe73c86554c313705666f8fb227a inherit pub_methods_classdatasketches_1_1tuple__sketch" id="r_a60a5fe73c86554c313705666f8fb227a"><td class="memItemLeft" align="right" valign="top">string&lt; Allocator &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__sketch.html#a60a5fe73c86554c313705666f8fb227a">to_string</a> (bool print_items=false) const</td></tr>
<tr class="memdesc:a60a5fe73c86554c313705666f8fb227a inherit pub_methods_classdatasketches_1_1tuple__sketch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides a human-readable summary of this sketch as a string. <br /></td></tr>
<tr class="separator:a60a5fe73c86554c313705666f8fb227a inherit pub_methods_classdatasketches_1_1tuple__sketch"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a52e3b99cd0e081aaeffeb1569dcff39f" id="r_a52e3b99cd0e081aaeffeb1569dcff39f"><td class="memTemplParams" colspan="2">template&lt;typename Sketch , typename Predicate &gt; </td></tr>
<tr class="memitem:a52e3b99cd0e081aaeffeb1569dcff39f"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a52e3b99cd0e081aaeffeb1569dcff39f">filter</a> (const Sketch &amp;sketch, const Predicate &amp;predicate)</td></tr>
<tr class="memdesc:a52e3b99cd0e081aaeffeb1569dcff39f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Produces a Compact Tuple sketch from a given sketch (Update or Compact) by applying a given predicate to each entry. <br /></td></tr>
<tr class="separator:a52e3b99cd0e081aaeffeb1569dcff39f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4654837acac56f89e5c083198374eda" id="r_aa4654837acac56f89e5c083198374eda"><td class="memTemplParams" colspan="2">template&lt;typename SerDe = serde&lt;Summary&gt;&gt; </td></tr>
<tr class="memitem:aa4654837acac56f89e5c083198374eda"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#aa4654837acac56f89e5c083198374eda">deserialize</a> (std::istream &amp;is, uint64_t seed=DEFAULT_SEED, const SerDe &amp;sd=SerDe(), const Allocator &amp;allocator=Allocator())</td></tr>
<tr class="memdesc:aa4654837acac56f89e5c083198374eda"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method deserializes a sketch from a given stream. <br /></td></tr>
<tr class="separator:aa4654837acac56f89e5c083198374eda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37f6a609deea82bf072b744f2f3e4ea8" id="r_a37f6a609deea82bf072b744f2f3e4ea8"><td class="memTemplParams" colspan="2">template&lt;typename SerDe = serde&lt;Summary&gt;&gt; </td></tr>
<tr class="memitem:a37f6a609deea82bf072b744f2f3e4ea8"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#a37f6a609deea82bf072b744f2f3e4ea8">deserialize</a> (const void *bytes, size_t size, uint64_t seed=DEFAULT_SEED, const SerDe &amp;sd=SerDe(), const Allocator &amp;allocator=Allocator())</td></tr>
<tr class="memdesc:a37f6a609deea82bf072b744f2f3e4ea8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method deserializes a sketch from a given array of bytes. <br /></td></tr>
<tr class="separator:a37f6a609deea82bf072b744f2f3e4ea8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aebe0bd9f97ef071d15ae25b9c3418e65" id="r_aebe0bd9f97ef071d15ae25b9c3418e65"><td class="memTemplParams" colspan="2">template&lt;typename SerDe , typename SS = Summary, typename std::enable_if&lt; std::is_arithmetic&lt; SS &gt;::value, int &gt;::type = 0&gt; </td></tr>
<tr class="memitem:aebe0bd9f97ef071d15ae25b9c3418e65"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#aebe0bd9f97ef071d15ae25b9c3418e65">get_serialized_size_summaries_bytes</a> (const SerDe &amp;sd) const</td></tr>
<tr class="memdesc:aebe0bd9f97ef071d15ae25b9c3418e65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes size needed to serialize summaries in the sketch. <br /></td></tr>
<tr class="separator:aebe0bd9f97ef071d15ae25b9c3418e65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebe0bd9f97ef071d15ae25b9c3418e65" id="r_aebe0bd9f97ef071d15ae25b9c3418e65"><td class="memTemplParams" colspan="2">template&lt;typename SerDe , typename SS = Summary, typename std::enable_if&lt;!std::is_arithmetic&lt; SS &gt;::value, int &gt;::type = 0&gt; </td></tr>
<tr class="memitem:aebe0bd9f97ef071d15ae25b9c3418e65"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html#aebe0bd9f97ef071d15ae25b9c3418e65">get_serialized_size_summaries_bytes</a> (const SerDe &amp;sd) const</td></tr>
<tr class="memdesc:aebe0bd9f97ef071d15ae25b9c3418e65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes size needed to serialize summaries in the sketch. <br /></td></tr>
<tr class="separator:aebe0bd9f97ef071d15ae25b9c3418e65"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename Summary, typename Allocator = std::allocator&lt;Summary&gt;&gt;<br />
class datasketches::compact_tuple_sketch&lt; Summary, Allocator &gt;</div><p>Compact Tuple sketch. </p>
<p>This is an immutable form of the Tuple sketch, the form that can be serialized and deserialized. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a919843136e9bb921acd40bfea4ed5aef" name="a919843136e9bb921acd40bfea4ed5aef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a919843136e9bb921acd40bfea4ed5aef">&#9670;&#160;</a></span>compact_tuple_sketch() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename S , typename A &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdatasketches_1_1tuple__sketch.html">Base</a> &amp;&#160;</td>
<td class="paramname"><em>other</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>ordered</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<p>Constructs a compact sketch from another sketch (either update or compact) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>sketch to be copied </td></tr>
<tr><td class="paramname">ordered</td><td>if true make the resulting sketch ordered </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae38beebc4e0badbf382971d635dee089" name="ae38beebc4e0badbf382971d635dee089"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae38beebc4e0badbf382971d635dee089">&#9670;&#160;</a></span>compact_tuple_sketch() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Summary , typename Allocator = std::allocator&lt;Summary&gt;&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a>&lt; Summary, Allocator &gt; &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>sketch to be copied </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a35916bac524f4ff4ff02739553bd4622" name="a35916bac524f4ff4ff02739553bd4622"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35916bac524f4ff4ff02739553bd4622">&#9670;&#160;</a></span>compact_tuple_sketch() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename S , typename A &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a>&lt; Summary, Allocator &gt; &amp;&amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>sketch to be moved </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a519b06cb3b46caf95b967ce404246105" name="a519b06cb3b46caf95b967ce404246105"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a519b06cb3b46caf95b967ce404246105">&#9670;&#160;</a></span>compact_tuple_sketch() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Summary , typename Allocator = std::allocator&lt;Summary&gt;&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdatasketches_1_1theta__sketch__alloc.html">theta_sketch_alloc</a>&lt; AllocU64 &gt; &amp;&#160;</td>
<td class="paramname"><em>other</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Summary &amp;&#160;</td>
<td class="paramname"><em>summary</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></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor from Theta sketch. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Theta sketch to be constructed from </td></tr>
<tr><td class="paramname">summary</td><td>Summary instance to be associated with each entry </td></tr>
<tr><td class="paramname">ordered</td><td>if true make the resulting sketch ordered </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af7e1c0ebe44ec17179ce5d006ba4b357" name="af7e1c0ebe44ec17179ce5d006ba4b357"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7e1c0ebe44ec17179ce5d006ba4b357">&#9670;&#160;</a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Summary , typename Allocator = std::allocator&lt;Summary&gt;&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> &amp; operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a>&lt; Summary, Allocator &gt; &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy assignment. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>sketch to be copied </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>reference to this sketch </dd></dl>
</div>
</div>
<a id="ab5296c590aa61837d6680ff943aa0dd6" name="ab5296c590aa61837d6680ff943aa0dd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5296c590aa61837d6680ff943aa0dd6">&#9670;&#160;</a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Summary , typename Allocator = std::allocator&lt;Summary&gt;&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> &amp; operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a>&lt; Summary, Allocator &gt; &amp;&amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move assignment. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>sketch to be moved </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>reference to this sketch </dd></dl>
</div>
</div>
<a id="a9d85cf47c4ecd0580ec623c42006dd1b" name="a9d85cf47c4ecd0580ec623c42006dd1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d85cf47c4ecd0580ec623c42006dd1b">&#9670;&#160;</a></span>get_allocator()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename S , typename A &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">A get_allocator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>allocator </dd></dl>
<p>Implements <a class="el" href="classdatasketches_1_1tuple__sketch.html#ae99d253473075b7c10569d4565d7ee90">tuple_sketch&lt; Summary, Allocator &gt;</a>.</p>
</div>
</div>
<a id="a5a2b7a58dc85678d08752945ff655362" name="a5a2b7a58dc85678d08752945ff655362"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a2b7a58dc85678d08752945ff655362">&#9670;&#160;</a></span>is_empty()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename S , typename A &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool is_empty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if this sketch represents an empty set (not the same as no retained entries!) </dd></dl>
<p>Implements <a class="el" href="classdatasketches_1_1tuple__sketch.html#a501185051053fcccae5f73f324febcdf">tuple_sketch&lt; Summary, Allocator &gt;</a>.</p>
</div>
</div>
<a id="a5f5b393314c0c1819f79b73232a506e8" name="a5f5b393314c0c1819f79b73232a506e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f5b393314c0c1819f79b73232a506e8">&#9670;&#160;</a></span>is_ordered()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename S , typename A &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool is_ordered </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if retained entries are ordered </dd></dl>
<p>Implements <a class="el" href="classdatasketches_1_1tuple__sketch.html#a358923431da50e8d43651795e2515c01">tuple_sketch&lt; Summary, Allocator &gt;</a>.</p>
</div>
</div>
<a id="a2b072fe55377eb51a6ee477827fc3b95" name="a2b072fe55377eb51a6ee477827fc3b95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b072fe55377eb51a6ee477827fc3b95">&#9670;&#160;</a></span>get_theta64()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename S , typename A &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint64_t get_theta64 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>theta as a positive integer between 0 and LLONG_MAX </dd></dl>
<p>Implements <a class="el" href="classdatasketches_1_1tuple__sketch.html#aef2e47ecd9c33fc2a6a9e905a2a0516a">tuple_sketch&lt; Summary, Allocator &gt;</a>.</p>
</div>
</div>
<a id="a31fa76458d81a17dbebfcb828e531f14" name="a31fa76458d81a17dbebfcb828e531f14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31fa76458d81a17dbebfcb828e531f14">&#9670;&#160;</a></span>get_num_retained()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename S , typename A &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t get_num_retained </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the number of retained entries in the sketch </dd></dl>
<p>Implements <a class="el" href="classdatasketches_1_1tuple__sketch.html#a9c71f891e4b0d3d3dc6a6f4b30ed9261">tuple_sketch&lt; Summary, Allocator &gt;</a>.</p>
</div>
</div>
<a id="a6f69b50bc13da11d255d0e583e2376ba" name="a6f69b50bc13da11d255d0e583e2376ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f69b50bc13da11d255d0e583e2376ba">&#9670;&#160;</a></span>get_seed_hash()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename S , typename A &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint16_t get_seed_hash </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>hash of the seed that was used to hash the input </dd></dl>
<p>Implements <a class="el" href="classdatasketches_1_1tuple__sketch.html#ab76bd6487f5a75a356083bfe163a7079">tuple_sketch&lt; Summary, Allocator &gt;</a>.</p>
</div>
</div>
<a id="a45b4c825a3545299d8bfeeadc70708c3" name="a45b4c825a3545299d8bfeeadc70708c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45b4c825a3545299d8bfeeadc70708c3">&#9670;&#160;</a></span>filter() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Summary , typename Allocator = std::allocator&lt;Summary&gt;&gt; </div>
<div class="memtemplate">
template&lt;typename Predicate &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> filter </td>
<td>(</td>
<td class="paramtype">const Predicate &amp;&#160;</td>
<td class="paramname"><em>predicate</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Produces a Compact Tuple sketch from this sketch by applying a given predicate to each entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">predicate</td><td>should return true for the entries to keep </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>compact sketch with the entries retained according to the predicate </dd></dl>
</div>
</div>
<a id="a52e3b99cd0e081aaeffeb1569dcff39f" name="a52e3b99cd0e081aaeffeb1569dcff39f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52e3b99cd0e081aaeffeb1569dcff39f">&#9670;&#160;</a></span>filter() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Summary , typename Allocator = std::allocator&lt;Summary&gt;&gt; </div>
<div class="memtemplate">
template&lt;typename Sketch , typename Predicate &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> filter </td>
<td>(</td>
<td class="paramtype">const Sketch &amp;&#160;</td>
<td class="paramname"><em>sketch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Predicate &amp;&#160;</td>
<td class="paramname"><em>predicate</em>&#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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Produces a Compact Tuple sketch from a given sketch (Update or Compact) by applying a given predicate to each entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sketch</td><td>input sketch </td></tr>
<tr><td class="paramname">predicate</td><td>should return true for the entries to keep </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>compact sketch with the entries retained according to the predicate </dd></dl>
</div>
</div>
<a id="a538940c100e4353b3671ad452d3d3056" name="a538940c100e4353b3671ad452d3d3056"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a538940c100e4353b3671ad452d3d3056">&#9670;&#160;</a></span>serialize() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename S , typename A &gt; </div>
<div class="memtemplate">
template&lt;typename SerDe &gt; </div>
<table class="memname">
<tr>
<td class="memname">void serialize </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const SerDe &amp;&#160;</td>
<td class="paramname"><em>sd</em> = <code>SerDe()</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>This method serializes the sketch into a given stream in a binary form. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">os</td><td>output stream </td></tr>
<tr><td class="paramname">sd</td><td>instance of a SerDe </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1d0c269c23926e93b1c7a9c00e86af97" name="a1d0c269c23926e93b1c7a9c00e86af97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d0c269c23926e93b1c7a9c00e86af97">&#9670;&#160;</a></span>serialize() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Summary , typename Allocator = std::allocator&lt;Summary&gt;&gt; </div>
<div class="memtemplate">
template&lt;typename SerDe = serde&lt;Summary&gt;&gt; </div>
<table class="memname">
<tr>
<td class="memname">vector_bytes serialize </td>
<td>(</td>
<td class="paramtype">unsigned&#160;</td>
<td class="paramname"><em>header_size_bytes</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const SerDe &amp;&#160;</td>
<td class="paramname"><em>sd</em> = <code>SerDe()</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>This method serializes the sketch as a vector of bytes. </p>
<p>An optional header can be reserved in front of the sketch. It is a blank space of a given size. This header is used in Datasketches PostgreSQL extension. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">header_size_bytes</td><td>space to reserve in front of the sketch </td></tr>
<tr><td class="paramname">sd</td><td>instance of a SerDe </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>serialized sketch as a vector of bytes </dd></dl>
</div>
</div>
<a id="ad950587c89b4306f927b08b5e5cb7e89" name="ad950587c89b4306f927b08b5e5cb7e89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad950587c89b4306f927b08b5e5cb7e89">&#9670;&#160;</a></span>begin() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename S , typename A &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterator over entries in this sketch. </p>
<dl class="section return"><dt>Returns</dt><dd>begin iterator </dd></dl>
<p>Implements <a class="el" href="classdatasketches_1_1tuple__sketch.html#ad1d91335a83907ae2ef026786e12ba0c">tuple_sketch&lt; Summary, Allocator &gt;</a>.</p>
</div>
</div>
<a id="a7727305d5e1ec66a181e22c43af9a581" name="a7727305d5e1ec66a181e22c43af9a581"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7727305d5e1ec66a181e22c43af9a581">&#9670;&#160;</a></span>end() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename S , typename A &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterator pointing past the valid range. </p>
<p>Not to be incremented or dereferenced. </p><dl class="section return"><dt>Returns</dt><dd>end iterator </dd></dl>
<p>Implements <a class="el" href="classdatasketches_1_1tuple__sketch.html#aa7f5423261c0a178f37911746353c0b7">tuple_sketch&lt; Summary, Allocator &gt;</a>.</p>
</div>
</div>
<a id="ad5c959a538216a09ab28c5283585956c" name="ad5c959a538216a09ab28c5283585956c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5c959a538216a09ab28c5283585956c">&#9670;&#160;</a></span>begin() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename S , typename A &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Const iterator over entries in this sketch. </p>
<dl class="section return"><dt>Returns</dt><dd>begin const iterator </dd></dl>
<p>Implements <a class="el" href="classdatasketches_1_1tuple__sketch.html#a250dc1485aaf4ef61332af5c5fdb4715">tuple_sketch&lt; Summary, Allocator &gt;</a>.</p>
</div>
</div>
<a id="ae11e60e117300685401961e36f196f7a" name="ae11e60e117300685401961e36f196f7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae11e60e117300685401961e36f196f7a">&#9670;&#160;</a></span>end() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename S , typename A &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Const iterator pointing past the valid range. </p>
<p>Not to be incremented or dereferenced. </p><dl class="section return"><dt>Returns</dt><dd>end const iterator </dd></dl>
<p>Implements <a class="el" href="classdatasketches_1_1tuple__sketch.html#a47bfa611ed719e4b41ceb653376c1677">tuple_sketch&lt; Summary, Allocator &gt;</a>.</p>
</div>
</div>
<a id="aa4654837acac56f89e5c083198374eda" name="aa4654837acac56f89e5c083198374eda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4654837acac56f89e5c083198374eda">&#9670;&#160;</a></span>deserialize() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Summary , typename Allocator = std::allocator&lt;Summary&gt;&gt; </div>
<div class="memtemplate">
template&lt;typename SerDe = serde&lt;Summary&gt;&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> deserialize </td>
<td>(</td>
<td class="paramtype">std::istream &amp;&#160;</td>
<td class="paramname"><em>is</em>, </td>
</tr>
<tr>
<td class="paramkey"></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 SerDe &amp;&#160;</td>
<td class="paramname"><em>sd</em> = <code>SerDe()</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method deserializes a sketch from a given stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">is</td><td>input stream </td></tr>
<tr><td class="paramname">seed</td><td>the seed for the hash function that was used to create the sketch </td></tr>
<tr><td class="paramname">sd</td><td>instance of a SerDe </td></tr>
<tr><td class="paramname">allocator</td><td>instance of an Allocator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an instance of a sketch </dd></dl>
</div>
</div>
<a id="a37f6a609deea82bf072b744f2f3e4ea8" name="a37f6a609deea82bf072b744f2f3e4ea8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37f6a609deea82bf072b744f2f3e4ea8">&#9670;&#160;</a></span>deserialize() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Summary , typename Allocator = std::allocator&lt;Summary&gt;&gt; </div>
<div class="memtemplate">
template&lt;typename SerDe = serde&lt;Summary&gt;&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a> deserialize </td>
<td>(</td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>bytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></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 SerDe &amp;&#160;</td>
<td class="paramname"><em>sd</em> = <code>SerDe()</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method deserializes a sketch from a given array of bytes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bytes</td><td>pointer to the array of bytes </td></tr>
<tr><td class="paramname">size</td><td>the size of the array </td></tr>
<tr><td class="paramname">seed</td><td>the seed for the hash function that was used to create the sketch </td></tr>
<tr><td class="paramname">sd</td><td>instance of a SerDe </td></tr>
<tr><td class="paramname">allocator</td><td>instance of an Allocator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an instance of the sketch </dd></dl>
</div>
</div>
<a id="aebe0bd9f97ef071d15ae25b9c3418e65" name="aebe0bd9f97ef071d15ae25b9c3418e65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebe0bd9f97ef071d15ae25b9c3418e65">&#9670;&#160;</a></span>get_serialized_size_summaries_bytes() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Summary , typename Allocator = std::allocator&lt;Summary&gt;&gt; </div>
<div class="memtemplate">
template&lt;typename SerDe , typename SS = Summary, typename std::enable_if&lt; std::is_arithmetic&lt; SS &gt;::value, int &gt;::type = 0&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t get_serialized_size_summaries_bytes </td>
<td>(</td>
<td class="paramtype">const SerDe &amp;&#160;</td>
<td class="paramname"><em>sd</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Computes size needed to serialize summaries in the sketch. </p>
<p>This version is for fixed-size arithmetic types (integral and floating point). </p><dl class="section return"><dt>Returns</dt><dd>size in bytes needed to serialize summaries in this sketch </dd></dl>
</div>
</div>
<a id="aebe0bd9f97ef071d15ae25b9c3418e65" name="aebe0bd9f97ef071d15ae25b9c3418e65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebe0bd9f97ef071d15ae25b9c3418e65">&#9670;&#160;</a></span>get_serialized_size_summaries_bytes() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Summary , typename Allocator = std::allocator&lt;Summary&gt;&gt; </div>
<div class="memtemplate">
template&lt;typename SerDe , typename SS = Summary, typename std::enable_if&lt;!std::is_arithmetic&lt; SS &gt;::value, int &gt;::type = 0&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t get_serialized_size_summaries_bytes </td>
<td>(</td>
<td class="paramtype">const SerDe &amp;&#160;</td>
<td class="paramname"><em>sd</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Computes size needed to serialize summaries in the sketch. </p>
<p>This version is for all other types and can be expensive since every item needs to be looked at. </p><dl class="section return"><dt>Returns</dt><dd>size in bytes needed to serialize summaries in this 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="tuple__sketch_8hpp_source.html">tuple_sketch.hpp</a></li>
<li>tuple/include/<a class="el" href="tuple__sketch__impl_8hpp_source.html">tuple_sketch_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.8
</small></address>
</body>
</html>