Google Git
Sign in
apache / datasketches-cpp / 13384f8d3b370ee394a2e4678bb2b49cd8e0e98f / . / docs / master / classdatasketches_1_1update__tuple__sketch.html
blob: a7d99577b4995ee40f1e6d3b4ebfedc56e77c1c1 [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: update_tuple_sketch&lt; Summary, Update, 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_1update__tuple__sketch.html">update_tuple_sketch</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_1update__tuple__sketch-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">update_tuple_sketch&lt; Summary, Update, Policy, Allocator &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Update Tuple sketch.
<a href="classdatasketches_1_1update__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 update_tuple_sketch&lt; Summary, Update, Policy, Allocator &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classdatasketches_1_1update__tuple__sketch.png" usemap="#update_5Ftuple_5Fsketch_3C_20Summary_2C_20Update_2C_20Policy_2C_20Allocator_20_3E_map" alt=""/>
<map id="update_5Ftuple_5Fsketch_3C_20Summary_2C_20Update_2C_20Policy_2C_20Allocator_20_3E_map" name="update_5Ftuple_5Fsketch_3C_20Summary_2C_20Update_2C_20Policy_2C_20Allocator_20_3E_map">
<area href="classdatasketches_1_1tuple__sketch.html" alt="tuple_sketch&lt; Summary, std::allocator&lt; Summary &gt; &gt;" shape="rect" coords="0,0,355,24"/>
</map>
</div></div>
<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_1update__tuple__sketch_1_1builder.html">builder</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update Tuple sketch builder. <a href="classdatasketches_1_1update__tuple__sketch_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:a9d85cf47c4ecd0580ec623c42006dd1b"><td class="memItemLeft" align="right" valign="top">virtual Allocator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__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"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__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"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__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"><td class="memItemLeft" align="right" valign="top">virtual uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__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"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__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"><td class="memItemLeft" align="right" valign="top">virtual uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__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:a8f8b2691781d682411a6de23996a8be2"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#a8f8b2691781d682411a6de23996a8be2">get_lg_k</a> () const</td></tr>
<tr class="separator:a8f8b2691781d682411a6de23996a8be2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36c928e86272441d56f794cc596fd598"><td class="memItemLeft" align="right" valign="top">resize_factor&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#a36c928e86272441d56f794cc596fd598">get_rf</a> () const</td></tr>
<tr class="separator:a36c928e86272441d56f794cc596fd598"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9040689a2df4e2819fb64690667eaca5"><td class="memTemplParams" colspan="2">template&lt;typename FwdUpdate &gt; </td></tr>
<tr class="memitem:a9040689a2df4e2819fb64690667eaca5"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#a9040689a2df4e2819fb64690667eaca5">update</a> (const std::string &amp;key, FwdUpdate &amp;&amp;value)</td></tr>
<tr class="memdesc:a9040689a2df4e2819fb64690667eaca5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update this sketch with a given string. <a href="classdatasketches_1_1update__tuple__sketch.html#a9040689a2df4e2819fb64690667eaca5">More...</a><br /></td></tr>
<tr class="separator:a9040689a2df4e2819fb64690667eaca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a1600e5744952a6b912ae4dbf654dde"><td class="memTemplParams" colspan="2">template&lt;typename FwdUpdate &gt; </td></tr>
<tr class="memitem:a2a1600e5744952a6b912ae4dbf654dde"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#a2a1600e5744952a6b912ae4dbf654dde">update</a> (uint64_t key, FwdUpdate &amp;&amp;value)</td></tr>
<tr class="memdesc:a2a1600e5744952a6b912ae4dbf654dde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update this sketch with a given unsigned 64-bit integer. <a href="classdatasketches_1_1update__tuple__sketch.html#a2a1600e5744952a6b912ae4dbf654dde">More...</a><br /></td></tr>
<tr class="separator:a2a1600e5744952a6b912ae4dbf654dde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad02f663b02e9c1668141eece1c4adc33"><td class="memTemplParams" colspan="2">template&lt;typename FwdUpdate &gt; </td></tr>
<tr class="memitem:ad02f663b02e9c1668141eece1c4adc33"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#ad02f663b02e9c1668141eece1c4adc33">update</a> (int64_t key, FwdUpdate &amp;&amp;value)</td></tr>
<tr class="memdesc:ad02f663b02e9c1668141eece1c4adc33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update this sketch with a given signed 64-bit integer. <a href="classdatasketches_1_1update__tuple__sketch.html#ad02f663b02e9c1668141eece1c4adc33">More...</a><br /></td></tr>
<tr class="separator:ad02f663b02e9c1668141eece1c4adc33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a981d2038132151b982935ee7713add7a"><td class="memTemplParams" colspan="2">template&lt;typename FwdUpdate &gt; </td></tr>
<tr class="memitem:a981d2038132151b982935ee7713add7a"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#a981d2038132151b982935ee7713add7a">update</a> (uint32_t key, FwdUpdate &amp;&amp;value)</td></tr>
<tr class="memdesc:a981d2038132151b982935ee7713add7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update this sketch with a given unsigned 32-bit integer. <a href="classdatasketches_1_1update__tuple__sketch.html#a981d2038132151b982935ee7713add7a">More...</a><br /></td></tr>
<tr class="separator:a981d2038132151b982935ee7713add7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4524000e8e41183562588e961543336e"><td class="memTemplParams" colspan="2">template&lt;typename FwdUpdate &gt; </td></tr>
<tr class="memitem:a4524000e8e41183562588e961543336e"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#a4524000e8e41183562588e961543336e">update</a> (int32_t key, FwdUpdate &amp;&amp;value)</td></tr>
<tr class="memdesc:a4524000e8e41183562588e961543336e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update this sketch with a given signed 32-bit integer. <a href="classdatasketches_1_1update__tuple__sketch.html#a4524000e8e41183562588e961543336e">More...</a><br /></td></tr>
<tr class="separator:a4524000e8e41183562588e961543336e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae252110d18331eaa68e8dee1faddc684"><td class="memTemplParams" colspan="2">template&lt;typename FwdUpdate &gt; </td></tr>
<tr class="memitem:ae252110d18331eaa68e8dee1faddc684"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#ae252110d18331eaa68e8dee1faddc684">update</a> (uint16_t key, FwdUpdate &amp;&amp;value)</td></tr>
<tr class="memdesc:ae252110d18331eaa68e8dee1faddc684"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update this sketch with a given unsigned 16-bit integer. <a href="classdatasketches_1_1update__tuple__sketch.html#ae252110d18331eaa68e8dee1faddc684">More...</a><br /></td></tr>
<tr class="separator:ae252110d18331eaa68e8dee1faddc684"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d3921cf5bcfbda1b545b043b0b1b830"><td class="memTemplParams" colspan="2">template&lt;typename FwdUpdate &gt; </td></tr>
<tr class="memitem:a0d3921cf5bcfbda1b545b043b0b1b830"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#a0d3921cf5bcfbda1b545b043b0b1b830">update</a> (int16_t key, FwdUpdate &amp;&amp;value)</td></tr>
<tr class="memdesc:a0d3921cf5bcfbda1b545b043b0b1b830"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update this sketch with a given signed 16-bit integer. <a href="classdatasketches_1_1update__tuple__sketch.html#a0d3921cf5bcfbda1b545b043b0b1b830">More...</a><br /></td></tr>
<tr class="separator:a0d3921cf5bcfbda1b545b043b0b1b830"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9625343612a687c7eb250cc19d032f6c"><td class="memTemplParams" colspan="2">template&lt;typename FwdUpdate &gt; </td></tr>
<tr class="memitem:a9625343612a687c7eb250cc19d032f6c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#a9625343612a687c7eb250cc19d032f6c">update</a> (uint8_t key, FwdUpdate &amp;&amp;value)</td></tr>
<tr class="memdesc:a9625343612a687c7eb250cc19d032f6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update this sketch with a given unsigned 8-bit integer. <a href="classdatasketches_1_1update__tuple__sketch.html#a9625343612a687c7eb250cc19d032f6c">More...</a><br /></td></tr>
<tr class="separator:a9625343612a687c7eb250cc19d032f6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a808c14c6a7dcaf10dcbd25023d83f637"><td class="memTemplParams" colspan="2">template&lt;typename FwdUpdate &gt; </td></tr>
<tr class="memitem:a808c14c6a7dcaf10dcbd25023d83f637"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#a808c14c6a7dcaf10dcbd25023d83f637">update</a> (int8_t key, FwdUpdate &amp;&amp;value)</td></tr>
<tr class="memdesc:a808c14c6a7dcaf10dcbd25023d83f637"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update this sketch with a given signed 8-bit integer. <a href="classdatasketches_1_1update__tuple__sketch.html#a808c14c6a7dcaf10dcbd25023d83f637">More...</a><br /></td></tr>
<tr class="separator:a808c14c6a7dcaf10dcbd25023d83f637"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf12e466eec013888159bdb19a2a25b1"><td class="memTemplParams" colspan="2">template&lt;typename FwdUpdate &gt; </td></tr>
<tr class="memitem:adf12e466eec013888159bdb19a2a25b1"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#adf12e466eec013888159bdb19a2a25b1">update</a> (double key, FwdUpdate &amp;&amp;value)</td></tr>
<tr class="memdesc:adf12e466eec013888159bdb19a2a25b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update this sketch with a given double-precision floating point value. <a href="classdatasketches_1_1update__tuple__sketch.html#adf12e466eec013888159bdb19a2a25b1">More...</a><br /></td></tr>
<tr class="separator:adf12e466eec013888159bdb19a2a25b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a635198371a6d59ecbcd3a66abdbbf0b5"><td class="memTemplParams" colspan="2">template&lt;typename FwdUpdate &gt; </td></tr>
<tr class="memitem:a635198371a6d59ecbcd3a66abdbbf0b5"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#a635198371a6d59ecbcd3a66abdbbf0b5">update</a> (float key, FwdUpdate &amp;&amp;value)</td></tr>
<tr class="memdesc:a635198371a6d59ecbcd3a66abdbbf0b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update this sketch with a given floating point value. <a href="classdatasketches_1_1update__tuple__sketch.html#a635198371a6d59ecbcd3a66abdbbf0b5">More...</a><br /></td></tr>
<tr class="separator:a635198371a6d59ecbcd3a66abdbbf0b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad91de65acdf8e8908a7697e716b06147"><td class="memTemplParams" colspan="2">template&lt;typename FwdUpdate &gt; </td></tr>
<tr class="memitem:ad91de65acdf8e8908a7697e716b06147"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#ad91de65acdf8e8908a7697e716b06147">update</a> (const void *key, size_t length, FwdUpdate &amp;&amp;value)</td></tr>
<tr class="memdesc:ad91de65acdf8e8908a7697e716b06147"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update this sketch with given data of any type. <a href="classdatasketches_1_1update__tuple__sketch.html#ad91de65acdf8e8908a7697e716b06147">More...</a><br /></td></tr>
<tr class="separator:ad91de65acdf8e8908a7697e716b06147"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a268ae12a22c9f97b84833e4c39fb2278"><td class="memItemLeft" align="right" valign="top"><a id="a268ae12a22c9f97b84833e4c39fb2278"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#a268ae12a22c9f97b84833e4c39fb2278">trim</a> ()</td></tr>
<tr class="memdesc:a268ae12a22c9f97b84833e4c39fb2278"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove retained entries in excess of the nominal size k (if any) <br /></td></tr>
<tr class="separator:a268ae12a22c9f97b84833e4c39fb2278"><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_1update__tuple__sketch.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a> ()</td></tr>
<tr class="memdesc:ad20897c5c8bd47f5d4005989bead0e55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the sketch to the initial empty state. <br /></td></tr>
<tr class="separator:ad20897c5c8bd47f5d4005989bead0e55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8adfe3908612dc77d3708cecddb65515"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a>&lt; Summary, Allocator &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#a8adfe3908612dc77d3708cecddb65515">compact</a> (bool ordered=true) const</td></tr>
<tr class="memdesc:a8adfe3908612dc77d3708cecddb65515"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts this sketch to a compact sketch (ordered or unordered). <a href="classdatasketches_1_1update__tuple__sketch.html#a8adfe3908612dc77d3708cecddb65515">More...</a><br /></td></tr>
<tr class="separator:a8adfe3908612dc77d3708cecddb65515"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa37bb6b08780486ee17d59be552db371"><td class="memTemplParams" colspan="2">template&lt;typename Predicate &gt; </td></tr>
<tr class="memitem:aa37bb6b08780486ee17d59be552db371"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a>&lt; Summary, Allocator &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__tuple__sketch.html#aa37bb6b08780486ee17d59be552db371">filter</a> (const Predicate &amp;predicate) const</td></tr>
<tr class="memdesc:aa37bb6b08780486ee17d59be552db371"><td class="mdescLeft">&#160;</td><td class="mdescRight">Produces a Compact Tuple sketch from this sketch by applying a given predicate to each entry. <a href="classdatasketches_1_1update__tuple__sketch.html#aa37bb6b08780486ee17d59be552db371">More...</a><br /></td></tr>
<tr class="separator:aa37bb6b08780486ee17d59be552db371"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad950587c89b4306f927b08b5e5cb7e89"><td class="memItemLeft" align="right" valign="top">virtual iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__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. <a href="classdatasketches_1_1update__tuple__sketch.html#ad950587c89b4306f927b08b5e5cb7e89">More...</a><br /></td></tr>
<tr class="separator:ad950587c89b4306f927b08b5e5cb7e89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7727305d5e1ec66a181e22c43af9a581"><td class="memItemLeft" align="right" valign="top">virtual iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__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. <a href="classdatasketches_1_1update__tuple__sketch.html#a7727305d5e1ec66a181e22c43af9a581">More...</a><br /></td></tr>
<tr class="separator:a7727305d5e1ec66a181e22c43af9a581"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5c959a538216a09ab28c5283585956c"><td class="memItemLeft" align="right" valign="top">virtual const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__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. <a href="classdatasketches_1_1update__tuple__sketch.html#ad5c959a538216a09ab28c5283585956c">More...</a><br /></td></tr>
<tr class="separator:ad5c959a538216a09ab28c5283585956c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae11e60e117300685401961e36f196f7a"><td class="memItemLeft" align="right" valign="top">virtual const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__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. <a href="classdatasketches_1_1update__tuple__sketch.html#ae11e60e117300685401961e36f196f7a">More...</a><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, std::allocator&lt; Summary &gt; &gt;</a></td></tr>
<tr class="memitem:a2afb71f2ef2d82290be4c8eafc08f2a2 inherit pub_methods_classdatasketches_1_1tuple__sketch"><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"><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. <a href="classdatasketches_1_1tuple__sketch.html#a5019c0a76c448aa70679ec9009c9c096">More...</a><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"><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. <a href="classdatasketches_1_1tuple__sketch.html#a2e5c990494331d901c3b38cd4eb316e6">More...</a><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"><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. <a href="classdatasketches_1_1tuple__sketch.html#a0526cde38fc4f1bc32839293567c8717">More...</a><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"><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. <a href="classdatasketches_1_1tuple__sketch.html#aa408e90fef0f988eca7d132875c7c7e1">More...</a><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"><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"><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"><td class="memItemLeft" align="right" valign="top">string&lt; std::allocator&lt; Summary &gt; &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. <a href="classdatasketches_1_1tuple__sketch.html#a60a5fe73c86554c313705666f8fb227a">More...</a><br /></td></tr>
<tr class="separator:a60a5fe73c86554c313705666f8fb227a inherit pub_methods_classdatasketches_1_1tuple__sketch"><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 Summary, typename Update = Summary, typename Policy = default_tuple_update_policy&lt;Summary, Update&gt;, typename Allocator = std::allocator&lt;Summary&gt;&gt;<br />
class datasketches::update_tuple_sketch&lt; Summary, Update, Policy, Allocator &gt;</h3>
<p>Update Tuple sketch. </p>
<p>The purpose of this class is to build a Tuple sketch from input data via the <a class="el" href="classdatasketches_1_1update__tuple__sketch.html#a9040689a2df4e2819fb64690667eaca5" title="Update this sketch with a given string.">update()</a> methods. There is no constructor. Use builder instead. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9d85cf47c4ecd0580ec623c42006dd1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d85cf47c4ecd0580ec623c42006dd1b">&#9670;&nbsp;</a></span>get_allocator()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">A get_allocator</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, std::allocator&lt; Summary &gt; &gt;</a>.</p>
</div>
</div>
<a id="a5a2b7a58dc85678d08752945ff655362"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a2b7a58dc85678d08752945ff655362">&#9670;&nbsp;</a></span>is_empty()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool is_empty</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, std::allocator&lt; Summary &gt; &gt;</a>.</p>
</div>
</div>
<a id="a5f5b393314c0c1819f79b73232a506e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f5b393314c0c1819f79b73232a506e8">&#9670;&nbsp;</a></span>is_ordered()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool is_ordered</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, std::allocator&lt; Summary &gt; &gt;</a>.</p>
</div>
</div>
<a id="a2b072fe55377eb51a6ee477827fc3b95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b072fe55377eb51a6ee477827fc3b95">&#9670;&nbsp;</a></span>get_theta64()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint64_t get_theta64</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, std::allocator&lt; Summary &gt; &gt;</a>.</p>
</div>
</div>
<a id="a31fa76458d81a17dbebfcb828e531f14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31fa76458d81a17dbebfcb828e531f14">&#9670;&nbsp;</a></span>get_num_retained()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t get_num_retained</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, std::allocator&lt; Summary &gt; &gt;</a>.</p>
</div>
</div>
<a id="a6f69b50bc13da11d255d0e583e2376ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f69b50bc13da11d255d0e583e2376ba">&#9670;&nbsp;</a></span>get_seed_hash()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint16_t get_seed_hash</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, std::allocator&lt; Summary &gt; &gt;</a>.</p>
</div>
</div>
<a id="a8f8b2691781d682411a6de23996a8be2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f8b2691781d682411a6de23996a8be2">&#9670;&nbsp;</a></span>get_lg_k()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t get_lg_k</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>configured nominal number of entries in the sketch </dd></dl>
</div>
</div>
<a id="a36c928e86272441d56f794cc596fd598"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36c928e86272441d56f794cc596fd598">&#9670;&nbsp;</a></span>get_rf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">auto get_rf</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>configured resize factor of the sketch </dd></dl>
</div>
</div>
<a id="a9040689a2df4e2819fb64690667eaca5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9040689a2df4e2819fb64690667eaca5">&#9670;&nbsp;</a></span>update() <span class="overload">[1/12]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FwdUpdate &amp;&amp;&#160;</td>
<td class="paramname"><em>value</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update this sketch with a given string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>string to update the sketch with </td></tr>
<tr><td class="paramname">value</td><td>to update the sketch with </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2a1600e5744952a6b912ae4dbf654dde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a1600e5744952a6b912ae4dbf654dde">&#9670;&nbsp;</a></span>update() <span class="overload">[2/12]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FwdUpdate &amp;&amp;&#160;</td>
<td class="paramname"><em>value</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update this sketch with a given unsigned 64-bit integer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>uint64_t to update the sketch with </td></tr>
<tr><td class="paramname">value</td><td>to update the sketch with </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad02f663b02e9c1668141eece1c4adc33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad02f663b02e9c1668141eece1c4adc33">&#9670;&nbsp;</a></span>update() <span class="overload">[3/12]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FwdUpdate &amp;&amp;&#160;</td>
<td class="paramname"><em>value</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update this sketch with a given signed 64-bit integer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>int64_t to update the sketch with </td></tr>
<tr><td class="paramname">value</td><td>to update the sketch with </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a981d2038132151b982935ee7713add7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a981d2038132151b982935ee7713add7a">&#9670;&nbsp;</a></span>update() <span class="overload">[4/12]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FwdUpdate &amp;&amp;&#160;</td>
<td class="paramname"><em>value</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update this sketch with a given unsigned 32-bit integer. </p>
<p>For compatibility with Java implementation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>uint32_t to update the sketch with </td></tr>
<tr><td class="paramname">value</td><td>to update the sketch with </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4524000e8e41183562588e961543336e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4524000e8e41183562588e961543336e">&#9670;&nbsp;</a></span>update() <span class="overload">[5/12]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FwdUpdate &amp;&amp;&#160;</td>
<td class="paramname"><em>value</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update this sketch with a given signed 32-bit integer. </p>
<p>For compatibility with Java implementation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>int32_t to update the sketch with </td></tr>
<tr><td class="paramname">value</td><td>to update the sketch with </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae252110d18331eaa68e8dee1faddc684"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae252110d18331eaa68e8dee1faddc684">&#9670;&nbsp;</a></span>update() <span class="overload">[6/12]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FwdUpdate &amp;&amp;&#160;</td>
<td class="paramname"><em>value</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update this sketch with a given unsigned 16-bit integer. </p>
<p>For compatibility with Java implementation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>uint16_t to update the sketch with </td></tr>
<tr><td class="paramname">value</td><td>to update the sketch with </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0d3921cf5bcfbda1b545b043b0b1b830"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d3921cf5bcfbda1b545b043b0b1b830">&#9670;&nbsp;</a></span>update() <span class="overload">[7/12]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramtype">int16_t&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FwdUpdate &amp;&amp;&#160;</td>
<td class="paramname"><em>value</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update this sketch with a given signed 16-bit integer. </p>
<p>For compatibility with Java implementation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>int16_t to update the sketch with </td></tr>
<tr><td class="paramname">value</td><td>to update the sketch with </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9625343612a687c7eb250cc19d032f6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9625343612a687c7eb250cc19d032f6c">&#9670;&nbsp;</a></span>update() <span class="overload">[8/12]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FwdUpdate &amp;&amp;&#160;</td>
<td class="paramname"><em>value</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update this sketch with a given unsigned 8-bit integer. </p>
<p>For compatibility with Java implementation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>uint8_t to update the sketch with </td></tr>
<tr><td class="paramname">value</td><td>to update the sketch with </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a808c14c6a7dcaf10dcbd25023d83f637"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a808c14c6a7dcaf10dcbd25023d83f637">&#9670;&nbsp;</a></span>update() <span class="overload">[9/12]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramtype">int8_t&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FwdUpdate &amp;&amp;&#160;</td>
<td class="paramname"><em>value</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update this sketch with a given signed 8-bit integer. </p>
<p>For compatibility with Java implementation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>int8_t to update the sketch with </td></tr>
<tr><td class="paramname">value</td><td>to update the sketch with </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adf12e466eec013888159bdb19a2a25b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf12e466eec013888159bdb19a2a25b1">&#9670;&nbsp;</a></span>update() <span class="overload">[10/12]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FwdUpdate &amp;&amp;&#160;</td>
<td class="paramname"><em>value</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update this sketch with a given double-precision floating point value. </p>
<p>For compatibility with Java implementation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>double to update the sketch with </td></tr>
<tr><td class="paramname">value</td><td>to update the sketch with </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a635198371a6d59ecbcd3a66abdbbf0b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a635198371a6d59ecbcd3a66abdbbf0b5">&#9670;&nbsp;</a></span>update() <span class="overload">[11/12]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FwdUpdate &amp;&amp;&#160;</td>
<td class="paramname"><em>value</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update this sketch with a given floating point value. </p>
<p>For compatibility with Java implementation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>float to update the sketch with </td></tr>
<tr><td class="paramname">value</td><td>to update the sketch with </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad91de65acdf8e8908a7697e716b06147"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad91de65acdf8e8908a7697e716b06147">&#9670;&nbsp;</a></span>update() <span class="overload">[12/12]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FwdUpdate &amp;&amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update this sketch with given data of any type. </p>
<p>This is a "universal" update that covers all cases above, but may produce different hashes. Be very careful to hash input values consistently using the same approach both over time and on different platforms and while passing sketches between C++ environment and Java environment. Otherwise two sketches that should represent overlapping sets will be disjoint For instance, for signed 32-bit values call update(int32_t) method above, which does widening conversion to int64_t, if compatibility with Java is expected </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>pointer to the data </td></tr>
<tr><td class="paramname">length</td><td>of the data in bytes </td></tr>
<tr><td class="paramname">value</td><td>to update the sketch with </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8adfe3908612dc77d3708cecddb65515"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8adfe3908612dc77d3708cecddb65515">&#9670;&nbsp;</a></span>compact()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a>&lt; S, A &gt; compact </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>Converts this sketch to a compact sketch (ordered or unordered). </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>compact sketch </dd></dl>
</div>
</div>
<a id="aa37bb6b08780486ee17d59be552db371"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa37bb6b08780486ee17d59be552db371">&#9670;&nbsp;</a></span>filter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdatasketches_1_1compact__tuple__sketch.html">compact_tuple_sketch</a>&lt;Summary, Allocator&gt; 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="ad950587c89b4306f927b08b5e5cb7e89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad950587c89b4306f927b08b5e5cb7e89">&#9670;&nbsp;</a></span>begin() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto begin</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, std::allocator&lt; Summary &gt; &gt;</a>.</p>
</div>
</div>
<a id="a7727305d5e1ec66a181e22c43af9a581"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7727305d5e1ec66a181e22c43af9a581">&#9670;&nbsp;</a></span>end() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto end</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, std::allocator&lt; Summary &gt; &gt;</a>.</p>
</div>
</div>
<a id="ad5c959a538216a09ab28c5283585956c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5c959a538216a09ab28c5283585956c">&#9670;&nbsp;</a></span>begin() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto begin</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, std::allocator&lt; Summary &gt; &gt;</a>.</p>
</div>
</div>
<a id="ae11e60e117300685401961e36f196f7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae11e60e117300685401961e36f196f7a">&#9670;&nbsp;</a></span>end() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto end</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, std::allocator&lt; Summary &gt; &gt;</a>.</p>
</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.1
</small></address>
</body>
</html>