blob: 3dffc9d25b505422b5cd8705fad6ecbf33fbd005 [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/include/theta_constants.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 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="dir_e96b5dfe115c13cdeb36484e37aec42e.html">theta</a></li><li class="navelem"><a class="el" href="dir_3f8742d40c9573c3b90638004faf146b.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">theta_constants.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * under the License.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef THETA_CONSTANTS_HPP_</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define THETA_CONSTANTS_HPP_</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;climits&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;common_defs.hpp&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacedatasketches.html">datasketches</a> {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1theta__constants.html"> 29</a></span>&#160;<span class="keyword">namespace </span>theta_constants {</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1theta__constants.html#a329224ced789e065aed0698566b954a4"> 31</a></span>&#160; <span class="keyword">using</span> resize_factor = datasketches::resize_factor;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1theta__constants.html#a02799eee5e87428b1c72e6c4c282d68e"> 33</a></span>&#160; <span class="keyword">const</span> resize_factor <a class="code" href="namespacedatasketches_1_1theta__constants.html#a02799eee5e87428b1c72e6c4c282d68e">DEFAULT_RESIZE_FACTOR</a> = resize_factor::X8;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1theta__constants.html#ae3243c6bd90c8d8577c32b86100d97ad"> 36</a></span>&#160; <span class="keyword">const</span> uint64_t <a class="code" href="namespacedatasketches_1_1theta__constants.html#ae3243c6bd90c8d8577c32b86100d97ad">MAX_THETA</a> = LLONG_MAX;</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1theta__constants.html#a80c5dfefaf69318c0894ec34c34d0987"> 38</a></span>&#160; <span class="keyword">const</span> uint8_t <a class="code" href="namespacedatasketches_1_1theta__constants.html#a80c5dfefaf69318c0894ec34c34d0987">MIN_LG_K</a> = 5;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1theta__constants.html#ad15c7a6b3af91806e0a9743d27943d49"> 40</a></span>&#160; <span class="keyword">const</span> uint8_t <a class="code" href="namespacedatasketches_1_1theta__constants.html#ad15c7a6b3af91806e0a9743d27943d49">MAX_LG_K</a> = 26;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="namespacedatasketches_1_1theta__constants.html#a78468167a70640384c2de5e04fabe4fd"> 42</a></span>&#160; <span class="keyword">const</span> uint8_t <a class="code" href="namespacedatasketches_1_1theta__constants.html#a78468167a70640384c2de5e04fabe4fd">DEFAULT_LG_K</a> = 12;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;}</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;} <span class="comment">/* namespace datasketches */</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="anamespacedatasketches_1_1theta__constants_html_a02799eee5e87428b1c72e6c4c282d68e"><div class="ttname"><a href="namespacedatasketches_1_1theta__constants.html#a02799eee5e87428b1c72e6c4c282d68e">datasketches::theta_constants::DEFAULT_RESIZE_FACTOR</a></div><div class="ttdeci">const resize_factor DEFAULT_RESIZE_FACTOR</div><div class="ttdoc">default resize factor</div><div class="ttdef"><b>Definition:</b> theta_constants.hpp:33</div></div>
<div class="ttc" id="anamespacedatasketches_1_1theta__constants_html_a78468167a70640384c2de5e04fabe4fd"><div class="ttname"><a href="namespacedatasketches_1_1theta__constants.html#a78468167a70640384c2de5e04fabe4fd">datasketches::theta_constants::DEFAULT_LG_K</a></div><div class="ttdeci">const uint8_t DEFAULT_LG_K</div><div class="ttdoc">default log2 of K</div><div class="ttdef"><b>Definition:</b> theta_constants.hpp:42</div></div>
<div class="ttc" id="anamespacedatasketches_1_1theta__constants_html_a80c5dfefaf69318c0894ec34c34d0987"><div class="ttname"><a href="namespacedatasketches_1_1theta__constants.html#a80c5dfefaf69318c0894ec34c34d0987">datasketches::theta_constants::MIN_LG_K</a></div><div class="ttdeci">const uint8_t MIN_LG_K</div><div class="ttdoc">min log2 of K</div><div class="ttdef"><b>Definition:</b> theta_constants.hpp:38</div></div>
<div class="ttc" id="anamespacedatasketches_1_1theta__constants_html_ad15c7a6b3af91806e0a9743d27943d49"><div class="ttname"><a href="namespacedatasketches_1_1theta__constants.html#ad15c7a6b3af91806e0a9743d27943d49">datasketches::theta_constants::MAX_LG_K</a></div><div class="ttdeci">const uint8_t MAX_LG_K</div><div class="ttdoc">max log2 of K</div><div class="ttdef"><b>Definition:</b> theta_constants.hpp:40</div></div>
<div class="ttc" id="anamespacedatasketches_1_1theta__constants_html_ae3243c6bd90c8d8577c32b86100d97ad"><div class="ttname"><a href="namespacedatasketches_1_1theta__constants.html#ae3243c6bd90c8d8577c32b86100d97ad">datasketches::theta_constants::MAX_THETA</a></div><div class="ttdeci">const uint64_t MAX_THETA</div><div class="ttdoc">max theta - signed max for compatibility with Java</div><div class="ttdef"><b>Definition:</b> theta_constants.hpp:36</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.1
</small></address>
</body>
</html>