From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Sat, 11 Dec 2021 15:57:05 +0000 (+0000)
Subject: more comments
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=94d69ca951c3c162973500f3ceb6b00d4b4a57f6;p=nmutil.git

more comments
reason: understanding lambda networks (aka butterfly aka generalised-rev)
is a bit of a pig
---

diff --git a/src/nmutil/grev.py b/src/nmutil/grev.py
index 4f19dd1..a0c3555 100644
--- a/src/nmutil/grev.py
+++ b/src/nmutil/grev.py
@@ -38,6 +38,8 @@ class GRev(Elaboratable):
             return Signal(self.width, name=f"step{i}")
         _steps = [step(i) for i in range(self.log2_width)]
 
+        # TODO: comment that this creates a full combinatorial chain
+        # of RADIX-2 butterfly-network "swappers"
         for i, step_o in enumerate(_steps):
             step_i = self.input if i == 0 else _steps[i - 1]
             # TODO explain that chunk swap-sizes jump by a power2 each time