Merge branch 'master' into sis/add-serialize-deserialize-methods

Author: lemire

README.md

@@ -27,14 +27,47 @@ The following additional types are implemented, but less tested:
 
 ## Usage
 
-When using Maven:
+### Maven
+
+When using Maven: The latest version, 1.0.4, is not yet available on Maven central, see [issue #48](https://github.com/FastFilter/fastfilter_java/issues/48). However, it is available at https://jitpack.io/:
+
+    <repositories>
+        <repository>
+            <id>jitpack.io</id>
+            <url>https://jitpack.io</url>
+        </repository>
+    </repositories>
 
     <dependency>
-      <groupId>io.github.fastfilter</groupId>
-      <artifactId>fastfilter</artifactId>
-      <version>1.0.4</version>
+        <groupId>io.github.fastfilter</groupId>
+        <artifactId>fastfilter</artifactId>
+        <version>1.0.4</version>
     </dependency>
 
+### Gradle
+
+    repositories {
+        mavenCentral()
+        maven {
+            url 'https://jitpack.io'
+        }
+    }
+
+    dependencies {
+        implementation 'io.github.fastfilter.fastfilter_java:fastfilter:1.0.4'
+    }
+
+### Maven Central (version 1.0.2)
+
+The older version, 1.0.2, is available on Maven central.
+
+    <dependency>
+        <groupId>io.github.fastfilter</groupId>
+        <artifactId>fastfilter</artifactId>
+        <version>1.0.2</version>
+    </dependency>
+
+
 # Other Xor Filter Implementations
 
 * [C](https://github.com/FastFilter/xor_singleheader)

fastfilter/src/main/java/org/fastfilter/xor/XorBinaryFuse16.java

@@ -206,10 +206,9 @@ private void addAll(long[] keys) {
 
             if (hashIndex > 100) {
                 // if construction doesn't succeed eventually,
-                // then there is likely a problem with the hash function
-                // let us not crash the system:
-                Arrays.fill(fingerprints, (short) 0xFFFF);
-                return;
+                // then there is likely a problem with the hash function.
+                // It's better fail that either produce non-functional or incorrect filter.
+                throw new IllegalArgumentException("could not construct filter");
             }
             // use a new random number
             seed = Hash.randomSeed();

fastfilter/src/main/java/org/fastfilter/xor/XorBinaryFuse32.java

@@ -207,12 +207,9 @@ private void addAll(long[] keys) {
 
             if (hashIndex > 100) {
                 // if construction doesn't succeed eventually,
-                // then there is likely a problem with the hash function
-                // let us not crash the system:
-                for (int i = 0; i < fingerprints.length; i++) {
-                    fingerprints[i] = (int) 0xFFFFFFFF;
-                }
-                return;
+                // then there is likely a problem with the hash function.
+                // It's better fail that either produce non-functional or incorrect filter.
+                throw new IllegalArgumentException("could not construct filter");
             }
             // use a new random numbers
             seed = Hash.randomSeed();

fastfilter/src/main/java/org/fastfilter/xor/XorBinaryFuse8.java

@@ -207,12 +207,9 @@ private void addAll(long[] keys) {
 
             if (hashIndex > 100) {
                 // if construction doesn't succeed eventually,
-                // then there is likely a problem with the hash function
-                // let us not crash the system:
-                for(int i = 0; i < fingerprints.length; i++) {
-                    fingerprints[i] = (byte)0xFF;
-                }
-                return;
+                // then there is likely a problem with the hash function.
+                // It's better fail that either produce non-functional or incorrect filter.
+                throw new IllegalArgumentException("could not construct filter");
             }
             // use a new random numbers
             seed = Hash.randomSeed();