0.1.2 Throw if iterating over a transient set that has been mutated

Author: tonsky

CHANGES.md

@@ -0,0 +1,11 @@
+# 0.1.2
+
+Throw if iterating over a transient set that has been mutated.
+
+# 0.1.1
+
+Recompiled for Java 8.
+
+# 0.1.0
+
+Initial.

README.md

@@ -12,6 +12,13 @@ Almost a drop-in replacement for `clojure.core/sorted-set`, the only difference
 
 Implementations are provided for Clojure and ClojureScript.
 
+## Building
+
+```
+export JAVA8_HOME="/Library/Java/JavaVirtualMachines/jdk1.8.0_202.jdk/Contents/Home"
+lein jar
+```
+
 ## Support us
 
 <a href="https://www.patreon.com/bePatron?u=4230547"><img src="./extras/become_a_patron_button@2x.png" alt="Become a Patron!" width="217" height="51"></a>
@@ -21,7 +28,7 @@ Implementations are provided for Clojure and ClojureScript.
 Dependency:
 
 ```clj
-[persistent-sorted-set "0.1.0"]
+[persistent-sorted-set "0.1.2"]
 ```
 
 Code:

project.clj

@@ -1,11 +1,11 @@
-(defproject persistent-sorted-set "0.1.1"
-  :description "TODO"
+(defproject persistent-sorted-set "0.1.2"
+  :description "Fast B-tree based persistent sorted set for Clojure/Script"
   :license {:name "MIT"}
   :url "https://github.com/tonsky/persistent-sorted-set"
 
   :dependencies [
     [org.clojure/clojure       "1.10.0"   :scope "provided"]
-    [org.clojure/clojurescript "1.10.516" :scope "provided"]
+    [org.clojure/clojurescript "1.10.520" :scope "provided"]
   ]
 
   :plugins [
@@ -17,17 +17,18 @@
   :java-source-paths ["src-java"]
   :test-paths        ["test-clojure"]
 
-  :javac-options ["-target" "8" "-source" "8"]
+  :javac-options ["-target" "8" "-source" "8" "-bootclasspath" ~(str (or (System/getenv "JAVA8_HOME") (throw (Exception. "Please set JAVA8_HOME"))) "/jre/lib/rt.jar")]
+  :jvm-opts ["-ea"]
 
   :aliases {"test-all"  ["do" ["test"] ["test-cljs"]]
             "test-cljs" ["run" "-m" "me.tonsky.persistent-sorted-set.repl/run-tests"]
             "repl-cljs" ["run" "-m" "me.tonsky.persistent-sorted-set.repl/repl"]
             "bench"     ["trampoline" "with-profile" "+bench" "run" "-m" "me.tonsky.persistent_sorted_set.Bench"]}
 
   :profiles {
-    :1.9 { :dependencies [[org.clojure/clojure         "1.9.0"   :scope "provided"]
-                          [org.clojure/clojurescript   "1.9.946" :scope "provided"]] }
-    :bench { :dependencies [[com.datomic/datomic-free "0.9.5703"]]
-             :java-source-paths ["bench-java"] }
+    :1.9 {:dependencies [[org.clojure/clojure         "1.9.0"   :scope "provided"]
+                         [org.clojure/clojurescript   "1.9.946" :scope "provided"]] }
+    :bench {:dependencies [[com.datomic/datomic-free "0.9.5703"]]
+            :java-source-paths ["bench-java"] }
   }
 )

src-clojure/me/tonsky/persistent_sorted_set.clj

@@ -90,7 +90,7 @@
      (loop [nodes (mapv ->Leaf (split keys len Object avg max))]
        (case (count nodes)
          0 (PersistentSortedSet. cmp)
-         1 (PersistentSortedSet. {} cmp (first nodes) len edit)
+         1 (PersistentSortedSet. {} cmp (first nodes) len edit 0)
          (recur (mapv ->Node (split nodes (count nodes) Leaf avg max))))))))
 
 

src-java/me/tonsky/persistent_sorted_set/Chunk.java

