Rendering check

lizmat · May 31, 2024 · 065ffa0 · 065ffa0
1 parent a97e2ce
commit 065ffa0
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -713,6 +713,34 @@ The algorithm for batch size calculation is pretty simple at the moment. To allo
 
 If a batch took almost exactly that amount of time to produce values, then the size of that batch is assumed to be the optimum size. If the batch took longer, then the batch size should be reduced. If the batch took less than that to complete, then the batch size should be increased.
 
+Decision tree
+-------------
+
+      source
+       \- hyperize
+           |- invocant (degree == 1)
+           |- Seq      (source exhausted with initial batch)
+           |- ParaSeq
+               \- method call
+                   |- endpoint
+                   |- coercer
+                   |- hypering
+
+Hypering control flow
+---------------------
+
+                                  ------------
+                                  | producer |
+                                  ------------
+                                ⬈
+    -------------   -----------   ------------
+    | deliverer | ⮕ | batcher | ⮕ | producer |
+    -------------   -----------   ------------
+         ⬇                      ⬊
+      values                      ------------
+                                  | producer |
+                                  ------------
+
 AUTHOR
 ======
 

diff --git a/doc/ParaSeq.rakudoc b/doc/ParaSeq.rakudoc
@@ -921,6 +921,37 @@ the batch took longer, then the batch size should be reduced.  If
 the batch took less than that to complete, then the batch size should
 be increased.
 
+=head2 Decision tree
+
+=begin code
+  source
+   \- hyperize
+       |- invocant (degree == 1)
+       |- Seq      (source exhausted with initial batch)
+       |- ParaSeq
+           \- method call
+               |- endpoint
+               |- coercer
+               |- hypering
+=end code
+
+=head2 Hypering control flow
+
+=begin code
+                              ------------
+                              | producer |
+                              ------------
+                            ⬈
+-------------   -----------   ------------
+| deliverer | ⮕ | batcher | ⮕ | producer |
+-------------   -----------   ------------
+     ⬇                      ⬊
+  values                      ------------
+                              | producer |
+                              ------------
+
+=end code
+
 =head1 AUTHOR
 
 Elizabeth Mattijsen <liz@raku.rocks>