aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorColin Okay <cbeok@protonmail.com>2020-07-09 08:11:00 -0500
committerColin Okay <cbeok@protonmail.com>2020-07-09 08:11:00 -0500
commit23696015dfe670971e2273720e2025e16853ab91 (patch)
tree5c05acc9f742ec5779199aa7c158d21cfb4f869f
parent97f068617c396d049f43a1fadf22580dc8305f46 (diff)
added docstrings to nfurcate! and partition!
-rw-r--r--gtwiwtg.lisp29
1 files changed, 29 insertions, 0 deletions
diff --git a/gtwiwtg.lisp b/gtwiwtg.lisp
index dd46f2e..3d03317 100644
--- a/gtwiwtg.lisp
+++ b/gtwiwtg.lisp
@@ -564,6 +564,18 @@ returns NIL."
(defun nfurcate! (count gen)
+ "EXERIMENTAL. MAY BE REMOVED
+
+Return a list of COUNT copies of GEN.
+
+Caveat:
+
+ - The generators produced by NFURCATE! allocate new memory as you
+ consume them. This allocation can be O(COUNT * SIZE) in space
+ complexity, where SIZE is the size of GEN. Hence, use with caution
+ on infinite generators.
+
+"
(make-dirty gen)
(let ((qs (loop :for _ :below count :collect (make-queue))))
(loop :for build-q :in qs
@@ -586,6 +598,23 @@ returns NIL."
(queue-empty-p local-q))))))))
(defun partition! (pred gen)
+ "EXPERIMENTAL. MAY BE REMOVED.
+
+Return a list of two generators that looks like (PASSING FAILING)
+
+PASSING is a generator that produces the values of GEN that pass the
+predicate PRED
+
+FAILING is a generator that produces the values of GEN that do not
+pass the predicate PRED
+
+Caveat:
+
+ - The generators produced by PARTITION! allocate new memory as you
+ consume them. This allocation may be O(2 * SIZE) in space
+ complexity, where SIZE is the size of GEN. Hence, use with caution
+ on infinite generators.
+"
(destructuring-bind (gen1 gen2) (nfurcate! 2 gen)
(list (filter! pred gen1)
(filter! (complement pred) gen2))))