@@ -5,14 +5,18 @@
 
 @SuppressWarnings("unchecked")
 class Chunk implements IChunk {
+  final PersistentSortedSet _set;
   final Object[] _keys;
   final int _idx, _end;
   final boolean _asc;
+  final int _version;
 
   Chunk(Seq seq) {
+    _set  = seq._set;
     _asc  = seq._asc;
     _idx  = seq._idx;
     _keys = seq._node._keys;
+    _version = seq._version;
     if (_asc) {
       int end = seq._node._len - 1;
       if (seq._keyTo != null)
@@ -28,20 +32,29 @@ class Chunk implements IChunk {
     }
   }
 
-  Chunk(Object[] keys, int idx, int end, boolean asc) {
+  Chunk(PersistentSortedSet set, Object[] keys, int idx, int end, boolean asc, int version) {
+    _set  = set;
     _keys = keys;
     _idx  = idx;
     _end  = end;
     _asc  = asc;
+    _version = version;
+  }
+
+  void checkVersion() {
+    if (_version != _set._version)
+      throw new RuntimeException("Tovarisch, you are iterating and mutating a transient set at the same time!");
   }
 
   public IChunk dropFirst() {
+    checkVersion();
     if (_idx == _end)
       throw new IllegalStateException("dropFirst of empty chunk");
-    return new Chunk(_keys, _asc ? _idx+1 : _idx-1, _end, _asc);
+    return new Chunk(_set, _keys, _asc ? _idx+1 : _idx-1, _end, _asc, _version);
   }
 
   public Object reduce(IFn f, Object start) {
+    checkVersion();
     Object ret = f.invoke(start, _keys[_idx]);
     if (ret instanceof Reduced)
       return ((Reduced) ret).deref();
@@ -61,17 +74,20 @@ public Object reduce(IFn f, Object start) {
   }
 
   public Object nth(int i) {
+    checkVersion();
     assert (i >= 0 && i < count());
     return _asc ? _keys[_idx + i] : _keys[_idx - i];
   }
 
   public Object nth(int i, Object notFound) {
+    checkVersion();
     if (i >= 0 && i < count())
       return nth(i);
     return notFound;
   }
 
   public int count() {
+    checkVersion();
     if (_asc) return _end - _idx + 1;
     else return _idx - _end + 1;
   }

src-java/me/tonsky/persistent_sorted_set/PersistentSortedSet.java

@@ -21,6 +21,7 @@ public static void setMaxLen(int maxLen) {
   Leaf _root;
   int _count;
   final Edit _edit;
+  int _version = 0;
 
   PersistentSortedSet() { this(null, RT.DEFAULT_COMPARATOR); }
   public PersistentSortedSet(Comparator cmp) { this(null, cmp); }
@@ -31,11 +32,12 @@ public PersistentSortedSet(IPersistentMap meta, Comparator cmp) {
     _count = 0;
   }
 
-  public PersistentSortedSet(IPersistentMap meta, Comparator cmp, Leaf root, int count, Edit edit) {
+  public PersistentSortedSet(IPersistentMap meta, Comparator cmp, Leaf root, int count, Edit edit, int version) {
     super(meta, cmp);
     _root  = root;
     _count = count;
     _edit  = edit;
+    _version = version;
   }
 
   void ensureEditable(boolean value) {
@@ -55,10 +57,10 @@ public Seq slice(Object from, Object to, Comparator cmp) {
     if (from == null) {
       while (true) {
         if (node instanceof Node) {
-          seq = new Seq(null, this,seq, node, 0, null, null, true);
+          seq = new Seq(null, this,seq, node, 0, null, null, true, _version);
           node = seq.child();
         } else {
-          seq = new Seq(null, this,seq, node, 0, to, cmp, true);
+          seq = new Seq(null, this,seq, node, 0, to, cmp, true, _version);
           return seq.over() ? null : seq;
         }
       }
@@ -69,10 +71,10 @@ public Seq slice(Object from, Object to, Comparator cmp) {
       if (idx < 0) idx = -idx-1;
       if (idx == node._len) return null;
       if (node instanceof Node) {
-        seq = new Seq(null, this,seq, node, idx, null, null, true);
+        seq = new Seq(null, this,seq, node, idx, null, null, true, _version);
         node = seq.child();
       } else { // Leaf
-        seq = new Seq(null, this,seq, node, idx, to, cmp, true);
+        seq = new Seq(null, this,seq, node, idx, to, cmp, true, _version);
         return seq.over() ? null : seq;
       }
     }
@@ -90,10 +92,10 @@ public Seq rslice(Object from, Object to, Comparator cmp) {
       while (true) {
         int idx = node._len-1;
         if (node instanceof Node) {
-          seq = new Seq(null, this,seq, node, idx, null, null, false);
+          seq = new Seq(null, this,seq, node, idx, null, null, false, _version);
           node = seq.child();
         } else {
-          seq = new Seq(null, this,seq, node, idx, to, cmp, false);
+          seq = new Seq(null, this,seq, node, idx, to, cmp, false, _version);
           return seq.over() ? null : seq;
         }
       }
@@ -103,15 +105,15 @@ public Seq rslice(Object from, Object to, Comparator cmp) {
       if (node instanceof Node) {
         int idx = node.searchLast(from, cmp) + 1;
         if (idx == node._len) --idx; // last or beyond, clamp to last
-        seq = new Seq(null, this,seq, node, idx, null, null, false);
+        seq = new Seq(null, this,seq, node, idx, null, null, false, _version);
         node = seq.child();
       } else { // Leaf
         int idx = node.searchLast(from, cmp);
         if (idx == -1) { // not in this, so definitely in prev
-          seq = new Seq(null, this,seq, node, 0, to, cmp, false);
+          seq = new Seq(null, this,seq, node, 0, to, cmp, false, _version);
           return seq.advance() ? seq : null;
         } else { // exact match
-          seq = new Seq(null, this,seq, node, idx, to, cmp, false);
+          seq = new Seq(null, this,seq, node, idx, to, cmp, false, _version);
           return seq.over() ? null : seq;
         }
       }
@@ -134,7 +136,7 @@ public String toString() {
   // IObj
   public PersistentSortedSet withMeta(IPersistentMap meta) {
     if(_meta == meta) return this;
-    return new PersistentSortedSet(meta, _cmp, _root, _count, _edit);
+    return new PersistentSortedSet(meta, _cmp, _root, _count, _edit, _version);
   }
 
   // Counted
@@ -178,15 +180,16 @@ public PersistentSortedSet cons(Object key, Comparator cmp) {
         _root = new Node(keys, nodes, 2, _edit);
       }
       _count++;
+      _version++;
       return this;
     }
 
     if (1 == nodes.length)
-      return new PersistentSortedSet(_meta, _cmp, nodes[0], _count+1, _edit);
+      return new PersistentSortedSet(_meta, _cmp, nodes[0], _count+1, _edit, _version+1);
 
     Object keys[] = new Object[] { nodes[0].maxKey(), nodes[1].maxKey() };
     Leaf newRoot = new Node(keys, nodes, 2, _edit);
-    return new PersistentSortedSet(_meta, _cmp, newRoot, _count+1, _edit);
+    return new PersistentSortedSet(_meta, _cmp, newRoot, _count+1, _edit, _version+1);
   }
 
   // IPersistentSet
@@ -200,20 +203,21 @@ public PersistentSortedSet disjoin(Object key, Comparator cmp) {
     // not in set
     if (UNCHANGED == nodes) return this;
     // in place update
-    if (nodes == EARLY_EXIT) { _count--; return this; }
+    if (nodes == EARLY_EXIT) { _count--; _version++; return this; }
     Leaf newRoot = nodes[1];
     if (_edit.editable()) {
       if (newRoot instanceof Node && newRoot._len == 1)
         newRoot = ((Node) newRoot)._children[0];
       _root = newRoot;
       _count--;
+      _version++;
       return this;
     }
     if (newRoot instanceof Node && newRoot._len == 1) {
       newRoot = ((Node) newRoot)._children[0];
-      return new PersistentSortedSet(_meta, _cmp, newRoot, _count-1, _edit);
+      return new PersistentSortedSet(_meta, _cmp, newRoot, _count-1, _edit, _version+1);
     }
-    return new PersistentSortedSet(_meta, _cmp, newRoot, _count-1, _edit);
+    return new PersistentSortedSet(_meta, _cmp, newRoot, _count-1, _edit, _version+1);
   }
 
   public boolean contains(Object key) {
@@ -223,7 +227,7 @@ public boolean contains(Object key) {
   // IEditableCollection
   public PersistentSortedSet asTransient() {
     ensureEditable(false);
-    return new PersistentSortedSet(_meta, _cmp, _root, _count, new Edit(true));
+    return new PersistentSortedSet(_meta, _cmp, _root, _count, new Edit(true), _version);
   }
 
   // ITransientCollection