From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Thu, 14 Feb 2019 12:46:03 +0000 (+0000)
Subject: add FPNum comment
X-Git-Tag: ls180-24jan2020~2001
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=82de8d38c838bcffb494b06336533d1e795cb453;p=ieee754fpu.git

add FPNum comment
---

diff --git a/src/add/nmigen_add_experiment.py b/src/add/nmigen_add_experiment.py
index bbadfc0e..68d15bd4 100644
--- a/src/add/nmigen_add_experiment.py
+++ b/src/add/nmigen_add_experiment.py
@@ -7,6 +7,12 @@ from nmigen.cli import main
 
 
 class FPNum:
+    """ Floating-point Number Class, variable-width TODO (currently 32-bit)
+        Contains signals for an incoming copy of the value, decoded into
+        sign / exponent / mantissa.
+        Also contains encoding functions, creation and recognition of
+        zero, NaN and inf (all signed)
+    """
     def __init__(self, width, m_width=None):
         self.width = width
         if m_width is None: