| <!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: tuple_union< Summary, Policy, Allocator >::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&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&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_1tuple__union.html">tuple_union</a></li><li class="navelem"><a class="el" href="classdatasketches_1_1tuple__union_1_1builder.html">builder</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classdatasketches_1_1tuple__union_1_1builder-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">tuple_union< Summary, Policy, Allocator >::builder Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Tuple union builder. |
| <a href="classdatasketches_1_1tuple__union_1_1builder.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="tuple__union_8hpp_source.html">tuple_union.hpp</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for tuple_union< Summary, Policy, Allocator >::builder:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classdatasketches_1_1tuple__union_1_1builder.png" usemap="#tuple_5Funion_3C_20Summary_2C_20Policy_2C_20Allocator_20_3E::builder_map" alt=""/> |
| <map id="tuple_5Funion_3C_20Summary_2C_20Policy_2C_20Allocator_20_3E::builder_map" name="tuple_5Funion_3C_20Summary_2C_20Policy_2C_20Allocator_20_3E::builder_map"> |
| <area href="classdatasketches_1_1tuple__base__builder.html" alt="tuple_base_builder< builder, P, A >" shape="rect" coords="0,56,217,80"/> |
| <area href="classdatasketches_1_1theta__base__builder.html" alt="theta_base_builder< builder, A >" shape="rect" coords="0,0,217,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:a4939c16cc8f9c221b2f796eda6db7a81"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__union_1_1builder.html#a4939c16cc8f9c221b2f796eda6db7a81">builder</a> (const P &policy=P(), const A &allocator=A())</td></tr> |
| <tr class="memdesc:a4939c16cc8f9c221b2f796eda6db7a81"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classdatasketches_1_1tuple__union_1_1builder.html#a4939c16cc8f9c221b2f796eda6db7a81">More...</a><br /></td></tr> |
| <tr class="separator:a4939c16cc8f9c221b2f796eda6db7a81"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5641adbacdefd99f6833e1c8de16be43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1tuple__union.html">tuple_union</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1tuple__union_1_1builder.html#a5641adbacdefd99f6833e1c8de16be43">build</a> () const</td></tr> |
| <tr class="memdesc:a5641adbacdefd99f6833e1c8de16be43"><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of the union with predefined parameters. <a href="classdatasketches_1_1tuple__union_1_1builder.html#a5641adbacdefd99f6833e1c8de16be43">More...</a><br /></td></tr> |
| <tr class="separator:a5641adbacdefd99f6833e1c8de16be43"><td class="memSeparator" colspan="2"> </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="-"/> Public Member Functions inherited from <a class="el" href="classdatasketches_1_1theta__base__builder.html">theta_base_builder< builder, A ></a></td></tr> |
| <tr class="memitem:a4b0aff81dd617849c00e8c1624a4218b inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1theta__base__builder.html#a4b0aff81dd617849c00e8c1624a4218b">theta_base_builder</a> (const A &allocator)</td></tr> |
| <tr class="memdesc:a4b0aff81dd617849c00e8c1624a4218b inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="mdescLeft"> </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"> </td></tr> |
| <tr class="memitem:a249f556d18a3e5547e6ffef88d7e03ce inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="memItemLeft" align="right" valign="top">builder & </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"> </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"> </td></tr> |
| <tr class="memitem:a872b7237127174b060f0f8ddd00fe7de inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="memItemLeft" align="right" valign="top">builder & </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"> </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"> </td></tr> |
| <tr class="memitem:ad17b87a607ca9cbeda22aca45d0a03b0 inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="memItemLeft" align="right" valign="top">builder & </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"> </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"> </td></tr> |
| <tr class="memitem:aef1998c3c61c65a50d9500395d611c7a inherit pub_methods_classdatasketches_1_1theta__base__builder"><td class="memItemLeft" align="right" valign="top">builder & </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"> </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"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<typename Summary, typename Policy = default_tuple_union_policy<Summary>, typename Allocator = std::allocator<Summary>><br /> |
| class datasketches::tuple_union< Summary, Policy, Allocator >::builder</h3> |
| |
| <p>Tuple union builder. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a4939c16cc8f9c221b2f796eda6db7a81"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4939c16cc8f9c221b2f796eda6db7a81">◆ </a></span>builder()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdatasketches_1_1tuple__union_1_1builder.html">builder</a> </td> |
| <td>(</td> |
| <td class="paramtype">const P & </td> |
| <td class="paramname"><em>policy</em> = <code>P()</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const A & </td> |
| <td class="paramname"><em>allocator</em> = <code>A()</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructor. </p> |
| <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">policy</td><td></td></tr> |
| <tr><td class="paramname">allocator</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a5641adbacdefd99f6833e1c8de16be43"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5641adbacdefd99f6833e1c8de16be43">◆ </a></span>build()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">auto build</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create an instance of the union with predefined parameters. </p> |
| <dl class="section return"><dt>Returns</dt><dd>an instance of the union </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>tuple/include/<a class="el" href="tuple__union_8hpp_source.html">tuple_union.hpp</a></li> |
| <li>tuple/include/<a class="el" href="tuple__union__impl_8hpp_source.html">tuple_union_impl.hpp</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
