big renaming

Author: tomaskulich

README.md

@@ -9,7 +9,7 @@ The project is forked from
 *Persistent* data structure is an immutable structure; the main difference with standard data structures is how you 'write' to them: instead of mutating
 the old structure, you create the new, independent, (slightly) modified copy of it. Typical examples of commonly used Persistent structures are String (in Java, Javascript, Python, Ruby) or Python's Tuple or Java's BigDecimal. [(Not only)](http://www.infoq.com/presentations/Value-Identity-State-Rich-Hickey) we believe such concept could be beneficial also for other data structures such as Maps, Lists/Vectors, Sets.
 
-     var couple = new PersistentMap.fromMap({'father': 'Homer', 'mother': 'Marge'});
+     var couple = new PMap.fromMap({'father': 'Homer', 'mother': 'Marge'});
      // do not (and can not) modify couple anymore
      var withChild = couple.assoc('boy', 'Bart');
      print(couple); // {mother: Marge, father: Homer}
@@ -28,8 +28,8 @@ got a 'great' idea, that instead of just computing response length he also mutat
 Finally, they work as you'd expect. How cool is this:
 
     // deeply persist the structure of Maps and Lists
-    var a = persist({[1,2]: 'tower', [1,3]: 'water'});
-    var b = persist({[1,2]: 'tower', [1,3]: 'water'});
+    PMap a = persist({[1,2]: 'tower', [1,3]: 'water'});
+    PMap b = persist({[1,2]: 'tower', [1,3]: 'water'});
     assert(a==b); 
     // kids, don't try this with standard List, it ain't going to work
     print(a[persist([1, 2])]); // prints 'tower'
@@ -48,21 +48,24 @@ One possible workaround would be to JSONize entries to string and use such strin
 Fast copying or equality done right are nice features, but this is not the only selling point here. Having different ways how to copy (shallow, deep) objects or how to compare them (== vs. equals in Java) introduces new complexity. Even if you get used to it, it still takes some part of your mental capabilities and can lead to errors.
 
 ### Structure sharing 
-    var map1 = persist({'a': 'something', 'b': bigMap});
-    var map2 = a.assoc('a', 'something completely different');
+    PMap map1 = persist({'a': 'something', 'b': bigMap});
+    PMap map2 = a.assoc('a', 'something completely different');
 Suppose you are interested, whether map1['b'] == map2['b']. Thanks to structure sharing, this is O(1) operation, which means it is amazingly fast - no need to traverse through the bigMap. Although it may sound unimportant at the first glance, it is what really enables fast caching of complex functions. Also, this is the reason, why [Om](https://github.com/swannodette/om/) framework is MUCH faster than Facebooks [React](http://facebook.github.io/react/).
 
 ## And what is the prize for this all
-Short version: size and speed. Although structure sharing makes the whole thing much more effective than naive copy-it-all approach, Persistents still are slower and bigger than their mutable counterparts. Following numbers illustrate, how much less efficient (in terms of speed or memory consumption) are Persistent data structures when benchmarking either on DartVM or Dart2JS on Node:
+In the 2.0 release, we optimized memory consumption such that the only penalty for using Persistent
+comes at lower speed. Although structure sharing makes the whole thing much more effective than naive
+copy-it-all approach, Persistents are still slower than their mutable counterparts (note however, that on
+the other hand, some operations runs significantly faster, so its hard to say something conclusive
+here). Following numbers illustrate, how much slow are Persistent data structures when benchmarking either on DartVM
+or Dart2JS on Node (the numbers are quite independent of the structure size):
 
-* DartVM memory: 2.5
-* Dart2JS memory: 6
 * DartVM read speed: 2
-* DartVM write speed: 2.5
-* Dart2JS read speed: 2
-* Dart2JS write speed: 4
+* DartVM write speed: 12 (5 by using Transients)
+* Dart2JS read speed: 3
+* Dart2JS write speed: 14 (6 by using Transients)
 
-The good part of the story is, that these numbers are not getting worse, as the Map grows - you get such performance even for Maps with tens of megabytes of data stored within them.
+Although the factors are quite big, the whole operation is still very fast and it probably won't be THE bottleneck which would slow down your app. 
 
 Some [advanced topics](https://github.com/vacuumlabs/persistent/wiki/Advanced-topics).
 

benchmark/map_memory/map_memory.dart

@@ -16,10 +16,10 @@ List data = [];
 
 var creators = {
 
-  "persistent": () => new PersistentMap.fromMap(template),
+  "persistent": () => new PMap.fromMap(template),
 
   "transient": (){
-    var res = new TransientMap();
+    var res = new TMap();
     template.forEach((k, v) => res.doAssoc(k, v));
     return res;
   },

benchmark/map_speed/interface_impl.dart

@@ -7,10 +7,10 @@
 part of map_bench;
 
 class PersistentMapInterface<K, V>
-  extends EncapsulatingInterface<K, V, PersistentMap<K, V>>{
+  extends EncapsulatingInterface<K, V, PMap<K, V>>{
 
   PersistentMapInterface(){
-    this.object = new PersistentMap<K, V>();
+    this.object = new PMap<K, V>();
   }
 
   assoc(K key, V value) =>
@@ -25,10 +25,10 @@ class PersistentMapInterface<K, V>
 
 
 class TransientMapInterface<K, V>
-  extends EncapsulatingInterface<K, V, TransientMap<K, V>>{
+  extends EncapsulatingInterface<K, V, TMap<K, V>>{
 
   TransientMapInterface(){
-    this.object = new PersistentMap<K, V>().asTransient();
+    this.object = new PMap<K, V>().asTransient();
   }
 
   assoc(K key, V value) =>
@@ -97,7 +97,7 @@ class LinkedListInterface<K, V>
     while (it.isCons) {
       Cons<Pair<K, V>> cons = it.asCons;
       Pair<K, V> elem = cons.elem;
-      if (elem.first == key) {
+      if (elem.fst == key) {
         builder.add(new Pair<K, V>(key, value));
         return builder.build(cons.tail);
       }
@@ -113,7 +113,7 @@ class LinkedListInterface<K, V>
     while (it.isCons) {
       Cons<Pair<K, V>> cons = it.asCons;
       Pair<K, V> elem = cons.elem;
-      if (elem.first == key) return;
+      if (elem.fst == key) return;
       it = cons.tail;
     }
   }

benchmark/map_speed/makefile

@@ -16,9 +16,9 @@ run: build/map_speed.js
 	@echo "Performing several insert, lookup and delete operations on flat maps."
 	@echo "The number of operations depends on the map size."
 
-#	@echo "--------"
-#	@echo "DartVM:"
-#	@dart map_speed.dart
+	@echo "--------"
+	@echo "DartVM:"
+	@dart map_speed.dart
 
 	@echo "--------"
 	@echo "NodeJS:"

benchmark/map_speed/map_speed.dart

@@ -16,22 +16,23 @@ part 'interface_impl.dart';
 
 Map interfaces = {
   "PersistentMap": () => new PersistentMapInterface(),
-  //"TransientMap": () => new TransientMapInterface(),
+  "TransientMap": () => new TransientMapInterface(),
   "Map": () => new StandardMapInterface(),
 };
 
-int times = 5;
+int times = 10;
 
 void main() {
   var config = [
    {'name': 'Write',
     'creator': ((sample, factory) => (new WriteBenchmark(sample, factory))),
-//    'sizes': [{10000: 1}],
+//    'sizes': [{10000: 1}, ],
     'sizes': [{500:60, 1000: 30, 1500: 20, 3000: 10}],
    },
    {
      'name': 'Read',
      'creator': ((sample, factory) => (new ReadBenchmark(sample, factory))),
+//     'sizes': [{10000: 1}, ],
      'sizes': [{500:60, 1000: 30, 1500: 20, 3000: 10}],
    }
   ];

benchmark/vector_memory/vector_memory.dart

@@ -15,7 +15,7 @@ List data = [];
 
 var creators = {
 
-  "persistent": () => new PersistentVector.from(template),
+  "persistent": () => new PVec.from(template),
 
   "list": () => new List.from(template),
 };

benchmark/vector_speed/interface_impl.dart

@@ -7,9 +7,9 @@
 part of vector_speed;
 
 class PersistentVectorInterface<E>
-  extends EncapsulatingInterface<E, PersistentVector<E>>{
+  extends EncapsulatingInterface<E, PVec<E>>{
 
-  create() => object = new PersistentVector<E>();
+  create() => object = new PVec<E>();
 
   push(E value) =>
     object = object.push(value);
@@ -25,9 +25,9 @@ class PersistentVectorInterface<E>
 
 
 class TransientVectorInterface<E>
-  extends EncapsulatingInterface<E, TransientVector<E>>{
+  extends EncapsulatingInterface<E, TVec<E>>{
 
-  create() => object = new PersistentVector<E>().asTransient();
+  create() => object = new PVec<E>().asTransient();
 
   push(E value) =>
     object.doPush(value);
@@ -39,7 +39,7 @@ class TransientVectorInterface<E>
   pop() => object.doPop();
 
   _copy(){
-    return new PersistentVector.from(object).asTransient();
+    return new PVec.from(object).asTransient();
   }
 }
 

example/overall_example.dart

@@ -9,7 +9,7 @@ library overall_example;
 import 'package:vacuum_persistent/persistent.dart';
 
 example(){
-  var couple = new PersistentMap.fromMap({'father': 'Homer', 'mother': 'Marge'});
+  var couple = new PMap.fromMap({'father': 'Homer', 'mother': 'Marge'});
   var withChild = couple.assoc('boy', 'Bart');
   print(couple); // {mother: Marge, father: Homer}
   print(withChild); // {boy: Bart, mother: Marge, father: Homer}
@@ -28,8 +28,8 @@ main() {
 
   // Persistency:
 
-  final map1 = new PersistentMap.fromMap({"a":1, "b":2});
-  final map2 = new PersistentMap.fromMap({"b":3, "c":4});
+  final map1 = new PMap.fromMap({"a":1, "b":2});
+  final map2 = new PMap.fromMap({"b":3, "c":4});
 
   print(map1["a"]); // 1
   print(map1.get("b")); // 2
@@ -48,7 +48,7 @@ main() {
 
   // Transiency:
 
-  final vector1 = new PersistentVector.from(["x", "y"]);
+  final vector1 = new PVec.from(["x", "y"]);
 
   print(vector1.push("z")); // (x, y, z)
   print(vector1.push("q")); // (x, y, q)

example/persistent_map_example.dart

@@ -8,9 +8,9 @@ library map_example;
 import 'package:vacuum_persistent/persistent.dart';
 
 main() {
-  final emptyMap = new PersistentMap<String,int>();
+  final emptyMap = new PMap<String,int>();
   final m1 = emptyMap.assoc('a', 1).assoc('b', 2);
-  final m2 = new PersistentMap<String,int>.fromMap({'a': 3, 'c': 4});
+  final m2 = new PMap<String,int>.fromMap({'a': 3, 'c': 4});
 
   print(m1);  // {a: 1, b: 2}
   print(m2);  // {c: 4, a: 3}

lib/src/cursor.dart

@@ -8,12 +8,12 @@ part of persistent;
 
 class Cursor {
   final Reference _ref;
-  final PersistentVector _path;
+  final PVec _path;
 
   Cursor(Reference this._ref, Iterable path) :
-    _path = (path is PersistentVector)? path: new PersistentVector.from(path);
+    _path = (path is PVec)? path: new PVec.from(path);
 
-  Cursor operator[](val) => new Cursor(_ref, conj(_path, val) as PersistentVector);
+  Cursor operator[](val) => new Cursor(_ref, conj(_path, val) as PVec);
 
   deref([notFound = _none]) => getIn(_ref.deref(), _path, notFound);