From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Mon, 8 Jul 2019 13:41:20 +0000 (+0100)
Subject: add test comment
X-Git-Tag: ls180-24jan2020~863
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=5e587b9d69c5efb9aa24e93bc9448fbafa7ec622;p=ieee754fpu.git

add test comment
---

diff --git a/src/ieee754/fpcommon/test/case_gen.py b/src/ieee754/fpcommon/test/case_gen.py
index 1e81f341..2c422967 100644
--- a/src/ieee754/fpcommon/test/case_gen.py
+++ b/src/ieee754/fpcommon/test/case_gen.py
@@ -1,3 +1,22 @@
+"""FP Unit Test Infrastructure
+
+allows testing of:
+
+* random range against random range
+* +/- 0, +/- inf, +/- NaN permutations, all tested against all permutations
+* all of those permutations (+/- 0/inf/NaN) against the following:
+- nearly zero (random variations)
+- minimum non-zero exponent (random variations)
+- nearly infinite (random variations)
+- random versions of NaN (noncanonical NaN)
+- random numbers (at the full range)
+
+inversion of permutations also done, where appropriate (A,B and B,A)
+
+single-operand version also supported
+
+"""
+
 from ieee754.fpcommon.test.fpmux import runfp, repeat, pipe_cornercases_repeat
 
 from random import randint