| <!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_helpers.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&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="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_helpers.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> |
| <div class="line"><a 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 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 name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a 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 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 name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a 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 name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> |
| <div class="line"><a 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 name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div> |
| <div class="line"><a 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 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 name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a 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 name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * under the License.</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef THETA_HELPERS_HPP_</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define THETA_HELPERS_HPP_</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <stdexcept></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "theta_constants.hpp"</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespacedatasketches.html">datasketches</a> {</div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">static</span> <span class="keywordtype">void</span> check_value(T actual, T expected, <span class="keyword">const</span> <span class="keywordtype">char</span>* description) {</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">if</span> (actual != expected) {</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">throw</span> std::invalid_argument(std::string(description) + <span class="stringliteral">" mismatch: expected "</span> + std::to_string(expected) + <span class="stringliteral">", actual "</span> + std::to_string(actual));</div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  }</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> }</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">template</span><<span class="keywordtype">bool</span> dummy></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>checker {</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_serial_version(uint8_t actual, uint8_t expected) {</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  check_value(actual, expected, <span class="stringliteral">"serial version"</span>);</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  }</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_sketch_family(uint8_t actual, uint8_t expected) {</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  check_value(actual, expected, <span class="stringliteral">"sketch family"</span>);</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_sketch_type(uint8_t actual, uint8_t expected) {</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  check_value(actual, expected, <span class="stringliteral">"sketch type"</span>);</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  }</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_seed_hash(uint16_t actual, uint16_t expected) {</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  check_value(actual, expected, <span class="stringliteral">"seed hash"</span>);</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> };</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">template</span><<span class="keywordtype">bool</span> dummy></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">class </span>theta_build_helper{</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// consistent way of initializing theta from p</span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// avoids multiplication if p == 1 since it might not yield MAX_THETA exactly</span></div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">static</span> uint64_t starting_theta_from_p(<span class="keywordtype">float</span> p) {</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">if</span> (p < 1) <span class="keywordflow">return</span> <span class="keyword">static_cast<</span>uint64_t<span class="keyword">></span>(<a class="code" href="namespacedatasketches_1_1theta__constants.html#ae3243c6bd90c8d8577c32b86100d97ad">theta_constants::MAX_THETA</a> * p);</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">return</span> <a class="code" href="namespacedatasketches_1_1theta__constants.html#ae3243c6bd90c8d8577c32b86100d97ad">theta_constants::MAX_THETA</a>;</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">static</span> uint8_t starting_sub_multiple(uint8_t lg_tgt, uint8_t lg_min, uint8_t lg_rf) {</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">return</span> (lg_tgt <= lg_min) ? lg_min : (lg_rf == 0) ? lg_tgt : ((lg_tgt - lg_min) % lg_rf) + lg_min;</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> };</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> } <span class="comment">/* namespace datasketches */</span></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif</span></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 <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> |
