lib/libm/ieee/cbrt.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  * @(#)cbrt.c   8.1 (Berkeley) 6/4/93
  34  */
  35
  36 #include <sys/cdefs.h>
  37
  38 /* kahan's cube root (53 bits IEEE double precision)
  39  * for IEEE machines only
  40  * coded in C by K.C. Ng, 4/30/85
  41  *
  42  * Accuracy:
  43  *      better than 0.667 ulps according to an error analysis. Maximum
  44  * error observed was 0.666 ulps in an 1,000,000 random arguments test.
  45  *
  46  * Warning: this code is semi machine dependent; the ordering of words in
  47  * a floating point number must be known in advance. I assume that the
  48  * long interger at the address of a floating point number will be the
  49  * leading 32 bits of that floating point number (i.e., sign, exponent,
  50  * and the 20 most significant bits).
  51  * On a National machine, it has different ordering; therefore, this code
  52  * must be compiled with flag -DNATIONAL.
  53  */
  54 #if !defined(vax)&&!defined(tahoe)
  55
  56 static const unsigned long
  57                      B1 = 715094163, /* B1 = (682-0.03306235651)*2**20 */
  58                      B2 = 696219795; /* B2 = (664-0.03306235651)*2**20 */
  59 static const double
  60             C= 19./35.,
  61             D= -864./1225.,
  62             E= 99./70.,
  63             F= 45./28.,
  64             G= 5./14.;
  65
  66 double cbrt(x)
  67 double x;
  68 {
  69         double r,s,t=0.0,w;
  70         unsigned long *px = (unsigned long *) &x,
  71                       *pt = (unsigned long *) &t,
  72                       mexp,sign;
  73
  74 #ifdef national /* ordering of words in a floating points number */
  75         const int n0=1,n1=0;
  76 #else   /* national */
  77         const int n0=0,n1=1;
  78 #endif  /* national */
  79
  80         mexp=px[n0]&0x7ff00000;
  81         if(mexp==0x7ff00000) return(x); /* cbrt(NaN,INF) is itself */
  82         if(x==0.0) return(x);           /* cbrt(0) is itself */
  83
  84         sign=px[n0]&0x80000000; /* sign= sign(x) */
  85         px[n0] ^= sign;         /* x=|x| */
  86
  87
  88     /* rough cbrt to 5 bits */
  89         if(mexp==0)             /* subnormal number */
  90           {pt[n0]=0x43500000;   /* set t= 2**54 */
  91            t*=x; pt[n0]=pt[n0]/3+B2;
  92           }
  93         else
  94           pt[n0]=px[n0]/3+B1;
  95
  96
  97     /* new cbrt to 23 bits, may be implemented in single precision */
  98         r=t*t/x;
  99         s=C+r*t;
 100         t*=G+F/(s+E+D/s);
 101
 102     /* chopped to 20 bits and make it larger than cbrt(x) */
 103         pt[n1]=0; pt[n0]+=0x00000001;
 104
 105
 106     /* one step newton iteration to 53 bits with error less than 0.667 ulps */
 107         s=t*t;          /* t*t is exact */
 108         r=x/s;
 109         w=t+t;
 110         r=(r-t)/(w+r);  /* r-t is exact */
 111         t=t+t*r;
 112
 113
 114     /* retore the sign bit */
 115         pt[n0] |= sign;
 116         return(t);
 117 }
 118 #endif