deploy: 4e4a944

apache · Aug 17, 2024 · 7ab96e2 · 7ab96e2
1 parent 1f72d35
commit 7ab96e2
Show file tree

Hide file tree

Showing 101 changed files with 1,444 additions and 530 deletions.
diff --git a/docs/master/annotated.html b/docs/master/annotated.html
@@ -119,6 +119,7 @@
 <tr id="row_0_42_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdatasketches_1_1frequent__items__sketch_1_1row.html" target="_self">row</a></td><td class="desc">Row in the output from <a class="el" href="classdatasketches_1_1frequent__items__sketch.html#a5412230c8878e0cc1be2c6940512f508" title="Returns an array of rows that include frequent items, estimates, upper and lower bounds given an erro...">get_frequent_items</a> </td></tr>
 <tr id="row_0_43_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdatasketches_1_1count__min__sketch.html" target="_self">count_min_sketch</a></td><td class="desc">C++ implementation of the CountMin sketch data structure of Cormode and Muthukrishnan </td></tr>
 <tr id="row_0_44_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdatasketches_1_1req__sketch.html" target="_self">req_sketch</a></td><td class="desc">Relative Error Quantiles Sketch </td></tr>
+<tr id="row_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classXXHash64.html" target="_self">XXHash64</a></td><td class="desc">XXHash (64 bit), based on Yann Collet's descriptions, see <a href="http://cyan4973.github.io/xxHash/">http://cyan4973.github.io/xxHash/</a> </td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->

