Google Git
Sign in
apache / datasketches-cpp / refs/heads/gh-pages / . / docs / 5.0.2 / classdatasketches_1_1theta__base__builder.html
blob: a70f8dd25fbe1c06e5226b1905aa72132b577618 [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_base_builder&lt; Derived, 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__base__builder.html">theta_base_builder</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__base__builder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">theta_base_builder&lt; Derived, Allocator &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Theta base builder.
<a href="classdatasketches_1_1theta__base__builder.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="theta__update__sketch__base_8hpp_source.html">theta_update_sketch_base.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for theta_base_builder&lt; Derived, Allocator &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classdatasketches_1_1theta__base__builder.png" usemap="#theta_5Fbase_5Fbuilder_3C_20Derived_2C_20Allocator_20_3E_map" alt=""/>
<map id="theta_5Fbase_5Fbuilder_3C_20Derived_2C_20Allocator_20_3E_map" name="theta_5Fbase_5Fbuilder_3C_20Derived_2C_20Allocator_20_3E_map">
<area href="classdatasketches_1_1tuple__base__builder.html" title="Tuple base builder." alt="tuple_base_builder&lt; Derived, Policy, Allocator &gt;" shape="rect" coords="0,56,292,80"/>
</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:a4b0aff81dd617849c00e8c1624a4218b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__base__builder.html#a4b0aff81dd617849c00e8c1624a4218b">theta_base_builder</a> (const Allocator &amp;allocator)</td></tr>
<tr class="memdesc:a4b0aff81dd617849c00e8c1624a4218b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates and instance of the builder with default parameters. <a href="classdatasketches_1_1theta__base__builder.html#a4b0aff81dd617849c00e8c1624a4218b">More...</a><br /></td></tr>
<tr class="separator:a4b0aff81dd617849c00e8c1624a4218b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a249f556d18a3e5547e6ffef88d7e03ce"><td class="memItemLeft" align="right" valign="top">Derived &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__base__builder.html#a249f556d18a3e5547e6ffef88d7e03ce">set_lg_k</a> (uint8_t lg_k)</td></tr>
<tr class="memdesc:a249f556d18a3e5547e6ffef88d7e03ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set log2(k), where k is a nominal number of entries in the sketch. <a href="classdatasketches_1_1theta__base__builder.html#a249f556d18a3e5547e6ffef88d7e03ce">More...</a><br /></td></tr>
<tr class="separator:a249f556d18a3e5547e6ffef88d7e03ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a872b7237127174b060f0f8ddd00fe7de"><td class="memItemLeft" align="right" valign="top">Derived &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__base__builder.html#a872b7237127174b060f0f8ddd00fe7de">set_resize_factor</a> (resize_factor rf)</td></tr>
<tr class="memdesc:a872b7237127174b060f0f8ddd00fe7de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set resize factor for the internal hash table (defaults to 8) <a href="classdatasketches_1_1theta__base__builder.html#a872b7237127174b060f0f8ddd00fe7de">More...</a><br /></td></tr>
<tr class="separator:a872b7237127174b060f0f8ddd00fe7de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad17b87a607ca9cbeda22aca45d0a03b0"><td class="memItemLeft" align="right" valign="top">Derived &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__base__builder.html#ad17b87a607ca9cbeda22aca45d0a03b0">set_p</a> (float p)</td></tr>
<tr class="memdesc:ad17b87a607ca9cbeda22aca45d0a03b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set sampling probability (initial theta). <a href="classdatasketches_1_1theta__base__builder.html#ad17b87a607ca9cbeda22aca45d0a03b0">More...</a><br /></td></tr>
<tr class="separator:ad17b87a607ca9cbeda22aca45d0a03b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef1998c3c61c65a50d9500395d611c7a"><td class="memItemLeft" align="right" valign="top">Derived &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__base__builder.html#aef1998c3c61c65a50d9500395d611c7a">set_seed</a> (uint64_t seed)</td></tr>
<tr class="memdesc:aef1998c3c61c65a50d9500395d611c7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the seed for the hash function. <a href="classdatasketches_1_1theta__base__builder.html#aef1998c3c61c65a50d9500395d611c7a">More...</a><br /></td></tr>
<tr class="separator:aef1998c3c61c65a50d9500395d611c7a"><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 Derived, typename Allocator&gt;<br />
class datasketches::theta_base_builder&lt; Derived, Allocator &gt;</h3>
<p>Theta base builder. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a4b0aff81dd617849c00e8c1624a4218b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b0aff81dd617849c00e8c1624a4218b">&#9670;&nbsp;</a></span>theta_base_builder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdatasketches_1_1theta__base__builder.html">theta_base_builder</a> </td>
<td>(</td>
<td class="paramtype">const Allocator &amp;&#160;</td>
<td class="paramname"><em>allocator</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates and instance of the builder with default parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">allocator</td><td>instance of an Allocator to pass to created sketches </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a249f556d18a3e5547e6ffef88d7e03ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a249f556d18a3e5547e6ffef88d7e03ce">&#9670;&nbsp;</a></span>set_lg_k()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Derived &amp; set_lg_k </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>lg_k</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set log2(k), where k is a nominal number of entries in the sketch. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lg_k</td><td>base 2 logarithm of nominal number of entries </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>this builder </dd></dl>
</div>
</div>
<a id="a872b7237127174b060f0f8ddd00fe7de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a872b7237127174b060f0f8ddd00fe7de">&#9670;&nbsp;</a></span>set_resize_factor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Derived &amp; set_resize_factor </td>
<td>(</td>
<td class="paramtype">resize_factor&#160;</td>
<td class="paramname"><em>rf</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set resize factor for the internal hash table (defaults to 8) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rf</td><td>resize factor </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>this builder </dd></dl>
</div>
</div>
<a id="ad17b87a607ca9cbeda22aca45d0a03b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad17b87a607ca9cbeda22aca45d0a03b0">&#9670;&nbsp;</a></span>set_p()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Derived &amp; set_p </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set sampling probability (initial theta). </p>
<p>The default is 1, so the sketch retains all entries until it reaches the limit, at which point it goes into the estimation mode and reduces the effective sampling probability (theta) as necessary. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>sampling probability </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>this builder </dd></dl>
</div>
</div>
<a id="aef1998c3c61c65a50d9500395d611c7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef1998c3c61c65a50d9500395d611c7a">&#9670;&nbsp;</a></span>set_seed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Derived &amp; set_seed </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>seed</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the seed for the hash function. </p>
<p>Should be used carefully if needed. Sketches produced with different seed are not compatible and cannot be mixed in set operations. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seed</td><td>hash seed </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>this builder </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>theta/include/<a class="el" href="theta__update__sketch__base_8hpp_source.html">theta_update_sketch_base.hpp</a></li>
<li>theta/include/<a class="el" href="theta__update__sketch__base__impl_8hpp_source.html">theta_update_sketch_base_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>