blob: 55fd216d80cf2271e86524698ec023423d777c12 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>datasketches-cpp: theta_sketch_alloc&lt; Allocator &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">datasketches-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacedatasketches.html">datasketches</a></li><li class="navelem"><a class="el" href="classdatasketches_1_1theta__sketch__alloc.html">theta_sketch_alloc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classdatasketches_1_1theta__sketch__alloc-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">theta_sketch_alloc&lt; Allocator &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for the Theta Sketch, a generalization of the Kth Minimum Value (KMV) sketch.
<a href="classdatasketches_1_1theta__sketch__alloc.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="theta__sketch_8hpp_source.html">theta_sketch.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for theta_sketch_alloc&lt; Allocator &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classdatasketches_1_1theta__sketch__alloc.png" usemap="#theta_5Fsketch_5Falloc_3C_20Allocator_20_3E_map" alt=""/>
<map id="theta_5Fsketch_5Falloc_3C_20Allocator_20_3E_map" name="theta_5Fsketch_5Falloc_3C_20Allocator_20_3E_map">
<area href="classdatasketches_1_1base__theta__sketch__alloc.html" alt="base_theta_sketch_alloc&lt; std::allocator&lt; uint64_t &gt; &gt;" shape="rect" coords="0,0,313,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad1d91335a83907ae2ef026786e12ba0c"><td class="memItemLeft" align="right" valign="top">virtual iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__sketch__alloc.html#ad1d91335a83907ae2ef026786e12ba0c">begin</a> ()=0</td></tr>
<tr class="memdesc:ad1d91335a83907ae2ef026786e12ba0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterator over hash values in this sketch. <a href="classdatasketches_1_1theta__sketch__alloc.html#ad1d91335a83907ae2ef026786e12ba0c">More...</a><br /></td></tr>
<tr class="separator:ad1d91335a83907ae2ef026786e12ba0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7f5423261c0a178f37911746353c0b7"><td class="memItemLeft" align="right" valign="top">virtual iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__sketch__alloc.html#aa7f5423261c0a178f37911746353c0b7">end</a> ()=0</td></tr>
<tr class="memdesc:aa7f5423261c0a178f37911746353c0b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterator pointing past the valid range. <a href="classdatasketches_1_1theta__sketch__alloc.html#aa7f5423261c0a178f37911746353c0b7">More...</a><br /></td></tr>
<tr class="separator:aa7f5423261c0a178f37911746353c0b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a250dc1485aaf4ef61332af5c5fdb4715"><td class="memItemLeft" align="right" valign="top">virtual const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__sketch__alloc.html#a250dc1485aaf4ef61332af5c5fdb4715">begin</a> () const =0</td></tr>
<tr class="memdesc:a250dc1485aaf4ef61332af5c5fdb4715"><td class="mdescLeft">&#160;</td><td class="mdescRight">Const iterator over hash values in this sketch. <a href="classdatasketches_1_1theta__sketch__alloc.html#a250dc1485aaf4ef61332af5c5fdb4715">More...</a><br /></td></tr>
<tr class="separator:a250dc1485aaf4ef61332af5c5fdb4715"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47bfa611ed719e4b41ceb653376c1677"><td class="memItemLeft" align="right" valign="top">virtual const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__sketch__alloc.html#a47bfa611ed719e4b41ceb653376c1677">end</a> () const =0</td></tr>
<tr class="memdesc:a47bfa611ed719e4b41ceb653376c1677"><td class="mdescLeft">&#160;</td><td class="mdescRight">Const iterator pointing past the valid range. <a href="classdatasketches_1_1theta__sketch__alloc.html#a47bfa611ed719e4b41ceb653376c1677">More...</a><br /></td></tr>
<tr class="separator:a47bfa611ed719e4b41ceb653376c1677"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classdatasketches_1_1base__theta__sketch__alloc')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html">base_theta_sketch_alloc&lt; std::allocator&lt; uint64_t &gt; &gt;</a></td></tr>
<tr class="memitem:ae99d253473075b7c10569d4565d7ee90 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">virtual std::allocator&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#ae99d253473075b7c10569d4565d7ee90">get_allocator</a> () const=0</td></tr>
<tr class="separator:ae99d253473075b7c10569d4565d7ee90 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a501185051053fcccae5f73f324febcdf inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a501185051053fcccae5f73f324febcdf">is_empty</a> () const=0</td></tr>
<tr class="separator:a501185051053fcccae5f73f324febcdf inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2afb71f2ef2d82290be4c8eafc08f2a2 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a2afb71f2ef2d82290be4c8eafc08f2a2">get_estimate</a> () const</td></tr>
<tr class="separator:a2afb71f2ef2d82290be4c8eafc08f2a2 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e5c990494331d901c3b38cd4eb316e6 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a2e5c990494331d901c3b38cd4eb316e6">get_lower_bound</a> (uint8_t num_std_devs) const</td></tr>
<tr class="memdesc:a2e5c990494331d901c3b38cd4eb316e6 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the approximate lower error bound given a number of standard deviations. <a href="classdatasketches_1_1base__theta__sketch__alloc.html#a2e5c990494331d901c3b38cd4eb316e6">More...</a><br /></td></tr>
<tr class="separator:a2e5c990494331d901c3b38cd4eb316e6 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa408e90fef0f988eca7d132875c7c7e1 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#aa408e90fef0f988eca7d132875c7c7e1">get_upper_bound</a> (uint8_t num_std_devs) const</td></tr>
<tr class="memdesc:aa408e90fef0f988eca7d132875c7c7e1 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the approximate upper error bound given a number of standard deviations. <a href="classdatasketches_1_1base__theta__sketch__alloc.html#aa408e90fef0f988eca7d132875c7c7e1">More...</a><br /></td></tr>
<tr class="separator:aa408e90fef0f988eca7d132875c7c7e1 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae95a04b1d7dccb3d9b3f3c3d087aa8e6 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#ae95a04b1d7dccb3d9b3f3c3d087aa8e6">is_estimation_mode</a> () const</td></tr>
<tr class="separator:ae95a04b1d7dccb3d9b3f3c3d087aa8e6 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa784d7f8ac02e9c4e26e7fe9f177a7aa inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#aa784d7f8ac02e9c4e26e7fe9f177a7aa">get_theta</a> () const</td></tr>
<tr class="separator:aa784d7f8ac02e9c4e26e7fe9f177a7aa inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef2e47ecd9c33fc2a6a9e905a2a0516a inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">virtual uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#aef2e47ecd9c33fc2a6a9e905a2a0516a">get_theta64</a> () const=0</td></tr>
<tr class="separator:aef2e47ecd9c33fc2a6a9e905a2a0516a inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c71f891e4b0d3d3dc6a6f4b30ed9261 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a9c71f891e4b0d3d3dc6a6f4b30ed9261">get_num_retained</a> () const=0</td></tr>
<tr class="separator:a9c71f891e4b0d3d3dc6a6f4b30ed9261 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab76bd6487f5a75a356083bfe163a7079 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">virtual uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#ab76bd6487f5a75a356083bfe163a7079">get_seed_hash</a> () const=0</td></tr>
<tr class="separator:ab76bd6487f5a75a356083bfe163a7079 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a358923431da50e8d43651795e2515c01 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a358923431da50e8d43651795e2515c01">is_ordered</a> () const=0</td></tr>
<tr class="separator:a358923431da50e8d43651795e2515c01 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60a5fe73c86554c313705666f8fb227a inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">virtual string&lt; std::allocator&lt; uint64_t &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a60a5fe73c86554c313705666f8fb227a">to_string</a> (bool print_items=false) const</td></tr>
<tr class="memdesc:a60a5fe73c86554c313705666f8fb227a inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides a human-readable summary of this sketch as a string. <a href="classdatasketches_1_1base__theta__sketch__alloc.html#a60a5fe73c86554c313705666f8fb227a">More...</a><br /></td></tr>
<tr class="separator:a60a5fe73c86554c313705666f8fb227a inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Allocator = std::allocator&lt;uint64_t&gt;&gt;<br />
class datasketches::theta_sketch_alloc&lt; Allocator &gt;</h3>
<p>Base class for the Theta Sketch, a generalization of the Kth Minimum Value (KMV) sketch. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad1d91335a83907ae2ef026786e12ba0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1d91335a83907ae2ef026786e12ba0c">&#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">virtual iterator 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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterator over hash values in this sketch. </p>
<dl class="section return"><dt>Returns</dt><dd>begin iterator </dd></dl>
<p>Implemented in <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#ad950587c89b4306f927b08b5e5cb7e89">compact_theta_sketch_alloc&lt; Allocator &gt;</a>, and <a class="el" href="classdatasketches_1_1update__theta__sketch__alloc.html#ad950587c89b4306f927b08b5e5cb7e89">update_theta_sketch_alloc&lt; Allocator &gt;</a>.</p>
</div>
</div>
<a id="aa7f5423261c0a178f37911746353c0b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7f5423261c0a178f37911746353c0b7">&#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">virtual iterator 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">pure 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>Implemented in <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a7727305d5e1ec66a181e22c43af9a581">compact_theta_sketch_alloc&lt; Allocator &gt;</a>, and <a class="el" href="classdatasketches_1_1update__theta__sketch__alloc.html#a7727305d5e1ec66a181e22c43af9a581">update_theta_sketch_alloc&lt; Allocator &gt;</a>.</p>
</div>
</div>
<a id="a250dc1485aaf4ef61332af5c5fdb4715"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a250dc1485aaf4ef61332af5c5fdb4715">&#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">virtual const_iterator 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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Const iterator over hash values in this sketch. </p>
<dl class="section return"><dt>Returns</dt><dd>begin iterator </dd></dl>
<p>Implemented in <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#ad5c959a538216a09ab28c5283585956c">compact_theta_sketch_alloc&lt; Allocator &gt;</a>, and <a class="el" href="classdatasketches_1_1update__theta__sketch__alloc.html#ad5c959a538216a09ab28c5283585956c">update_theta_sketch_alloc&lt; Allocator &gt;</a>.</p>
</div>
</div>
<a id="a47bfa611ed719e4b41ceb653376c1677"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47bfa611ed719e4b41ceb653376c1677">&#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">virtual const_iterator 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">pure 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 iterator </dd></dl>
<p>Implemented in <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#ae11e60e117300685401961e36f196f7a">compact_theta_sketch_alloc&lt; Allocator &gt;</a>, and <a class="el" href="classdatasketches_1_1update__theta__sketch__alloc.html#ae11e60e117300685401961e36f196f7a">update_theta_sketch_alloc&lt; Allocator &gt;</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>theta/include/<a class="el" href="theta__sketch_8hpp_source.html">theta_sketch.hpp</a></li>
<li>theta/include/<a class="el" href="theta__sketch__impl_8hpp_source.html">theta_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>