#2417 Explore reimplementing HashMap as CHAMP (Compressed Hash-Array Mapped Prefix-tree)

README.md

@@ -1,42 +1,32 @@
-# Vavr
+# vavr-champ
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
-[![GitHub Release](https://img.shields.io/github/release/vavr-io/vavr.svg?style=flat-square)](https://github.com/vavr-io/vavr/releases)
-[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.vavr/vavr/badge.svg?style=flat-square)](http://search.maven.org/#search|gav|1|g:"io.vavr"%20AND%20a:"vavr")
-[![Build Status](https://github.com/vavr-io/vavr/actions/workflows/build.yml/badge.svg)](https://github.com/vavr-io/vavr/actions/workflows/build.yml)
-[![Code Coverage](https://codecov.io/gh/vavr-io/vavr/branch/master/graph/badge.svg)](https://codecov.io/gh/vavr-io/vavr)
+vavr-champ is binary compatible with the vavr library, but uses CHAMP-based collections internally.
 
-<p align="center">
-  <img src="https://user-images.githubusercontent.com/743833/62367542-486f0500-b52a-11e9-815e-e9788d4c8c8d.png" alt="Vavr's custom image"/>
-</p>
+For more details see the [JavaDoc](https://www.randelshofer.ch/vavr/javadoc/):
 
-Vavr is an object-functional language extension to Java 8 that aims to reduce the number of lines of code and increase code quality.
-It provides persistent collections, functional abstractions for error handling, concurrent programming, pattern matching, and much more.
+- [HashMap](https://www.randelshofer.ch/vavr/javadoc/io/vavr/collection/HashMap.html)
 
-Vavr fuses the power of object-oriented programming with the elegance and robustness of functional programming.
-The most interesting part is a feature-rich, persistent collection library that smoothly integrates with Java's standard collections.
+- [HashSet](https://www.randelshofer.ch/vavr/javadoc/io/vavr/collection/HashSet.html
+  )
 
-Because Vavr does not depend on any libraries (other than the JVM), you can easily add it as a standalone .jar to your classpath.
+- [LinkedHashMap](https://www.randelshofer.ch/vavr/javadoc/io/vavr/collection/LinkedHashMap.html)
 
-### Stargazers over time
-[![Stargazers over time](https://starchart.cc/vavr-io/vavr.svg?variant=adaptive)](https://starchart.cc/vavr-io/vavr)
+- [LinkedHashSet](https://www.randelshofer.ch/vavr/javadoc/io/vavr/collection/LinkedHashSet.html)
 
+To use it instead of the original `vavr` library, you can specify `vavr-champ` as your dependency.
 
-## Using Vavr
+Maven:
 
-See [User Guide](http://docs.vavr.io) and/or [Javadoc](http://www.javadoc.io/doc/io.vavr/vavr).
+```
+<dependency>
+    <groupId>ch.randelshofer</groupId>
+    <artifactId>vavr-champ</artifactId>
+    <version>0.10.5</version>
+</dependency>
+```
 
-### Gradle tasks:
+Gradle:
 
-* Build: `./gradlew check`
-  * test reports: `./build/reports/tests/test/index.html`
-  * coverage reports: `./build/reports/jacoco/test/html/index.html`
-* Javadoc (linting): `./gradlew javadoc`
-
-### Contributing
-
-Currently, there are two significant branches:
-- `master` (represents a stream of work leading to the release of a new major version)
-- `version/0.x` (continues 0.10.4 with minor updates and bugfixes)
-
-A small number of users have reported problems building Vavr. Read our [contribution guide](./CONTRIBUTING.md) for details.
+```
+implementation group: 'ch.randelshofer', name: 'vavr-champ', version: '0.10.5'
+```

build.gradle

@@ -159,7 +159,7 @@ publishing {
             artifact tasks.named('testSourcesJar')
             pom {
                 name = project.name
-                description = "Vavr is an object-functional library for Java 8+"
+                description = "vavr-champ is binary compatible with vavr, but uses CHAMP-based collections internally."
                 url = 'https://www.vavr.io'
                 inceptionYear = '2014'
                 licenses {
@@ -170,22 +170,16 @@ publishing {
                 }
                 developers {
                     developer {
-                        name = 'Daniel Dietrich'
-                        email = '[email protected]'
-                        organization = 'Vavr'
-                        organizationUrl = 'https://github.com/vavr-io'
-                    }
-                    developer {
-                        name = 'Grzegorz Piwowarek'
-                        email = '[email protected]'
-                        organization = 'Vavr'
-                        organizationUrl = 'https://github.com/vavr-io'
+                        name = 'Werner Randelshofer'
+                        email = '[email protected]'
+                        organization = 'Werner Randelshofer'
+                        organizationUrl = 'https://www.randelshofer.ch'
                     }
                 }
                 scm {
-                    connection = 'scm:git:https://github.com/vavr-io/vavr.git'
-                    developerConnection = 'scm:git:https://github.com/vavr-io/vavr.git'
-                    url = 'https://github.com/vavr-io/vavr/tree/master'
+                    connection = 'scm:git:https://github.com/wrandelshofer/vavr.git'
+                    developerConnection = 'scm:git:https://github.com/wrandelshofer/vavr.git'
+                    url = 'https://github.com/wrandelshofer/vavr/tree/master'
                 }
             }
         }
@@ -205,7 +199,7 @@ nexusPublishing {
     repositories {
         sonatype {
             username.set(providers.systemProperty("ossrhUsername").orElse("").forUseAtConfigurationTime())
-            password.set(providers.systemProperty("ossrhPassword").orElse("").forUseAtConfigurationTime())
+            password.set(providers.systemProperty("ossrhPassword").orElse("").forUseAtConfigurationTime())        
         }
     }
 }

deployment/pom.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>ch.randelshofer</groupId>
+  <artifactId>vavr-champ</artifactId>
+  <version>0.10.5</version>
+  <packaging>jar</packaging>
+
+  <name>ch.randelshofer:vavr-champ</name>
+  <description>vavr-champ is binary compatible with vavr, but uses CHAMP-based collections internally.</description>
+  <url>https://github.com/wrandelshofer/vavr</url>
+
+  <licenses>
+    <license>
+      <name>MIT License</name>
+      <url>https://github.com/wrandelshofer/vavr/blob/b562173e641c75037bb8b7a3f929af997e8d3a5c/LICENSE</url>
+      <distribution>repo</distribution>
+    </license>
+  </licenses>
+
+  <developers>
+    <developer>
+      <name>Werner Randelshofer</name>
+      <email>[email protected]</email>
+      <organization>ch.randelshofer</organization>
+      <organizationUrl>http://www.randelshofer.ch</organizationUrl>
+    </developer>
+  </developers>
+
+  <scm>
+    <connection>scm:git:git://github.com/wrandelshofer/vavr.git</connection>
+    <developerConnection>scm:git:ssh://github.com/wrandelshofer/vavr.git</developerConnection>
+    <url>https://github.com/wrandelshofer/vavr/tree/master</url>
+  </scm>
+
+  <dependencies/>
+</project>

settings.gradle

@@ -1 +1 @@
-rootProject.name = 'vavr'
+rootProject.name = 'vavr-champ'

src-gen/main/java/io/vavr/API.java

@@ -30,14 +30,32 @@
    G E N E R A T O R   C R A F T E D
 \*-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
 
-import static io.vavr.API.Match.*;
-
-import io.vavr.collection.*;
+import io.vavr.collection.Array;
+import io.vavr.collection.CharSeq;
+import io.vavr.collection.HashMap;
+import io.vavr.collection.HashSet;
+import io.vavr.collection.IndexedSeq;
+import io.vavr.collection.Iterator;
+import io.vavr.collection.LinkedHashMap;
+import io.vavr.collection.LinkedHashSet;
+import io.vavr.collection.List;
+import io.vavr.collection.Map;
+import io.vavr.collection.PriorityQueue;
+import io.vavr.collection.Queue;
+import io.vavr.collection.Seq;
+import io.vavr.collection.Set;
+import io.vavr.collection.SortedMap;
+import io.vavr.collection.SortedSet;
+import io.vavr.collection.Stream;
+import io.vavr.collection.TreeMap;
+import io.vavr.collection.TreeSet;
+import io.vavr.collection.Vector;
 import io.vavr.concurrent.Future;
 import io.vavr.control.Either;
 import io.vavr.control.Option;
 import io.vavr.control.Try;
 import io.vavr.control.Validation;
+
 import java.io.PrintStream;
 import java.util.Comparator;
 import java.util.Formatter;
@@ -48,6 +66,26 @@
 import java.util.function.Predicate;
 import java.util.function.Supplier;
 
+import static io.vavr.API.Match.Case;
+import static io.vavr.API.Match.Case0;
+import static io.vavr.API.Match.Case1;
+import static io.vavr.API.Match.Case2;
+import static io.vavr.API.Match.Case3;
+import static io.vavr.API.Match.Case4;
+import static io.vavr.API.Match.Case5;
+import static io.vavr.API.Match.Case6;
+import static io.vavr.API.Match.Case7;
+import static io.vavr.API.Match.Case8;
+import static io.vavr.API.Match.Pattern0;
+import static io.vavr.API.Match.Pattern1;
+import static io.vavr.API.Match.Pattern2;
+import static io.vavr.API.Match.Pattern3;
+import static io.vavr.API.Match.Pattern4;
+import static io.vavr.API.Match.Pattern5;
+import static io.vavr.API.Match.Pattern6;
+import static io.vavr.API.Match.Pattern7;
+import static io.vavr.API.Match.Pattern8;
+
 /**
  * The most basic Vavr functionality is accessed through this API class.
  *
@@ -6081,7 +6119,7 @@ public static final class Case0<T, R> implements Case<T, R> {
             private static final long serialVersionUID = 1L;
 
             private final Pattern0<T> pattern;
-            private final Function<? super T, ? extends R> f;
+            private transient final Function<? super T, ? extends R> f;
 
             private Case0(Pattern0<T> pattern, Function<? super T, ? extends R> f) {
                 this.pattern = pattern;
@@ -6104,7 +6142,7 @@ public static final class Case1<T, T1, R> implements Case<T, R> {
             private static final long serialVersionUID = 1L;
 
             private final Pattern1<T, T1> pattern;
-            private final Function<? super T1, ? extends R> f;
+            private transient final Function<? super T1, ? extends R> f;
 
             private Case1(Pattern1<T, T1> pattern, Function<? super T1, ? extends R> f) {
                 this.pattern = pattern;
@@ -6127,7 +6165,7 @@ public static final class Case2<T, T1, T2, R> implements Case<T, R> {
             private static final long serialVersionUID = 1L;
 
             private final Pattern2<T, T1, T2> pattern;
-            private final BiFunction<? super T1, ? super T2, ? extends R> f;
+            private transient final BiFunction<? super T1, ? super T2, ? extends R> f;
 
             private Case2(Pattern2<T, T1, T2> pattern, BiFunction<? super T1, ? super T2, ? extends R> f) {
                 this.pattern = pattern;

src/main/java/META-INF/thirdparty-LICENSE

@@ -0,0 +1,56 @@
+----
+capsule
+https://github.com/usethesource/capsule
+https://github.com/usethesource/capsule/blob/3856cd65fa4735c94bcfa94ec9ecf408429b54f4/LICENSE
+
+BSD 2-Clause "Simplified" License
+
+Copyright (c) Michael Steindorfer <Centrum Wiskunde & Informatica> and Contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+----
+JHotDraw 8
+https://github.com/wrandelshofer/jhotdraw8
+https://github.com/wrandelshofer/jhotdraw8/blob/c49844aebd395b6a31eb5785aa58f6b6675fac6a/LICENSE
+
+MIT License
+
+Copyright © 2023 The authors and contributors of JHotDraw.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

src/main/java/io/vavr/collection/BitMappedTrie.java

@@ -28,6 +28,8 @@
 
 import java.io.Serializable;
 import java.util.NoSuchElementException;
+import java.util.Spliterators;
+import java.util.function.Consumer;
 import java.util.function.Function;
 import java.util.function.Predicate;
 
@@ -370,6 +372,65 @@ private <U> int map(Function<? super T, ? extends U> mapper, Object results, int
     }
 
     int length() { return length; }
+
+    static class BitMappedTrieSpliterator<T> extends Spliterators.AbstractSpliterator<T> {
+        private final int globalLength;
+        private int globalIndex;
+
+        private int index;
+        private Object leaf;
+        private int length;
+        private final BitMappedTrie<T> root;
+      private  T current;
+
+        public BitMappedTrieSpliterator(BitMappedTrie<T> root, int fromIndex, int characteristics) {
+            super(Math.max(0,root.length - fromIndex), characteristics);
+            this.root = root;
+            globalLength = root.length;
+            globalIndex = Math.max(0,fromIndex);
+            index = lastDigit(root.offset + globalIndex);
+            leaf = root.getLeaf(globalIndex);
+            length = root.type.lengthOf(leaf);
+        }
+        public boolean moveNext() {
+            if (globalIndex >= globalLength) {
+                return false;
+            }
+            if (index == length) {
+                setCurrentArray();
+            }
+            current = root.type.getAt(leaf, index);
+            index++;
+            globalIndex++;
+            return true;
+        }
+
+        public T current() {
+            return current;
+        }
+
+        public void skip(int count) {
+            globalIndex += count;
+            index = lastDigit(root.offset + globalIndex);
+            leaf = root.getLeaf(globalIndex);
+            length = root.type.lengthOf(leaf);
+        }
+
+        @Override
+        public boolean tryAdvance(Consumer<? super T> action) {
+            if (moveNext()){
+                action.accept(current);
+                return true;
+            }
+            return false;
+        }
+
+        private void setCurrentArray() {
+            index = 0;
+            leaf = root.getLeaf(globalIndex);
+            length = root.type.lengthOf(leaf);
+        }
+    }
 }
 
 @FunctionalInterface