deploy: e841a7f

Callidon · Jun 11, 2024 · 3a2b157 · 3a2b157
1 parent 1e79207
commit 3a2b157
Show file tree

Hide file tree

Showing 50 changed files with 455 additions and 457 deletions.
diff --git a/assets/main.js b/assets/main.js
diff --git a/assets/search.js b/assets/search.js
diff --git a/assets/style.css b/assets/style.css
@@ -766,12 +766,13 @@ footer .tsd-legend {
 
 .tsd-flag {
     display: inline-block;
-    padding: 1px 5px;
+    padding: 0.25em 0.4em;
     border-radius: 4px;
     color: var(--color-comment-tag-text);
     background-color: var(--color-comment-tag);
     text-indent: 0;
-    font-size: 14px;
+    font-size: 75%;
+    line-height: 1;
     font-weight: normal;
 }
 

diff --git a/classes/BaseFilter.html b/classes/BaseFilter.html
diff --git a/classes/BitSet.html b/classes/BitSet.html
diff --git a/classes/BloomFilter.html b/classes/BloomFilter.html
diff --git a/classes/Cell.html b/classes/Cell.html
diff --git a/classes/CountMinSketch.html b/classes/CountMinSketch.html
diff --git a/classes/CountingBloomFilter.html b/classes/CountingBloomFilter.html
diff --git a/classes/CuckooFilter.html b/classes/CuckooFilter.html
diff --git a/classes/DeprecatedHashing.html b/classes/DeprecatedHashing.html
diff --git a/classes/Hashing.html b/classes/Hashing.html
diff --git a/classes/HyperLogLog.html b/classes/HyperLogLog.html
diff --git a/classes/InvertibleBloomFilter.html b/classes/InvertibleBloomFilter.html
diff --git a/classes/MinHash.html b/classes/MinHash.html
diff --git a/classes/MinHashFactory.html b/classes/MinHashFactory.html
diff --git a/classes/PartitionedBloomFilter.html b/classes/PartitionedBloomFilter.html
diff --git a/classes/ScalableBloomFilter.html b/classes/ScalableBloomFilter.html
diff --git a/classes/TopK.html b/classes/TopK.html
diff --git a/classes/XorFilter.html b/classes/XorFilter.html
diff --git a/classes/_internal_.Long.html b/classes/_internal_.Long.html
diff --git a/classes/_internal_.MinHeap.html b/classes/_internal_.MinHeap.html
diff --git a/classes/_internal_.default-3.html b/classes/_internal_.default-3.html
diff --git a/index.html b/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>bloom-filters - v3.0.1</title><meta name="description" content="Documentation for bloom-filters - v3.0.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">bloom-filters - v3.0.1</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>bloom-filters - v3.0.1</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>bloom-filters - v3.0.2</title><meta name="description" content="Documentation for bloom-filters - v3.0.2"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">bloom-filters - v3.0.2</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>bloom-filters - v3.0.2 </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
 <a href="#bloom-filters-" id="bloom-filters-" style="color: inherit; text-decoration: none;">
   <h1>Bloom-Filters <a href="https://github.com/Callidon/bloom-filters/actions"><img src="https://github.com/callidon/bloom-filters/actions/workflows/npm_test_doc.yml/badge.svg" alt="Master"></a></h1>
 </a>
@@ -87,7 +87,7 @@ <h3>Partitioned Bloom Filter</h3>
 Thus, each element is described by exactly <code>k</code> bits, meaning the distribution of false positives is uniform across all elements.</p>
 <p>Be careful, as a Partitioned Bloom Filter have much higher collison risks that a classic Bloom Filter on small sets of data.</p>
 <p><strong>Reference:</strong> Chang, F., Feng, W. C., &amp; Li, K. (2004, March). <em>Approximate caches for packet classification.</em> In INFOCOM 2004. Twenty-third AnnualJoint Conference of the IEEE Computer and Communications Societies (Vol. 4, pp. 2196-2207). IEEE.
-(<a href="http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.153.6902&amp;rep=rep1&amp;type=pdf">Full text article</a>)</p>
+(<a href="http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.153.6902&rep=rep1&type=pdf">Full text article</a>)</p>
 
 <a href="#methods-1" id="methods-1" style="color: inherit; text-decoration: none;">
   <h4>Methods</h4>
@@ -107,7 +107,7 @@ <h3>Scalable Bloom Filter</h3>
 <p>A Scalable Bloom Filter is a variant of Bloom Filters that can adapt dynamically to the
 number of elements stored, while assuring a maximum false positive probability</p>
 <p><strong>Reference:</strong> ALMEIDA, Paulo Sérgio, BAQUERO, Carlos, PREGUIÇA, Nuno, et al. Scalable bloom filters. Information Processing Letters, 2007, vol. 101, no 6, p. 255-261.
-(<a href="https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.725.390&amp;rep=rep1&amp;type=pdf">Full text article</a>)</p>
+(<a href="https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.725.390&rep=rep1&type=pdf">Full text article</a>)</p>
 <p>This filter use internally <a href="#partitioned-bloom-filter">Paritionned Bloom Filters</a>.</p>
 
 <a href="#methods-2" id="methods-2" style="color: inherit; text-decoration: none;">
@@ -216,7 +216,7 @@ <h3>MinHash</h3>
 <li>Two MinHash can be compared <strong>only if they share the same set of randomly generated hash functions</strong>. To ease the creation of MinHash sets, we introduce a <code>MinHashFactory</code> class that is able to create MinHash structures that <em>share the same set of hash functions</em>. We recommend most users <strong>to rely on the factory</strong>, but the <code>MinHash</code> class remains importable for advanced usage.</li>
 </ul>
 <p><strong>Reference:</strong> Andrei Z. Broder, <em>&quot;On the resemblance and containment of documents&quot;</em>, in Compression and Complexity of Sequences: Proceedings (1997).
-(<a href="https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.24.779&amp;rep=rep1&amp;type=pdf">Full text article</a>)</p>
+(<a href="https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.24.779&rep=rep1&type=pdf">Full text article</a>)</p>
 
 <a href="#minhashfactory-methods" id="minhashfactory-methods" style="color: inherit; text-decoration: none;">
   <h4><code>MinHashFactory</code> methods</h4>
@@ -354,15 +354,15 @@ <h2>References</h2>
 </a>
 <ul>
 <li><a href="http://crystal.uta.edu/~mcguigan/cse6350/papers/Bloom.pdf">Classic Bloom Filter</a>: Bloom, B. H. (1970). <em>Space/time trade-offs in hash coding with allowable errors.</em> Communications of the ACM, 13(7), 422-426.</li>
-<li><a href="http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.153.6902&amp;rep=rep1&amp;type=pdf">Partitioned Bloom Filter</a>: Chang, F., Feng, W. C., &amp; Li, K. (2004, March). <em>Approximate caches for packet classification.</em> In INFOCOM 2004. Twenty-third AnnualJoint Conference of the IEEE Computer and Communications Societies (Vol. 4, pp. 2196-2207). IEEE.</li>
+<li><a href="http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.153.6902&rep=rep1&type=pdf">Partitioned Bloom Filter</a>: Chang, F., Feng, W. C., &amp; Li, K. (2004, March). <em>Approximate caches for packet classification.</em> In INFOCOM 2004. Twenty-third AnnualJoint Conference of the IEEE Computer and Communications Societies (Vol. 4, pp. 2196-2207). IEEE.</li>
 <li><a href="https://www.cs.cmu.edu/~dga/papers/cuckoo-conext2014.pdf">Cuckoo Filter</a>: Fan, B., Andersen, D. G., Kaminsky, M., &amp; Mitzenmacher, M. D. (2014, December). <em>Cuckoo filter: Practically better than bloom.</em> In Proceedings of the 10th ACM International on Conference on emerging Networking Experiments and Technologies (pp. 75-88). ACM.</li>
 <li><a href="http://www.eecs.harvard.edu/~michaelm/postscripts/esa2006b.pdf">Counting Bloom Filter</a>: F. Bonomi, M. Mitzenmacher, R. Panigrahy, S. Singh, and G. Varghese, <em>An Improved Construction for Counting Bloom Filters</em>, in 14th Annual European Symposium on Algorithms, LNCS 4168, 2006, pp.</li>
 <li><a href="http://vaffanculo.twiki.di.uniroma1.it/pub/Ing_algo/WebHome/p14_Cormode_JAl_05.pdf">Count Min Sketch</a>: Cormode, G., &amp; Muthukrishnan, S. (2005). <em>An improved data stream summary: the count-min sketch and its applications.</em> Journal of Algorithms, 55(1), 58-75.</li>
 <li><a href="http://algo.inria.fr/flajolet/Publications/FlFuGaMe07.pdf">HyperLogLog</a>: Philippe Flajolet, Éric Fusy, Olivier Gandouet and Frédéric Meunier (2007). <em>&quot;Hyperloglog: The analysis of a near-optimal cardinality estimation algorithm&quot;</em>. Discrete Mathematics and Theoretical Computer Science Proceedings.</li>
-<li><a href="https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.24.779&amp;rep=rep1&amp;type=pdf">MinHash</a>: Andrei Z. Broder, <em>&quot;On the resemblance and containment of documents&quot;</em>, in Compression and Complexity of Sequences: Proceedings (1997).</li>
+<li><a href="https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.24.779&rep=rep1&type=pdf">MinHash</a>: Andrei Z. Broder, <em>&quot;On the resemblance and containment of documents&quot;</em>, in Compression and Complexity of Sequences: Proceedings (1997).</li>
 <li><a href="http://www.sysnet.ucsd.edu/sysnet/miscpapers/EppGooUye-SIGCOMM-11.pdf">Invertible Bloom Filters</a>: Eppstein, D., Goodrich, M. T., Uyeda, F., &amp; Varghese, G. (2011). <em>What&#39;s the difference?: efficient set reconciliation without prior context.</em> ACM SIGCOMM Computer Communication Review, 41(4), 218-229.</li>
 <li><a href="https://arxiv.org/abs/1912.08258">Xor Filters: Faster and Smaller Than Bloom and Cuckoo Filters</a> Thomas Mueller Graf, Daniel Lemire, Journal of Experimental Algorithmics 25 (1), 2020. DOI: 10.1145/3376122</li>
-<li><a href="https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.725.390&amp;rep=rep1&amp;type=pdf">Scalable Bloom Filters</a> ALMEIDA, Paulo Sérgio, BAQUERO, Carlos, PREGUIÇA, Nuno, et al. <em>Scalable bloom filters</em>. Information Processing Letters, 2007, vol. 101, no 6, p. 255-261.</li>
+<li><a href="https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.725.390&rep=rep1&type=pdf">Scalable Bloom Filters</a> ALMEIDA, Paulo Sérgio, BAQUERO, Carlos, PREGUIÇA, Nuno, et al. <em>Scalable bloom filters</em>. Information Processing Letters, 2007, vol. 101, no 6, p. 255-261.</li>
 </ul>
 
 <a href="#changelog" id="changelog" style="color: inherit; text-decoration: none;">