add more to module docstring
authorLuke Kenneth Casson Leighton <lkcl@lkcl.net>
Fri, 24 Jan 2020 11:15:30 +0000 (11:15 +0000)
committerLuke Kenneth Casson Leighton <lkcl@lkcl.net>
Fri, 24 Jan 2020 11:15:30 +0000 (11:15 +0000)
src/ieee754/part/partsig.py

index df7ad7b648d552c3740f9ca8ffbfa10843d36982..f9675f75b4e40d10aa4e7c9b5acce29430b5ac35 100644 (file)
@@ -8,6 +8,11 @@ dynamic-partitionable class similar to Signal, which, when the partition
 is fully open will be identical to Signal.  when partitions are closed,
 the class turns into a SIMD variant of Signal.  *this is dynamic*.
 
+the basic fundamental idea is: write code once, and if you want a SIMD
+version of it, use PartitionedSignal in place of Signal.  job done.
+this however requires the code to *not* be designed to use nmigen.If,
+nmigen.Case, or other constructs: only Mux and other logic.
+
 http://bugs.libre-riscv.org/show_bug.cgi?id=132
 """