lib/libm/common_source/log1p.c

   1 /*
   2  * Copyright (c) 1985, 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  * @(#)log1p.c  8.1 (Berkeley) 6/4/93
  34  */
  35
  36 /* LOG1P(x)
  37  * RETURN THE LOGARITHM OF 1+x
  38  * DOUBLE PRECISION (VAX D FORMAT 56 bits, IEEE DOUBLE 53 BITS)
  39  * CODED IN C BY K.C. NG, 1/19/85;
  40  * REVISED BY K.C. NG on 2/6/85, 3/7/85, 3/24/85, 4/16/85.
  41  *
  42  * Required system supported functions:
  43  *      scalb(x,n)
  44  *      copysign(x,y)
  45  *      logb(x)
  46  *      finite(x)
  47  *
  48  * Required kernel function:
  49  *      log__L(z)
  50  *
  51  * Method :
  52  *      1. Argument Reduction: find k and f such that
  53  *                      1+x  = 2^k * (1+f),
  54  *         where  sqrt(2)/2 < 1+f < sqrt(2) .
  55  *
  56  *      2. Let s = f/(2+f) ; based on log(1+f) = log(1+s) - log(1-s)
  57  *               = 2s + 2/3 s**3 + 2/5 s**5 + .....,
  58  *         log(1+f) is computed by
  59  *
  60  *                      log(1+f) = 2s + s*log__L(s*s)
  61  *         where
  62  *              log__L(z) = z*(L1 + z*(L2 + z*(... (L6 + z*L7)...)))
  63  *
  64  *         See log__L() for the values of the coefficients.
  65  *
  66  *      3. Finally,  log(1+x) = k*ln2 + log(1+f).
  67  *
  68  *      Remarks 1. In step 3 n*ln2 will be stored in two floating point numbers
  69  *                 n*ln2hi + n*ln2lo, where ln2hi is chosen such that the last
  70  *                 20 bits (for VAX D format), or the last 21 bits ( for IEEE
  71  *                 double) is 0. This ensures n*ln2hi is exactly representable.
  72  *              2. In step 1, f may not be representable. A correction term c
  73  *                 for f is computed. It follows that the correction term for
  74  *                 f - t (the leading term of log(1+f) in step 2) is c-c*x. We
  75  *                 add this correction term to n*ln2lo to attenuate the error.
  76  *
  77  *
  78  * Special cases:
  79  *      log1p(x) is NaN with signal if x < -1; log1p(NaN) is NaN with no signal;
  80  *      log1p(INF) is +INF; log1p(-1) is -INF with signal;
  81  *      only log1p(0)=0 is exact for finite argument.
  82  *
  83  * Accuracy:
  84  *      log1p(x) returns the exact log(1+x) nearly rounded. In a test run
  85  *      with 1,536,000 random arguments on a VAX, the maximum observed
  86  *      error was .846 ulps (units in the last place).
  87  *
  88  * Constants:
  89  * The hexadecimal values are the intended ones for the following constants.
  90  * The decimal values may be used, provided that the compiler will convert
  91  * from decimal to binary accurately enough to produce the hexadecimal values
  92  * shown.
  93  */
  94
  95 #include <errno.h>
  96 #include "mathimpl.h"
  97
  98 vc(ln2hi, 6.9314718055829871446E-1  ,7217,4031,0000,f7d0,   0, .B17217F7D00000)
  99 vc(ln2lo, 1.6465949582897081279E-12 ,bcd5,2ce7,d9cc,e4f1, -39, .E7BCD5E4F1D9CC)
 100 vc(sqrt2, 1.4142135623730950622E0   ,04f3,40b5,de65,33f9,   1, .B504F333F9DE65)
 101
 102 ic(ln2hi, 6.9314718036912381649E-1,   -1, 1.62E42FEE00000)
 103 ic(ln2lo, 1.9082149292705877000E-10, -33, 1.A39EF35793C76)
 104 ic(sqrt2, 1.4142135623730951455E0,     0, 1.6A09E667F3BCD)
 105
 106 #ifdef vccast
 107 #define ln2hi   vccast(ln2hi)
 108 #define ln2lo   vccast(ln2lo)
 109 #define sqrt2   vccast(sqrt2)
 110 #endif
 111
 112 double log1p(x)
 113 double x;
 114 {
 115         const static double zero=0.0, negone= -1.0, one=1.0,
 116                       half=1.0/2.0, small=1.0E-20;   /* 1+small == 1 */
 117         double z,s,t,c;
 118         int k;
 119
 120 #if !defined(vax)&&!defined(tahoe)
 121         if(x!=x) return(x);     /* x is NaN */
 122 #endif  /* !defined(vax)&&!defined(tahoe) */
 123
 124         if(finite(x)) {
 125            if( x > negone ) {
 126
 127            /* argument reduction */
 128               if(copysign(x,one)<small) return(x);
 129               k=logb(one+x); z=scalb(x,-k); t=scalb(one,-k);
 130               if(z+t >= sqrt2 )
 131                   { k += 1 ; z *= half; t *= half; }
 132               t += negone; x = z + t;
 133               c = (t-x)+z ;             /* correction term for x */
 134
 135            /* compute log(1+x)  */
 136               s = x/(2+x); t = x*x*half;
 137               c += (k*ln2lo-c*x);
 138               z = c+s*(t+__log__L(s*s));
 139               x += (z - t) ;
 140
 141               return(k*ln2hi+x);
 142            }
 143         /* end of if (x > negone) */
 144
 145             else {
 146 #if defined(vax)||defined(tahoe)
 147                 if ( x == negone )
 148                     return (infnan(-ERANGE));   /* -INF */
 149                 else
 150                     return (infnan(EDOM));      /* NaN */
 151 #else   /* defined(vax)||defined(tahoe) */
 152                 /* x = -1, return -INF with signal */
 153                 if ( x == negone ) return( negone/zero );
 154
 155                 /* negative argument for log, return NaN with signal */
 156                 else return ( zero / zero );
 157 #endif  /* defined(vax)||defined(tahoe) */
 158             }
 159         }
 160     /* end of if (finite(x)) */
 161
 162     /* log(-INF) is NaN */
 163         else if(x<0)
 164              return(zero/zero);
 165
 166     /* log(+INF) is INF */
 167         else return(x);
 168 }