lib/libm/common_source/erf.c

   1 /*-
   2  * Copyright (c) 1992, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  * @(#)erf.c    8.1 (Berkeley) 6/4/93
  34  */
  35
  36 /* Modified Nov 30, 1992 P. McILROY:
  37  *      Replaced expansions for x >= 1.25 (error 1.7ulp vs ~6ulp)
  38  * Replaced even+odd with direct calculation for x < .84375,
  39  * to avoid destructive cancellation.
  40  *
  41  * Performance of erfc(x):
  42  * In 300000 trials in the range [.83, .84375] the
  43  * maximum observed error was 3.6ulp.
  44  *
  45  * In [.84735,1.25] the maximum observed error was <2.5ulp in
  46  * 100000 runs in the range [1.2, 1.25].
  47  *
  48  * In [1.25,26] (Not including subnormal results)
  49  * the error is < 1.7ulp.
  50  */
  51
  52 /* double erf(double x)
  53  * double erfc(double x)
  54  *                           x
  55  *                    2      |\
  56  *     erf(x)  =  ---------  | exp(-t*t)dt
  57  *                 sqrt(pi) \|
  58  *                           0
  59  *
  60  *     erfc(x) =  1-erf(x)
  61  *
  62  * Method:
  63  *      1. Reduce x to |x| by erf(-x) = -erf(x)
  64  *      2. For x in [0, 0.84375]
  65  *          erf(x)  = x + x*P(x^2)
  66  *          erfc(x) = 1 - erf(x)           if x<=0.25
  67  *                  = 0.5 + ((0.5-x)-x*P)  if x in [0.25,0.84375]
  68  *         where
  69  *                      2                2        4               20
  70  *              P =  P(x ) = (p0 + p1 * x + p2 * x + ... + p10 * x  )
  71  *         is an approximation to (erf(x)-x)/x with precision
  72  *
  73  *                                               -56.45
  74  *                      | P - (erf(x)-x)/x | <= 2
  75  *
  76  *
  77  *         Remark. The formula is derived by noting
  78  *          erf(x) = (2/sqrt(pi))*(x - x^3/3 + x^5/10 - x^7/42 + ....)
  79  *         and that
  80  *          2/sqrt(pi) = 1.128379167095512573896158903121545171688
  81  *         is close to one. The interval is chosen because the fixed
  82  *         point of erf(x) is near 0.6174 (i.e., erf(x)=x when x is
  83  *         near 0.6174), and by some experiment, 0.84375 is chosen to
  84  *         guarantee the error is less than one ulp for erf.
  85  *
  86  *      3. For x in [0.84375,1.25], let s = x - 1, and
  87  *         c = 0.84506291151 rounded to single (24 bits)
  88  *              erf(x)  = c  + P1(s)/Q1(s)
  89  *              erfc(x) = (1-c)  - P1(s)/Q1(s)
  90  *              |P1/Q1 - (erf(x)-c)| <= 2**-59.06
  91  *         Remark: here we use the taylor series expansion at x=1.
  92  *              erf(1+s) = erf(1) + s*Poly(s)
  93  *                       = 0.845.. + P1(s)/Q1(s)
  94  *         That is, we use rational approximation to approximate
  95  *                      erf(1+s) - (c = (single)0.84506291151)
  96  *         Note that |P1/Q1|< 0.078 for x in [0.84375,1.25]
  97  *         where
  98  *              P1(s) = degree 6 poly in s
  99  *              Q1(s) = degree 6 poly in s
 100  *
 101  *      4. For x in [1.25, 2]; [2, 4]
 102  *              erf(x)  = 1.0 - tiny
 103  *              erfc(x) = (1/x)exp(-x*x-(.5*log(pi) -.5z + R(z)/S(z))
 104  *
 105  *      Where z = 1/(x*x), R is degree 9, and S is degree 3;
 106  *
 107  *      5. For x in [4,28]
 108  *              erf(x)  = 1.0 - tiny
 109  *              erfc(x) = (1/x)exp(-x*x-(.5*log(pi)+eps + zP(z))
 110  *
 111  *      Where P is degree 14 polynomial in 1/(x*x).
 112  *
 113  *      Notes:
 114  *         Here 4 and 5 make use of the asymptotic series
 115  *                        exp(-x*x)
 116  *              erfc(x) ~ ---------- * ( 1 + Poly(1/x^2) );
 117  *                        x*sqrt(pi)
 118  *
 119  *              where for z = 1/(x*x)
 120  *              P(z) ~ z/2*(-1 + z*3/2*(1 + z*5/2*(-1 + z*7/2*(1 +...))))
 121  *
 122  *         Thus we use rational approximation to approximate
 123  *              erfc*x*exp(x*x) ~ 1/sqrt(pi);
 124  *
 125  *              The error bound for the target function, G(z) for
 126  *              the interval
 127  *              [4, 28]:
 128  *              |eps + 1/(z)P(z) - G(z)| < 2**(-56.61)
 129  *              for [2, 4]:
 130  *              |R(z)/S(z) - G(z)|       < 2**(-58.24)
 131  *              for [1.25, 2]:
 132  *              |R(z)/S(z) - G(z)|       < 2**(-58.12)
 133  *
 134  *      6. For inf > x >= 28
 135  *              erf(x)  = 1 - tiny  (raise inexact)
 136  *              erfc(x) = tiny*tiny (raise underflow)
 137  *
 138  *      7. Special cases:
 139  *              erf(0)  = 0, erf(inf)  = 1, erf(-inf) = -1,
 140  *              erfc(0) = 1, erfc(inf) = 0, erfc(-inf) = 2,
 141  *              erfc/erf(NaN) is NaN
 142  */
 143
 144 #if defined(vax) || defined(tahoe)
 145 #define _IEEE   0
 146 #define TRUNC(x) (double) (float) (x)
 147 #else
 148 #define _IEEE   1
 149 #define TRUNC(x) *(((int *) &x) + 1) &= 0xf8000000
 150 #define infnan(x) 0.0
 151 #endif
 152
 153 #ifdef _IEEE_LIBM
 154 /*
 155  * redefining "___function" to "function" in _IEEE_LIBM mode
 156  */
 157 #include "ieee_libm.h"
 158 #endif
 159
 160 static double
 161 tiny        = 1e-300,
 162 half        = 0.5,
 163 one         = 1.0,
 164 two         = 2.0,
 165 c           = 8.45062911510467529297e-01, /* (float)0.84506291151 */
 166 /*
 167  * Coefficients for approximation to erf in [0,0.84375]
 168  */
 169 p0t8 = 1.02703333676410051049867154944018394163280,
 170 p0 =   1.283791670955125638123339436800229927041e-0001,
 171 p1 =  -3.761263890318340796574473028946097022260e-0001,
 172 p2 =   1.128379167093567004871858633779992337238e-0001,
 173 p3 =  -2.686617064084433642889526516177508374437e-0002,
 174 p4 =   5.223977576966219409445780927846432273191e-0003,
 175 p5 =  -8.548323822001639515038738961618255438422e-0004,
 176 p6 =   1.205520092530505090384383082516403772317e-0004,
 177 p7 =  -1.492214100762529635365672665955239554276e-0005,
 178 p8 =   1.640186161764254363152286358441771740838e-0006,
 179 p9 =  -1.571599331700515057841960987689515895479e-0007,
 180 p10=   1.073087585213621540635426191486561494058e-0008;
 181 /*
 182  * Coefficients for approximation to erf in [0.84375,1.25]
 183  */
 184 static double
 185 pa0 =  -2.362118560752659485957248365514511540287e-0003,
 186 pa1 =   4.148561186837483359654781492060070469522e-0001,
 187 pa2 =  -3.722078760357013107593507594535478633044e-0001,
 188 pa3 =   3.183466199011617316853636418691420262160e-0001,
 189 pa4 =  -1.108946942823966771253985510891237782544e-0001,
 190 pa5 =   3.547830432561823343969797140537411825179e-0002,
 191 pa6 =  -2.166375594868790886906539848893221184820e-0003,
 192 qa1 =   1.064208804008442270765369280952419863524e-0001,
 193 qa2 =   5.403979177021710663441167681878575087235e-0001,
 194 qa3 =   7.182865441419627066207655332170665812023e-0002,
 195 qa4 =   1.261712198087616469108438860983447773726e-0001,
 196 qa5 =   1.363708391202905087876983523620537833157e-0002,
 197 qa6 =   1.198449984679910764099772682882189711364e-0002;
 198 /*
 199  * log(sqrt(pi)) for large x expansions.
 200  * The tail (lsqrtPI_lo) is included in the rational
 201  * approximations.
 202 */
 203 static double
 204    lsqrtPI_hi = .5723649429247000819387380943226;
 205 /*
 206  * lsqrtPI_lo = .000000000000000005132975581353913;
 207  *
 208  * Coefficients for approximation to erfc in [2, 4]
 209 */
 210 static double
 211 rb0  =  -1.5306508387410807582e-010,    /* includes lsqrtPI_lo */
 212 rb1  =   2.15592846101742183841910806188e-008,
 213 rb2  =   6.24998557732436510470108714799e-001,
 214 rb3  =   8.24849222231141787631258921465e+000,
 215 rb4  =   2.63974967372233173534823436057e+001,
 216 rb5  =   9.86383092541570505318304640241e+000,
 217 rb6  =  -7.28024154841991322228977878694e+000,
 218 rb7  =   5.96303287280680116566600190708e+000,
 219 rb8  =  -4.40070358507372993983608466806e+000,
 220 rb9  =   2.39923700182518073731330332521e+000,
 221 rb10 =  -6.89257464785841156285073338950e-001,
 222 sb1  =   1.56641558965626774835300238919e+001,
 223 sb2  =   7.20522741000949622502957936376e+001,
 224 sb3  =   9.60121069770492994166488642804e+001;
 225 /*
 226  * Coefficients for approximation to erfc in [1.25, 2]
 227 */
 228 static double
 229 rc0  =  -2.47925334685189288817e-007,   /* includes lsqrtPI_lo */
 230 rc1  =   1.28735722546372485255126993930e-005,
 231 rc2  =   6.24664954087883916855616917019e-001,
 232 rc3  =   4.69798884785807402408863708843e+000,
 233 rc4  =   7.61618295853929705430118701770e+000,
 234 rc5  =   9.15640208659364240872946538730e-001,
 235 rc6  =  -3.59753040425048631334448145935e-001,
 236 rc7  =   1.42862267989304403403849619281e-001,
 237 rc8  =  -4.74392758811439801958087514322e-002,
 238 rc9  =   1.09964787987580810135757047874e-002,
 239 rc10 =  -1.28856240494889325194638463046e-003,
 240 sc1  =   9.97395106984001955652274773456e+000,
 241 sc2  =   2.80952153365721279953959310660e+001,
 242 sc3  =   2.19826478142545234106819407316e+001;
 243 /*
 244  * Coefficients for approximation to  erfc in [4,28]
 245  */
 246 static double
 247 rd0  =  -2.1491361969012978677e-016,    /* includes lsqrtPI_lo */
 248 rd1  =  -4.99999999999640086151350330820e-001,
 249 rd2  =   6.24999999772906433825880867516e-001,
 250 rd3  =  -1.54166659428052432723177389562e+000,
 251 rd4  =   5.51561147405411844601985649206e+000,
 252 rd5  =  -2.55046307982949826964613748714e+001,
 253 rd6  =   1.43631424382843846387913799845e+002,
 254 rd7  =  -9.45789244999420134263345971704e+002,
 255 rd8  =   6.94834146607051206956384703517e+003,
 256 rd9  =  -5.27176414235983393155038356781e+004,
 257 rd10 =   3.68530281128672766499221324921e+005,
 258 rd11 =  -2.06466642800404317677021026611e+006,
 259 rd12 =   7.78293889471135381609201431274e+006,
 260 rd13 =  -1.42821001129434127360582351685e+007;
 261
 262 double erf(x)
 263         double x;
 264 {
 265         double R,S,P,Q,ax,s,y,z,r,fabs(),exp();
 266         if(!finite(x)) {                /* erf(nan)=nan */
 267             if (isnan(x))
 268                 return(x);
 269             return (x > 0 ? one : -one); /* erf(+/-inf)= +/-1 */
 270         }
 271         if ((ax = x) < 0)
 272                 ax = - ax;
 273         if (ax < .84375) {
 274             if (ax < 3.7e-09) {
 275                 if (ax < 1.0e-308)
 276                     return 0.125*(8.0*x+p0t8*x);  /*avoid underflow */
 277                 return x + p0*x;
 278             }
 279             y = x*x;
 280             r = y*(p1+y*(p2+y*(p3+y*(p4+y*(p5+
 281                         y*(p6+y*(p7+y*(p8+y*(p9+y*p10)))))))));
 282             return x + x*(p0+r);
 283         }
 284         if (ax < 1.25) {                /* 0.84375 <= |x| < 1.25 */
 285             s = fabs(x)-one;
 286             P = pa0+s*(pa1+s*(pa2+s*(pa3+s*(pa4+s*(pa5+s*pa6)))));
 287             Q = one+s*(qa1+s*(qa2+s*(qa3+s*(qa4+s*(qa5+s*qa6)))));
 288             if (x>=0)
 289                 return (c + P/Q);
 290             else
 291                 return (-c - P/Q);
 292         }
 293         if (ax >= 6.0) {                /* inf>|x|>=6 */
 294             if (x >= 0.0)
 295                 return (one-tiny);
 296             else
 297                 return (tiny-one);
 298         }
 299     /* 1.25 <= |x| < 6 */
 300         z = -ax*ax;
 301         s = -one/z;
 302         if (ax < 2.0) {
 303                 R = rc0+s*(rc1+s*(rc2+s*(rc3+s*(rc4+s*(rc5+
 304                         s*(rc6+s*(rc7+s*(rc8+s*(rc9+s*rc10)))))))));
 305                 S = one+s*(sc1+s*(sc2+s*sc3));
 306         } else {
 307                 R = rb0+s*(rb1+s*(rb2+s*(rb3+s*(rb4+s*(rb5+
 308                         s*(rb6+s*(rb7+s*(rb8+s*(rb9+s*rb10)))))))));
 309                 S = one+s*(sb1+s*(sb2+s*sb3));
 310         }
 311         y = (R/S -.5*s) - lsqrtPI_hi;
 312         z += y;
 313         z = exp(z)/ax;
 314         if (x >= 0)
 315                 return (one-z);
 316         else
 317                 return (z-one);
 318 }
 319
 320 double erfc(x)
 321         double x;
 322 {
 323         double R,S,P,Q,s,ax,y,z,r,fabs(),__exp__D();
 324         if (!finite(x)) {
 325                 if (isnan(x))           /* erfc(NaN) = NaN */
 326                         return(x);
 327                 else if (x > 0)         /* erfc(+-inf)=0,2 */
 328                         return 0.0;
 329                 else
 330                         return 2.0;
 331         }
 332         if ((ax = x) < 0)
 333                 ax = -ax;
 334         if (ax < .84375) {                      /* |x|<0.84375 */
 335             if (ax < 1.38777878078144568e-17)   /* |x|<2**-56 */
 336                 return one-x;
 337             y = x*x;
 338             r = y*(p1+y*(p2+y*(p3+y*(p4+y*(p5+
 339                         y*(p6+y*(p7+y*(p8+y*(p9+y*p10)))))))));
 340             if (ax < .0625) {   /* |x|<2**-4 */
 341                 return (one-(x+x*(p0+r)));
 342             } else {
 343                 r = x*(p0+r);
 344                 r += (x-half);
 345                 return (half - r);
 346             }
 347         }
 348         if (ax < 1.25) {                /* 0.84375 <= |x| < 1.25 */
 349             s = ax-one;
 350             P = pa0+s*(pa1+s*(pa2+s*(pa3+s*(pa4+s*(pa5+s*pa6)))));
 351             Q = one+s*(qa1+s*(qa2+s*(qa3+s*(qa4+s*(qa5+s*qa6)))));
 352             if (x>=0) {
 353                 z  = one-c; return z - P/Q;
 354             } else {
 355                 z = c+P/Q; return one+z;
 356             }
 357         }
 358         if (ax >= 28)   /* Out of range */
 359                 if (x>0)
 360                         return (tiny*tiny);
 361                 else
 362                         return (two-tiny);
 363         z = ax;
 364         TRUNC(z);
 365         y = z - ax; y *= (ax+z);
 366         z *= -z;                        /* Here z + y = -x^2 */
 367                 s = one/(-z-y);         /* 1/(x*x) */
 368         if (ax >= 4) {                  /* 6 <= ax */
 369                 R = s*(rd1+s*(rd2+s*(rd3+s*(rd4+s*(rd5+
 370                         s*(rd6+s*(rd7+s*(rd8+s*(rd9+s*(rd10
 371                         +s*(rd11+s*(rd12+s*rd13))))))))))));
 372                 y += rd0;
 373         } else if (ax >= 2) {
 374                 R = rb0+s*(rb1+s*(rb2+s*(rb3+s*(rb4+s*(rb5+
 375                         s*(rb6+s*(rb7+s*(rb8+s*(rb9+s*rb10)))))))));
 376                 S = one+s*(sb1+s*(sb2+s*sb3));
 377                 y += R/S;
 378                 R = -.5*s;
 379         } else {
 380                 R = rc0+s*(rc1+s*(rc2+s*(rc3+s*(rc4+s*(rc5+
 381                         s*(rc6+s*(rc7+s*(rc8+s*(rc9+s*rc10)))))))));
 382                 S = one+s*(sc1+s*(sc2+s*sc3));
 383                 y += R/S;
 384                 R = -.5*s;
 385         }
 386         /* return exp(-x^2 - lsqrtPI_hi + R + y)/x;     */
 387         s = ((R + y) - lsqrtPI_hi) + z;
 388         y = (((z-s) - lsqrtPI_hi) + R) + y;
 389         r = __exp__D(s, y)/x;
 390         if (x>0)
 391                 return r;
 392         else
 393                 return two-r;
 394 }