Merge pull request #492 from sebastiano-barrera/eduction

Add `eduction` and `completing`

Author: thomasmulvaney

pixie/stdlib.pxi

@@ -1884,6 +1884,35 @@ not enough elements were present."
             (when-let [s (seq coll)]
               (reductions f (f init (first s)) (rest s))))))))
 
+(defn completing
+  "Takes a reducing function f of 2 args and returns a fn suitable for
+  transduce by adding an arity-1 signature that calls cf (default -
+  identity) on the result argument."
+  ([f] (completing f identity))
+  ([f cf]
+     (fn
+       ([] (f))
+       ([x] (cf x))
+       ([x y] (f x y)))))
+
+(deftype Eduction [xform coll]
+   IReduce
+   (-reduce [self f init]
+     ;; NB (completing f) isolates completion of inner rf from outer rf
+     (transduce xform (completing f) init coll))
+
+   ISeqable
+   (-seq [self]
+       (reduce conj self)))
+
+(defn eduction
+  "Returns a reducible/iterable application of the transducers
+  to the items in coll. Transducers are applied in order as if
+  combined with comp. Note that these applications will be
+  performed every time reduce/iterator is called."
+  [& xforms]
+  (->Eduction (apply comp (butlast xforms)) (last xforms)))
+
 (defn destructure [binding expr]
   (cond
    (symbol? binding) [binding expr]

tests/pixie/tests/test-stdlib.pxi

@@ -574,6 +574,29 @@
   (t/assert= (take 5 (cycle '(1 2))) '(1 2 1 2 1))
   (t/assert= (take 3 (cycle [nil])) '(nil nil nil)))
 
+(t/deftest test-eduction
+  ;; one xform
+  (t/assert= [1 2 3 4 5]
+             (eduction (map inc) (range 5)))
+  ;; multiple xforms
+  (t/assert= ["2" "4"]
+             (eduction (map inc) (filter even?) (map str) (range 5)))
+  ;; materialize at the end
+  (t/assert= [1 1 2 1 2 3 1 2 3 4]
+             (vec (->> (range 5)
+                       (eduction (mapcat range) (map inc)))))
+  (t/assert= {1 4, 2 3, 3 2, 4 1}
+             (->> (range 5)
+                  (eduction (mapcat range) (map inc))
+                  frequencies))
+  (t/assert= ["tac" "god" "hsif" "drib" "kravdraa"]
+             (->> ["cat" "dog" "fish" "bird" "aardvark"]
+                  (eduction (map pixie.string/reverse))
+                  (seq)))
+  ;; expanding transducer with nils
+  (t/assert= '(1 2 3 nil 4 5 6 nil)
+             (eduction cat [[1 2 3 nil] [4 5 6 nil]])))
+
 (t/deftest test-trace
   (try
     (/ 0 0)