diff --git a/docs/master/classXXHash64-members.html b/docs/master/classXXHash64-members.html
@@ -0,0 +1,81 @@
+<!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: Member List</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><!-- top -->
+<div class="header">
+  <div class="headertitle">
+<div class="title">XXHash64 Member List</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>This is the complete list of members for <a class="el" href="classXXHash64.html">XXHash64</a>, including all inherited members.</p>
+<table class="directory">
+  <tr class="even"><td class="entry"><a class="el" href="classXXHash64.html#aa231dc8a2cb1804f69c1187e09ef5d69">add</a>(const void *input, uint64_t length)</td><td class="entry"><a class="el" href="classXXHash64.html">XXHash64</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classXXHash64.html#a35b9406690383f9b794082192db9f109">hash</a>() const</td><td class="entry"><a class="el" href="classXXHash64.html">XXHash64</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classXXHash64.html#a725b2abf9eb0d100fc6a53d63fbfe2ef">hash</a>(const void *input, uint64_t length, uint64_t seed)</td><td class="entry"><a class="el" href="classXXHash64.html">XXHash64</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classXXHash64.html#aa066dac9f05cdf8b1adb49e12c64f54b">XXHash64</a>(uint64_t seed)</td><td class="entry"><a class="el" href="classXXHash64.html">XXHash64</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr>
+</table></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>
diff --git a/docs/master/classXXHash64.html b/docs/master/classXXHash64.html
@@ -0,0 +1,273 @@
+<!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: XXHash64 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&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><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#pub-methods">Public Member Functions</a> &#124;
+<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
+<a href="classXXHash64-members.html">List of all members</a>  </div>
+  <div class="headertitle">
+<div class="title">XXHash64 Class Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>XXHash (64 bit), based on Yann Collet's descriptions, see <a href="http://cyan4973.github.io/xxHash/">http://cyan4973.github.io/xxHash/</a>.  
+ <a href="classXXHash64.html#details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="xxhash64_8h_source.html">xxhash64.h</a>&gt;</code></p>
+<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:aa066dac9f05cdf8b1adb49e12c64f54b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXXHash64.html#aa066dac9f05cdf8b1adb49e12c64f54b">XXHash64</a> (uint64_t seed)</td></tr>
+<tr class="memdesc:aa066dac9f05cdf8b1adb49e12c64f54b"><td class="mdescLeft">&#160;</td><td class="mdescRight">create new XXHash (64 bit)  <a href="classXXHash64.html#aa066dac9f05cdf8b1adb49e12c64f54b">More...</a><br /></td></tr>
+<tr class="separator:aa066dac9f05cdf8b1adb49e12c64f54b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aa231dc8a2cb1804f69c1187e09ef5d69"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXXHash64.html#aa231dc8a2cb1804f69c1187e09ef5d69">add</a> (const void *input, uint64_t length)</td></tr>
+<tr class="memdesc:aa231dc8a2cb1804f69c1187e09ef5d69"><td class="mdescLeft">&#160;</td><td class="mdescRight">add a chunk of bytes  <a href="classXXHash64.html#aa231dc8a2cb1804f69c1187e09ef5d69">More...</a><br /></td></tr>
+<tr class="separator:aa231dc8a2cb1804f69c1187e09ef5d69"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a35b9406690383f9b794082192db9f109"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXXHash64.html#a35b9406690383f9b794082192db9f109">hash</a> () const</td></tr>
+<tr class="memdesc:a35b9406690383f9b794082192db9f109"><td class="mdescLeft">&#160;</td><td class="mdescRight">get current hash  <a href="classXXHash64.html#a35b9406690383f9b794082192db9f109">More...</a><br /></td></tr>
+<tr class="separator:a35b9406690383f9b794082192db9f109"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
+Static Public Member Functions</h2></td></tr>
+<tr class="memitem:a725b2abf9eb0d100fc6a53d63fbfe2ef"><td class="memItemLeft" align="right" valign="top">static uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXXHash64.html#a725b2abf9eb0d100fc6a53d63fbfe2ef">hash</a> (const void *input, uint64_t length, uint64_t seed)</td></tr>
+<tr class="memdesc:a725b2abf9eb0d100fc6a53d63fbfe2ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">combine constructor, <a class="el" href="classXXHash64.html#aa231dc8a2cb1804f69c1187e09ef5d69" title="add a chunk of bytes">add()</a> and <a class="el" href="classXXHash64.html#a35b9406690383f9b794082192db9f109" title="get current hash">hash()</a> in one static function (C style)  <a href="classXXHash64.html#a725b2abf9eb0d100fc6a53d63fbfe2ef">More...</a><br /></td></tr>
+<tr class="separator:a725b2abf9eb0d100fc6a53d63fbfe2ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>XXHash (64 bit), based on Yann Collet's descriptions, see <a href="http://cyan4973.github.io/xxHash/">http://cyan4973.github.io/xxHash/</a>. </p>
+<p>How to use: uint64_t myseed = 0; <a class="el" href="classXXHash64.html" title="XXHash (64 bit), based on Yann Collet&#39;s descriptions, see http://cyan4973.github.io/xxHash/.">XXHash64</a> myhash(myseed); myhash.add(pointerToSomeBytes,     numberOfBytes); myhash.add(pointerToSomeMoreBytes, numberOfMoreBytes); // call <a class="el" href="classXXHash64.html#aa231dc8a2cb1804f69c1187e09ef5d69" title="add a chunk of bytes">add()</a> as often as you like to ... and compute hash: uint64_t result = myhash.hash();</p>
+<p>or all of the above in one single line: uint64_t result2 = XXHash64::hash(mypointer, numBytes, myseed);</p>
+<p>Note: my code is NOT endian-aware ! </p>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="aa066dac9f05cdf8b1adb49e12c64f54b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa066dac9f05cdf8b1adb49e12c64f54b">&#9670;&nbsp;</a></span>XXHash64()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classXXHash64.html">XXHash64</a> </td>
+          <td>(</td>
+          <td class="paramtype">uint64_t&#160;</td>
+          <td class="paramname"><em>seed</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>create new XXHash (64 bit) </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">seed</td><td>your seed value, even zero is a valid seed </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="aa231dc8a2cb1804f69c1187e09ef5d69"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa231dc8a2cb1804f69c1187e09ef5d69">&#9670;&nbsp;</a></span>add()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool add </td>
+          <td>(</td>
+          <td class="paramtype">const void *&#160;</td>
+          <td class="paramname"><em>input</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uint64_t&#160;</td>
+          <td class="paramname"><em>length</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>add a chunk of bytes </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">input</td><td>pointer to a continuous block of data </td></tr>
+    <tr><td class="paramname">length</td><td>number of bytes </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>false if parameters are invalid / zero </dd></dl>
+
+</div>
+</div>
+<a id="a35b9406690383f9b794082192db9f109"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a35b9406690383f9b794082192db9f109">&#9670;&nbsp;</a></span>hash() <span class="overload">[1/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint64_t hash </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>get current hash </p>
+<dl class="section return"><dt>Returns</dt><dd>64 bit XXHash </dd></dl>
+
+</div>
+</div>
+<a id="a725b2abf9eb0d100fc6a53d63fbfe2ef"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a725b2abf9eb0d100fc6a53d63fbfe2ef">&#9670;&nbsp;</a></span>hash() <span class="overload">[2/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">static uint64_t hash </td>
+          <td>(</td>
+          <td class="paramtype">const void *&#160;</td>
+          <td class="paramname"><em>input</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uint64_t&#160;</td>
+          <td class="paramname"><em>length</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uint64_t&#160;</td>
+          <td class="paramname"><em>seed</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>combine constructor, <a class="el" href="classXXHash64.html#aa231dc8a2cb1804f69c1187e09ef5d69" title="add a chunk of bytes">add()</a> and <a class="el" href="classXXHash64.html#a35b9406690383f9b794082192db9f109" title="get current hash">hash()</a> in one static function (C style) </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">input</td><td>pointer to a continuous block of data </td></tr>
+    <tr><td class="paramname">length</td><td>number of bytes </td></tr>
+    <tr><td class="paramname">seed</td><td>your seed value, e.g. zero is a valid seed </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>64 bit XXHash </dd></dl>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following file:<ul>
+<li>common/include/<a class="el" href="xxhash64_8h_source.html">xxhash64.h</a></li>
+</ul>
+</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>