blob: 87f2aac1477f0d4e8f0e34d890acd98520331fd7 [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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>datasketches-cpp: tuple/include/tuple_union_impl.hpp Source File</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 id="projectrow">
<td id="projectalign">
<div id="projectname">datasketches-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_00b03cb5ae954e8a2b89b347e34477b0.html">tuple</a></li><li class="navelem"><a class="el" href="dir_0bcb9827d33186afae8dcf178a314956.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">tuple_union_impl.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacedatasketches.html">datasketches</a> {</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> S, <span class="keyword">typename</span> P, <span class="keyword">typename</span> A&gt;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>tuple_union&lt;S, P, A&gt;::tuple_union(uint8_t lg_cur_size, uint8_t lg_nom_size, resize_factor rf, <span class="keywordtype">float</span> p, uint64_t theta, uint64_t seed, <span class="keyword">const</span> P&amp; policy, <span class="keyword">const</span> A&amp; allocator):</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>state_(lg_cur_size, lg_nom_size, rf, p, theta, seed, internal_policy(policy), allocator)</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>{}</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> S, <span class="keyword">typename</span> P, <span class="keyword">typename</span> A&gt;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> SS&gt;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keywordtype">void</span> tuple_union&lt;S, P, A&gt;::update(SS&amp;&amp; sketch) {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> state_.update(std::forward&lt;SS&gt;(sketch));</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>}</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> S, <span class="keyword">typename</span> P, <span class="keyword">typename</span> A&gt;</div>
<div class="foldopen" id="foldopen00034" data-start="{" data-end="}">
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="classdatasketches_1_1tuple__union.html#a037835e8f8e6b5233fa0f0996bba6a99"> 34</a></span><span class="keyword">auto</span> <a class="code hl_class" href="classdatasketches_1_1tuple__union.html">tuple_union&lt;S, P, A&gt;::get_result</a>(<span class="keywordtype">bool</span> ordered) <span class="keyword">const</span> -&gt; <a class="code hl_class" href="classdatasketches_1_1compact__tuple__sketch.html">CompactSketch</a> {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordflow">return</span> state_.get_result(ordered);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>}</div>
</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> S, <span class="keyword">typename</span> P, <span class="keyword">typename</span> A&gt;</div>
<div class="foldopen" id="foldopen00039" data-start="{" data-end="}">
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classdatasketches_1_1tuple__union.html#ad20897c5c8bd47f5d4005989bead0e55"> 39</a></span><span class="keywordtype">void</span> <a class="code hl_class" href="classdatasketches_1_1tuple__union.html">tuple_union&lt;S, P, A&gt;::reset</a>() {</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordflow">return</span> state_.<a class="code hl_function" href="classdatasketches_1_1tuple__union.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a>();</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>}</div>
</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> S, <span class="keyword">typename</span> P, <span class="keyword">typename</span> A&gt;</div>
<div class="foldopen" id="foldopen00044" data-start="{" data-end="}">
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classdatasketches_1_1tuple__union_1_1builder.html#a4939c16cc8f9c221b2f796eda6db7a81"> 44</a></span><a class="code hl_class" href="classdatasketches_1_1tuple__union.html">tuple_union&lt;S, P, A&gt;::builder::builder</a>(<span class="keyword">const</span> P&amp; policy, <span class="keyword">const</span> A&amp; allocator):</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><a class="code hl_class" href="classdatasketches_1_1tuple__base__builder.html">tuple_base_builder</a>&lt;<a class="code hl_class" href="classdatasketches_1_1tuple__union_1_1builder.html">builder</a>, P, A&gt;(policy, allocator) {}</div>
</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> S, <span class="keyword">typename</span> P, <span class="keyword">typename</span> A&gt;</div>
<div class="foldopen" id="foldopen00048" data-start="{" data-end="}">
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classdatasketches_1_1tuple__union_1_1builder.html#a5641adbacdefd99f6833e1c8de16be43"> 48</a></span><span class="keyword">auto</span> <a class="code hl_function" href="classdatasketches_1_1tuple__union_1_1builder.html#a5641adbacdefd99f6833e1c8de16be43">tuple_union&lt;S, P, A&gt;::builder::build</a>() const -&gt; <a class="code hl_class" href="classdatasketches_1_1tuple__union.html">tuple_union</a> {</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordflow">return</span> <a class="code hl_class" href="classdatasketches_1_1tuple__union.html">tuple_union</a>(this-&gt;starting_lg_size(), this-&gt;lg_k_, this-&gt;rf_, this-&gt;p_, this-&gt;starting_theta(), this-&gt;seed_, this-&gt;policy_, this-&gt;allocator_);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>}</div>
</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>} <span class="comment">/* namespace datasketches */</span></div>
<div class="ttc" id="aclassdatasketches_1_1compact__tuple__sketch_html"><div class="ttname"><a href="classdatasketches_1_1compact__tuple__sketch.html">datasketches::compact_tuple_sketch</a></div><div class="ttdoc">Compact Tuple sketch.</div><div class="ttdef"><b>Definition</b> tuple_sketch.hpp:416</div></div>
<div class="ttc" id="aclassdatasketches_1_1tuple__base__builder_html"><div class="ttname"><a href="classdatasketches_1_1tuple__base__builder.html">datasketches::tuple_base_builder</a></div><div class="ttdoc">Tuple base builder.</div><div class="ttdef"><b>Definition</b> tuple_sketch.hpp:614</div></div>
<div class="ttc" id="aclassdatasketches_1_1tuple__union_1_1builder_html"><div class="ttname"><a href="classdatasketches_1_1tuple__union_1_1builder.html">datasketches::tuple_union::builder</a></div><div class="ttdoc">Tuple union builder.</div><div class="ttdef"><b>Definition</b> tuple_union.hpp:101</div></div>
<div class="ttc" id="aclassdatasketches_1_1tuple__union_1_1builder_html_a5641adbacdefd99f6833e1c8de16be43"><div class="ttname"><a href="classdatasketches_1_1tuple__union_1_1builder.html#a5641adbacdefd99f6833e1c8de16be43">datasketches::tuple_union::builder::build</a></div><div class="ttdeci">tuple_union build() const</div><div class="ttdoc">Create an instance of the union with predefined parameters.</div><div class="ttdef"><b>Definition</b> tuple_union_impl.hpp:48</div></div>
<div class="ttc" id="aclassdatasketches_1_1tuple__union_html"><div class="ttname"><a href="classdatasketches_1_1tuple__union.html">datasketches::tuple_union</a></div><div class="ttdoc">Tuple Union.</div><div class="ttdef"><b>Definition</b> tuple_union.hpp:45</div></div>
<div class="ttc" id="aclassdatasketches_1_1tuple__union_html_ad20897c5c8bd47f5d4005989bead0e55"><div class="ttname"><a href="classdatasketches_1_1tuple__union.html#ad20897c5c8bd47f5d4005989bead0e55">datasketches::tuple_union::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Reset the union to the initial empty state.</div><div class="ttdef"><b>Definition</b> tuple_union_impl.hpp:39</div></div>
<div class="ttc" id="anamespacedatasketches_html"><div class="ttname"><a href="namespacedatasketches.html">datasketches</a></div><div class="ttdoc">DataSketches namespace.</div><div class="ttdef"><b>Definition</b> binomial_bounds.hpp:38</div></div>
</div><!-- fragment --></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.8
</small></address>
</body>
</html>