Google Git
Sign in
apache / datasketches-cpp / 13384f8d3b370ee394a2e4678bb2b49cd8e0e98f / . / docs / master / classdatasketches_1_1update__theta__sketch__alloc_1_1builder.html
blob: 4b316cca50c2c9fd2d69bf2f0ec6cd5ca9f7a78e [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_theta_sketch_alloc&lt; Allocator &gt;::builder Class 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__theta__sketch__alloc.html">update_theta_sketch_alloc</a></li><li class="navelem"><a class="el" href="classdatasketches_1_1update__theta__sketch__alloc_1_1builder.html">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_1update__theta__sketch__alloc_1_1builder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">update_theta_sketch_alloc&lt; Allocator &gt;::builder Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Update Theta sketch builder.
<a href="classdatasketches_1_1update__theta__sketch__alloc_1_1builder.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 update_theta_sketch_alloc&lt; Allocator &gt;::builder:</div>
<div class="dyncontent">
<div class="center">
<img src="classdatasketches_1_1update__theta__sketch__alloc_1_1builder.png" usemap="#update_5Ftheta_5Fsketch_5Falloc_3C_20Allocator_20_3E::builder_map" alt=""/>
<map id="update_5Ftheta_5Fsketch_5Falloc_3C_20Allocator_20_3E::builder_map" name="update_5Ftheta_5Fsketch_5Falloc_3C_20Allocator_20_3E::builder_map">
<area href="classdatasketches_1_1theta__base__builder.html" alt="theta_base_builder&lt; builder, Allocator &gt;" shape="rect" coords="0,0,242,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:acb9ce8d7607c97e6bf7dfa2df52926dc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__theta__sketch__alloc_1_1builder.html#acb9ce8d7607c97e6bf7dfa2df52926dc">builder</a> (const Allocator &amp;allocator=Allocator())</td></tr>
<tr class="memdesc:acb9ce8d7607c97e6bf7dfa2df52926dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classdatasketches_1_1update__theta__sketch__alloc_1_1builder.html#acb9ce8d7607c97e6bf7dfa2df52926dc">More...</a><br /></td></tr>
<tr class="separator:acb9ce8d7607c97e6bf7dfa2df52926dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9a3043edefda59a1b97e7299506a494"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1update__theta__sketch__alloc.html">update_theta_sketch_alloc</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1update__theta__sketch__alloc_1_1builder.html#af9a3043edefda59a1b97e7299506a494">build</a> () const</td></tr>
<tr class="separator:af9a3043edefda59a1b97e7299506a494"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classdatasketches_1_1theta__base__builder"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classdatasketches_1_1theta__base__builder')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classdatasketches_1_1theta__base__builder.html">theta_base_builder&lt; builder, Allocator &gt;</a></td></tr>
<tr class="memitem:a4b0aff81dd617849c00e8c1624a4218b inherit pub_methods_classdatasketches_1_1theta__base__builder"><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 inherit pub_methods_classdatasketches_1_1theta__base__builder"><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 inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a249f556d18a3e5547e6ffef88d7e03ce inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="memItemLeft" align="right" valign="top">builder &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 inherit pub_methods_classdatasketches_1_1theta__base__builder"><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 inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a872b7237127174b060f0f8ddd00fe7de inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="memItemLeft" align="right" valign="top">builder &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 inherit pub_methods_classdatasketches_1_1theta__base__builder"><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 inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad17b87a607ca9cbeda22aca45d0a03b0 inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="memItemLeft" align="right" valign="top">builder &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 inherit pub_methods_classdatasketches_1_1theta__base__builder"><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 inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef1998c3c61c65a50d9500395d611c7a inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="memItemLeft" align="right" valign="top">builder &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 inherit pub_methods_classdatasketches_1_1theta__base__builder"><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 inherit pub_methods_classdatasketches_1_1theta__base__builder"><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::update_theta_sketch_alloc&lt; Allocator &gt;::builder</h3>
<p>Update Theta sketch builder. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="acb9ce8d7607c97e6bf7dfa2df52926dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb9ce8d7607c97e6bf7dfa2df52926dc">&#9670;&nbsp;</a></span>builder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdatasketches_1_1update__theta__sketch__alloc_1_1builder.html">builder</a> </td>
<td>(</td>
<td class="paramtype">const Allocator &amp;&#160;</td>
<td class="paramname"><em>allocator</em> = <code>Allocator()</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">allocator</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af9a3043edefda59a1b97e7299506a494"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9a3043edefda59a1b97e7299506a494">&#9670;&nbsp;</a></span>build()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdatasketches_1_1update__theta__sketch__alloc.html">update_theta_sketch_alloc</a>&lt; A &gt; build</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>instance of Update Theta sketch </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__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>