| <!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: common/include/common_defs.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&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&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&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_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_11fbc4217d50ab21044e5ad6614aede5.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">common_defs.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"> * "License"); 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"> * "AS IS" 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="preprocessor">#ifndef _COMMON_DEFS_HPP_</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define _COMMON_DEFS_HPP_</span></div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <cstdint></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <iostream></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <random></span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <chrono></span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include <thread></span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacedatasketches.html">datasketches</a> {</div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">static</span> <span class="keyword">const</span> uint64_t DEFAULT_SEED = 9001;</div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">enum</span> resize_factor { X1 = 0, X2, X4, X8 };</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><<span class="keyword">typename</span> A> <span class="keyword">using </span>string = std::basic_string<char, std::char_traits<char>, <span class="keyword">typename</span> std::allocator_traits<A>::template rebind_alloc<char>>;</div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">// common random declarations</span></div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword">namespace </span>random_utils {</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">static</span> std::random_device rd; <span class="comment">// possibly unsafe in MinGW with GCC < 9.2</span></div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">static</span> <span class="keyword">thread_local</span> std::mt19937_64 rand(rd());</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">static</span> <span class="keyword">thread_local</span> std::uniform_real_distribution<> next_double(0.0, 1.0);</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">static</span> <span class="keyword">thread_local</span> std::uniform_int_distribution<uint64_t> next_uint64(0, UINT64_MAX);</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="comment">// thread-safe random bit</span></div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">static</span> <span class="keyword">thread_local</span> std::independent_bits_engine<std::mt19937, 1, uint32_t></div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> random_bit(<span class="keyword">static_cast<</span>uint32_t<span class="keyword">></span>(std::chrono::system_clock::now().time_since_epoch().count()</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> + std::hash<std::thread::id>{}(std::this_thread::get_id())));</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="keyword">inline</span> <span class="keywordtype">void</span> override_seed(uint64_t s) {</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> rand.seed(s);</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> }</div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>}</div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment">// utility function to hide unused compiler warning</span></div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment">// usually has no additional cost</span></div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="keyword">template</span><<span class="keyword">typename</span> T> <span class="keywordtype">void</span> unused(T&&...) {}</div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment">// common helping functions</span></div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment">// TODO: find a better place for them</span></div> |
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="keyword">constexpr</span> uint8_t log2(uint32_t n) {</div> |
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">return</span> (n > 1) ? 1 + log2(n >> 1) : 0;</div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>}</div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="keyword">constexpr</span> uint8_t lg_size_from_count(uint32_t n, <span class="keywordtype">double</span> load_factor) {</div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">return</span> log2(n) + ((n > <span class="keyword">static_cast<</span>uint32_t<span class="keyword">></span>((1 << (log2(n) + 1)) * load_factor)) ? 2 : 1);</div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span>}</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment">// stream helpers to hide casts</span></div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="keyword">template</span><<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="keyword">static</span> <span class="keyword">inline</span> T read(std::istream& is) {</div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> T value;</div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> is.read(<span class="keyword">reinterpret_cast<</span><span class="keywordtype">char</span>*<span class="keyword">></span>(&value), <span class="keyword">sizeof</span>(T));</div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordflow">return</span> value;</div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>}</div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="keyword">template</span><<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> read(std::istream& is, T* ptr, <span class="keywordtype">size_t</span> size_bytes) {</div> |
| <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> is.read(<span class="keyword">reinterpret_cast<</span><span class="keywordtype">char</span>*<span class="keyword">></span>(ptr), size_bytes);</div> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span>}</div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="keyword">template</span><<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> write(std::ostream& os, T value) {</div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> os.write(<span class="keyword">reinterpret_cast<</span><span class="keyword">const </span><span class="keywordtype">char</span>*<span class="keyword">></span>(&value), <span class="keyword">sizeof</span>(T));</div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>}</div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="keyword">template</span><<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> write(std::ostream& os, <span class="keyword">const</span> T* ptr, <span class="keywordtype">size_t</span> size_bytes) {</div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> os.write(<span class="keyword">reinterpret_cast<</span><span class="keyword">const </span><span class="keywordtype">char</span>*<span class="keyword">></span>(ptr), size_bytes);</div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span>}</div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div> |
| <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="keyword">template</span><<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span>T byteswap(T value) {</div> |
| <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keywordtype">char</span>* ptr = <span class="keyword">static_cast<</span><span class="keywordtype">char</span>*<span class="keyword">></span>(<span class="keyword">static_cast<</span><span class="keywordtype">void</span>*<span class="keyword">></span>(&value));</div> |
| <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">const</span> <span class="keywordtype">int</span> len = <span class="keyword">sizeof</span>(T);</div> |
| <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i < len / 2; ++i) {</div> |
| <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> std::swap(ptr[i], ptr[len - i - 1]);</div> |
| <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> }</div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <span class="keywordflow">return</span> value;</div> |
| <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span>}</div> |
| <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div> |
| <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="keyword">template</span><<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="keyword">static</span> <span class="keyword">inline</span> T read_big_endian(std::istream& is) {</div> |
| <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> T value;</div> |
| <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> is.read(<span class="keyword">reinterpret_cast<</span><span class="keywordtype">char</span>*<span class="keyword">></span>(&value), <span class="keyword">sizeof</span>(T));</div> |
| <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="keywordflow">return</span> byteswap(value);</div> |
| <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span>}</div> |
| <div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div> |
| <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="comment">// wrapper for iterators to implement operator-> returning temporary value</span></div> |
| <div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="keyword">template</span><<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="keyword">class </span>return_value_holder {</div> |
| <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> return_value_holder(T value): value_(value) {}</div> |
| <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">const</span> T* operator->()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> std::addressof(value_); }</div> |
| <div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> T value_;</div> |
| <div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span>};</div> |
| <div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div> |
| <div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span>} <span class="comment">// namespace</span></div> |
| <div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> </div> |
| <div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="preprocessor">#endif </span><span class="comment">// _COMMON_DEFS_HPP_</span></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.8 |
| </small></address> |
| </body> |
| </html> |
