From 49815fce99d0226885e25187f9e27a208f210884 Mon Sep 17 00:00:00 2001
From: rlar <rlar>
Date: Sun, 15 Jan 2012 17:19:35 +0000
Subject: [PATCH] bug fix, a numerical problem in the hisim2 an hisimhv models

---
 ChangeLog                                | 51 ++++++++++++++++++++++++
 src/spicelib/devices/hisim2/hsm2eval.c   |  2 +
 src/spicelib/devices/hisim2/hsm2temp.c   |  2 +
 src/spicelib/devices/hisimhv/hsmhveval.c |  2 +
 4 files changed, 57 insertions(+)

diff --git a/ChangeLog b/ChangeLog
index 2930f0ee9..c3c5afd1f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,54 @@
+2012-01-15  Robert Larice
+ * src/spicelib/devices/hisim2/hsm2eval.c ,
+ * src/spicelib/devices/hisim2/hsm2temp.c ,
+ * src/spicelib/devices/hisimhv/hsmhveval.c :
+  bug fix, a numerical problem in the hisim2 an hisimhv models
+
+  First seen when compiled with gcc-4.6.2 -g -O1
+
+  The macro `Fn_SZ' which boils down to
+    1/2 * (x + sqrt(x*x + c*c))
+  was used in a context where a negative result
+    blew up the following computations.
+  (used to compute `Egidl', which is used to
+   compute exp(-1 / (Egidl + small_constant)))
+
+  For large negative values of x the computation
+  boils down to
+    1/2 ( x + almost(|x|) )
+  where the summands almost cancel each other,
+  sometimes yielding a small negative result.
+
+  small_constant was too small to avoid a big
+    result for -1/(Egidl + small_constant)
+  yielding an `inf' during the exp() computation,
+  which was later multiplied with a `0'
+    yielding a NaN,
+  which was carried forward
+    during the rest of computations.
+
+  Because the error of the cancellation scales
+  with the magnitude of x, no larger `small_constant'
+  could have avoided the problem.
+
+  Presumably the problem was amplified
+    by a mixture of precisions (double versus extended float)
+    of intermediate values.
+  (the program wasn't compiled for sse)
+
+  ( x was -2.812500e+06,
+    c was  1.000000e-02,
+    Fn_SZ result was -1.853095e-11
+
+    thus the cancellation remainder
+    was of relative size
+      6.6e-18
+    which is approximately
+      2^-57
+    and thus more accurate
+     as a `double float' could have delivered
+  )
+
 2012-01-15  Robert Larice
  * tests/bin/modelQaTestRoutines.pm ,
  * tests/bin/runQaTests.pl :
diff --git a/src/spicelib/devices/hisim2/hsm2eval.c b/src/spicelib/devices/hisim2/hsm2eval.c
index 8cbb77d17..a6e96b395 100644
--- a/src/spicelib/devices/hisim2/hsm2eval.c
+++ b/src/spicelib/devices/hisim2/hsm2eval.c
@@ -233,6 +233,8 @@ double TMF1 , TMF2 , TMF3 , TMF4 ;
     TMF2 = sqrt ( ( x ) *  ( x ) + 4.0 * ( delta ) * ( delta) ) ; \
     dx = 0.5 * ( 1.0 + ( x ) / TMF2 ) ; \
     y = 0.5 * ( ( x ) + TMF2 ) ; \
+    if (y < 0) \
+        y = 0 ; \
   }
 
 /*---------------------------------------------------*
diff --git a/src/spicelib/devices/hisim2/hsm2temp.c b/src/spicelib/devices/hisim2/hsm2temp.c
index 2f2f8fa55..8ce4f9bef 100644
--- a/src/spicelib/devices/hisim2/hsm2temp.c
+++ b/src/spicelib/devices/hisim2/hsm2temp.c
@@ -41,6 +41,8 @@
 #define Fn_SZtemp( y , x , delta ) { \
     T1 = sqrt ( ( x ) *  ( x ) + 4.0 * ( delta ) * ( delta) ) ; \
     y = 0.5 * ( ( x ) + T1 ) ; \
+    if (y < 0) \
+        y = 0 ; \
   }
 
 #define Fn_SUtemp( y , x , xmax , delta ) { \
diff --git a/src/spicelib/devices/hisimhv/hsmhveval.c b/src/spicelib/devices/hisimhv/hsmhveval.c
index 9b727ff92..79a5ac3c2 100644
--- a/src/spicelib/devices/hisimhv/hsmhveval.c
+++ b/src/spicelib/devices/hisimhv/hsmhveval.c
@@ -246,6 +246,8 @@ double TMF0 , TMF1 , TMF2 , TMF3 , TMF4 , TMF5 , TMF6 ;
     TMF2 = sqrt ( ( x ) *  ( x ) + 4.0 * ( delta ) * ( delta) ) ; \
     dx = 0.5 * ( 1.0 + ( x ) / TMF2 ) ; \
     y = 0.5 * ( ( x ) + TMF2 ) ; \
+    if (y < 0) \
+        y = 0 ; \
   }