merge from 1.8 branch
[bpt/guile.git] / libguile / numbers.c
index 14acd2a..3b6d781 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004,2005, 2006 Free Software Foundation, Inc.
  *
  * Portions Copyright 1990, 1991, 1992, 1993 by AT&T Bell Laboratories
  * and Bellcore.  See scm_divide.
@@ -16,7 +16,7 @@
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 \f
@@ -50,7 +50,6 @@
 #include <math.h>
 #include <ctype.h>
 #include <string.h>
-#include <gmp.h>
 
 #include "libguile/_scm.h"
 #include "libguile/feature.h"
@@ -184,7 +183,7 @@ scm_i_ulong2big (unsigned long x)
   return z;
 }
 
-SCM_C_INLINE_KEYWORD static SCM
+SCM_C_INLINE_KEYWORD SCM
 scm_i_clonebig (SCM src_big, int same_sign_p)
 {
   /* Copy src_big's value, negate it if same_sign_p is false, and return. */
@@ -879,8 +878,9 @@ scm_modulo (SCM x, SCM y)
            scm_num_overflow (s_modulo);
          else
            {
-             /* FIXME: I think this may be a bug on some arches -- results
-                of % with negative second arg are undefined... */
+             /* C99 specifies that "%" is the remainder corresponding to a
+                 quotient rounded towards zero, and that's also traditional
+                 for machine division, so z here should be well defined.  */
              long z = xx % yy;
              long result;
 
@@ -1309,7 +1309,7 @@ SCM_DEFINE1 (scm_logior, "logior", scm_tc7_asubr,
            mpz_ior (SCM_I_BIG_MPZ (result_z), nn1_z, SCM_I_BIG_MPZ (n2));
            scm_remember_upto_here_1 (n2);
            mpz_clear (nn1_z);
-           return result_z;
+           return scm_i_normbig (result_z);
          }
        }
       else
@@ -1330,7 +1330,7 @@ SCM_DEFINE1 (scm_logior, "logior", scm_tc7_asubr,
                   SCM_I_BIG_MPZ (n1),
                   SCM_I_BIG_MPZ (n2));
          scm_remember_upto_here_2 (n1, n2);
-         return result_z;
+         return scm_i_normbig (result_z);
        }
       else
        SCM_WRONG_TYPE_ARG (SCM_ARG2, n2);
@@ -1417,8 +1417,12 @@ SCM_DEFINE1 (scm_logxor, "logxor", scm_tc7_asubr,
 
 SCM_DEFINE (scm_logtest, "logtest", 2, 0, 0,
             (SCM j, SCM k),
+           "Test whether @var{j} and @var{k} have any 1 bits in common.\n"
+           "This is equivalent to @code{(not (zero? (logand j k)))}, but\n"
+           "without actually calculating the @code{logand}, just testing\n"
+           "for non-zero.\n"
+           "\n"
            "@lisp\n"
-           "(logtest j k) @equiv{} (not (zero? (logand j k)))\n\n"
            "(logtest #b0100 #b1011) @result{} #f\n"
            "(logtest #b0100 #b0111) @result{} #t\n"
            "@end lisp")
@@ -1485,8 +1489,10 @@ SCM_DEFINE (scm_logtest, "logtest", 2, 0, 0,
 
 SCM_DEFINE (scm_logbit_p, "logbit?", 2, 0, 0,
             (SCM index, SCM j),
+           "Test whether bit number @var{index} in @var{j} is set.\n"
+           "@var{index} starts from 0 for the least significant bit.\n"
+           "\n"
            "@lisp\n"
-           "(logbit? index j) @equiv{} (logtest (integer-expt 2 index) j)\n\n"
            "(logbit? 0 #b1101) @result{} #t\n"
            "(logbit? 1 #b1101) @result{} #f\n"
            "(logbit? 2 #b1101) @result{} #t\n"
@@ -1668,14 +1674,18 @@ SCM_DEFINE (scm_modulo_expt, "modulo-expt", 3, 0, 0,
 
 SCM_DEFINE (scm_integer_expt, "integer-expt", 2, 0, 0,
             (SCM n, SCM k),
-           "Return @var{n} raised to the non-negative integer exponent\n"
-           "@var{k}.\n"
+           "Return @var{n} raised to the power @var{k}.  @var{k} must be an\n"
+           "exact integer, @var{n} can be any number.\n"
+           "\n"
+           "Negative @var{k} is supported, and results in @math{1/n^abs(k)}\n"
+           "in the usual way.  @math{@var{n}^0} is 1, as usual, and that\n"
+           "includes @math{0^0} is 1.\n"
            "\n"
            "@lisp\n"
-           "(integer-expt 2 5)\n"
-           "   @result{} 32\n"
-           "(integer-expt -3 3)\n"
-           "   @result{} -27\n"
+           "(integer-expt 2 5)   @result{} 32\n"
+           "(integer-expt -3 3)  @result{} -27\n"
+           "(integer-expt 5 -3)  @result{} 1/125\n"
+           "(integer-expt 0 0)   @result{} 1\n"
            "@end lisp")
 #define FUNC_NAME s_scm_integer_expt
 {
@@ -1698,22 +1708,6 @@ SCM_DEFINE (scm_integer_expt, "integer-expt", 2, 0, 0,
       scm_remember_upto_here_1 (k);
       i2_is_big = 1;
     }
-  else if (SCM_REALP (k))
-    {
-      double r = SCM_REAL_VALUE (k);
-      if (floor (r) != r)
-        SCM_WRONG_TYPE_ARG (2, k);
-      if ((r > SCM_MOST_POSITIVE_FIXNUM) || (r < SCM_MOST_NEGATIVE_FIXNUM))
-        {
-          z_i2 = scm_i_mkbig ();
-          mpz_set_d (SCM_I_BIG_MPZ (z_i2), r);
-          i2_is_big = 1;
-        }
-      else
-        {
-          i2 = r;
-        }
-    }
   else
     SCM_WRONG_TYPE_ARG (2, k);
   
@@ -1788,25 +1782,76 @@ SCM_DEFINE (scm_ash, "ash", 2, 0, 0,
   long bits_to_shift;
   bits_to_shift = scm_to_long (cnt);
 
-  if (bits_to_shift < 0)
+  if (SCM_I_INUMP (n))
     {
-      /* Shift right by abs(cnt) bits.  This is realized as a division
-         by div:=2^abs(cnt).  However, to guarantee the floor
-         rounding, negative values require some special treatment.
-      */
-      SCM div = scm_integer_expt (SCM_I_MAKINUM (2),
-                                  scm_from_long (-bits_to_shift));
+      long nn = SCM_I_INUM (n);
 
-      /* scm_quotient assumes its arguments are integers, but it's legal to (ash 1/2 -1) */
-      if (scm_is_false (scm_negative_p (n)))
-        return scm_quotient (n, div);
+      if (bits_to_shift > 0)
+        {
+          /* Left shift of bits_to_shift >= SCM_I_FIXNUM_BIT-1 will always
+             overflow a non-zero fixnum.  For smaller shifts we check the
+             bits going into positions above SCM_I_FIXNUM_BIT-1.  If they're
+             all 0s for nn>=0, or all 1s for nn<0 then there's no overflow.
+             Those bits are "nn >> (SCM_I_FIXNUM_BIT-1 -
+             bits_to_shift)".  */
+
+          if (nn == 0)
+            return n;
+
+          if (bits_to_shift < SCM_I_FIXNUM_BIT-1
+              && ((unsigned long)
+                  (SCM_SRS (nn, (SCM_I_FIXNUM_BIT-1 - bits_to_shift)) + 1)
+                  <= 1))
+            {
+              return SCM_I_MAKINUM (nn << bits_to_shift);
+            }
+          else
+            {
+              SCM result = scm_i_long2big (nn);
+              mpz_mul_2exp (SCM_I_BIG_MPZ (result), SCM_I_BIG_MPZ (result),
+                            bits_to_shift);
+              return result;
+            }
+        }
       else
-        return scm_sum (SCM_I_MAKINUM (-1L),
-                        scm_quotient (scm_sum (SCM_I_MAKINUM (1L), n), div));
+        {
+          bits_to_shift = -bits_to_shift;
+          if (bits_to_shift >= SCM_LONG_BIT)
+            return (nn >= 0 ? SCM_I_MAKINUM (0) : SCM_I_MAKINUM(-1));
+          else
+            return SCM_I_MAKINUM (SCM_SRS (nn, bits_to_shift));
+        }
+
+    }
+  else if (SCM_BIGP (n))
+    {
+      SCM result;
+
+      if (bits_to_shift == 0)
+        return n;
+
+      result = scm_i_mkbig ();
+      if (bits_to_shift >= 0)
+        {
+          mpz_mul_2exp (SCM_I_BIG_MPZ (result), SCM_I_BIG_MPZ (n),
+                        bits_to_shift);
+          return result;
+        }
+      else
+        {
+          /* GMP doesn't have an fdiv_q_2exp variant returning just a long, so
+             we have to allocate a bignum even if the result is going to be a
+             fixnum.  */
+          mpz_fdiv_q_2exp (SCM_I_BIG_MPZ (result), SCM_I_BIG_MPZ (n),
+                           -bits_to_shift);
+          return scm_i_normbig (result);
+        }
+
     }
   else
-    /* Shift left is done by multiplication with 2^CNT */
-    return scm_product (n, scm_integer_expt (SCM_I_MAKINUM (2), cnt));
+    {
+      SCM_WRONG_TYPE_ARG (SCM_ARG1, n);
+    }
 }
 #undef FUNC_NAME
 
@@ -2212,6 +2257,25 @@ idbl2str (double f, char *a, int radix)
   return ch;
 }
 
+
+static size_t
+icmplx2str (double real, double imag, char *str, int radix)
+{
+  size_t i;
+  
+  i = idbl2str (real, str, radix);
+  if (imag != 0.0)
+    {
+      /* Don't output a '+' for negative numbers or for Inf and
+        NaN.  They will provide their own sign. */
+      if (0 <= imag && !xisinf (imag) && !xisnan (imag))
+       str[i++] = '+';
+      i += idbl2str (imag, &str[i], radix);
+      str[i++] = 'i';
+    }
+  return i;
+}
+
 static size_t
 iflo2str (SCM flt, char *str, int radix)
 {
@@ -2219,45 +2283,43 @@ iflo2str (SCM flt, char *str, int radix)
   if (SCM_REALP (flt))
     i = idbl2str (SCM_REAL_VALUE (flt), str, radix);
   else
+    i = icmplx2str (SCM_COMPLEX_REAL (flt), SCM_COMPLEX_IMAG (flt),
+                   str, radix);
+  return i;
+}
+
+/* convert a scm_t_intmax to a string (unterminated).  returns the number of
+   characters in the result. 
+   rad is output base
+   p is destination: worst case (base 2) is SCM_INTBUFLEN  */
+size_t
+scm_iint2str (scm_t_intmax num, int rad, char *p)
+{
+  if (num < 0)
     {
-      i = idbl2str (SCM_COMPLEX_REAL (flt), str, radix);
-      if (SCM_COMPLEX_IMAG (flt) != 0.0)
-       {
-         double imag = SCM_COMPLEX_IMAG (flt);
-         /* Don't output a '+' for negative numbers or for Inf and
-            NaN.  They will provide their own sign. */
-         if (0 <= imag && !xisinf (imag) && !xisnan (imag))
-           str[i++] = '+';
-         i += idbl2str (imag, &str[i], radix);
-         str[i++] = 'i';
-       }
+      *p++ = '-';
+      return scm_iuint2str (-num, rad, p) + 1;
     }
-  return i;
+  else
+    return scm_iuint2str (num, rad, p);
 }
 
-/* convert a long to a string (unterminated).  returns the number of
+/* convert a scm_t_intmax to a string (unterminated).  returns the number of
    characters in the result. 
    rad is output base
    p is destination: worst case (base 2) is SCM_INTBUFLEN  */
 size_t
-scm_iint2str (long num, int rad, char *p)
+scm_iuint2str (scm_t_uintmax num, int rad, char *p)
 {
   size_t j = 1;
   size_t i;
-  unsigned long n = (num < 0) ? -num : num;
+  scm_t_uintmax n = num;
 
   for (n /= rad; n > 0; n /= rad)
     j++;
 
   i = j;
-  if (num < 0)
-    {
-      *p++ = '-';
-      j++;
-      n = -num;
-    }
-  else
-    n = num;
+  n = num;
   while (i--)
     {
       int d = n % rad;
@@ -2323,6 +2385,13 @@ scm_print_real (SCM sexp, SCM port, scm_print_state *pstate SCM_UNUSED)
   return !0;
 }
 
+void
+scm_i_print_double (double val, SCM port)
+{
+  char num_buf[FLOBUFLEN];
+  scm_lfwrite (num_buf, idbl2str (val, num_buf, 10), port);
+}
+
 int
 scm_print_complex (SCM sexp, SCM port, scm_print_state *pstate SCM_UNUSED)
 
@@ -2332,6 +2401,13 @@ scm_print_complex (SCM sexp, SCM port, scm_print_state *pstate SCM_UNUSED)
   return !0;
 }
 
+void
+scm_i_print_complex (double real, double imag, SCM port)
+{
+  char num_buf[FLOBUFLEN];
+  scm_lfwrite (num_buf, icmplx2str (real, imag, num_buf, 10), port);
+}
+
 int
 scm_i_print_fraction (SCM sexp, SCM port, scm_print_state *pstate SCM_UNUSED)
 {
@@ -2861,7 +2937,8 @@ mem2complex (const char* mem, size_t len, unsigned int idx,
 enum t_radix {NO_RADIX=0, DUAL=2, OCT=8, DEC=10, HEX=16};
 
 SCM
-scm_i_mem2number (const char* mem, size_t len, unsigned int default_radix)
+scm_c_locale_stringn_to_number (const char* mem, size_t len,
+                               unsigned int default_radix)
 {
   unsigned int idx = 0;
   unsigned int radix = NO_RADIX;
@@ -2967,9 +3044,9 @@ SCM_DEFINE (scm_string_to_number, "string->number", 1, 1, 0,
   else
     base = scm_to_unsigned_integer (radix, 2, INT_MAX);
 
-  answer = scm_i_mem2number (scm_i_string_chars (string),
-                            scm_i_string_length (string),
-                            base);
+  answer = scm_c_locale_stringn_to_number (scm_i_string_chars (string),
+                                          scm_i_string_length (string),
+                                          base);
   scm_remember_upto_here_1 (string);
   return answer;
 }
@@ -3095,6 +3172,7 @@ SCM_DEFINE (scm_integer_p, "integer?", 1, 0, 0,
   if (SCM_COMPLEXP (x))
     return SCM_BOOL_F;
   r = SCM_REAL_VALUE (x);
+  /* +/-inf passes r==floor(r), making those #t */
   if (r == floor (r))
     return SCM_BOOL_T;
   return SCM_BOOL_F;
@@ -3134,7 +3212,27 @@ scm_num_eq_p (SCM x, SCM y)
       else if (SCM_BIGP (y))
        return SCM_BOOL_F;
       else if (SCM_REALP (y))
-       return scm_from_bool ((double) xx == SCM_REAL_VALUE (y));
+        {
+          /* On a 32-bit system an inum fits a double, we can cast the inum
+             to a double and compare.
+
+             But on a 64-bit system an inum is bigger than a double and
+             casting it to a double (call that dxx) will round.  dxx is at
+             worst 1 bigger or smaller than xx, so if dxx==yy we know yy is
+             an integer and fits a long.  So we cast yy to a long and
+             compare with plain xx.
+
+             An alternative (for any size system actually) would be to check
+             yy is an integer (with floor) and is in range of an inum
+             (compare against appropriate powers of 2) then test
+             xx==(long)yy.  It's just a matter of which casts/comparisons
+             might be fastest or easiest for the cpu.  */
+
+          double yy = SCM_REAL_VALUE (y);
+          return scm_from_bool ((double) xx == yy
+                               && (DBL_MANT_DIG >= SCM_I_FIXNUM_BIT-1
+                                   || xx == (long) yy));
+        }
       else if (SCM_COMPLEXP (y))
        return scm_from_bool (((double) xx == SCM_COMPLEX_REAL (y))
                         && (0.0 == SCM_COMPLEX_IMAG (y)));
@@ -3180,8 +3278,15 @@ scm_num_eq_p (SCM x, SCM y)
     }
   else if (SCM_REALP (x))
     {
+      double xx = SCM_REAL_VALUE (x);
       if (SCM_I_INUMP (y))
-       return scm_from_bool (SCM_REAL_VALUE (x) == (double) SCM_I_INUM (y));
+        {
+          /* see comments with inum/real above */
+          long yy = SCM_I_INUM (y);
+          return scm_from_bool (xx == (double) yy
+                               && (DBL_MANT_DIG >= SCM_I_FIXNUM_BIT-1
+                                   || (long) xx == yy));
+        }
       else if (SCM_BIGP (y))
        {
          int cmp;
@@ -4003,6 +4108,16 @@ scm_sum (SCM x, SCM y)
 }
 
 
+SCM_DEFINE (scm_oneplus, "1+", 1, 0, 0, 
+            (SCM x),
+           "Return @math{@var{x}+1}.")
+#define FUNC_NAME s_scm_oneplus
+{
+  return scm_sum (x, SCM_I_MAKINUM (1));
+}
+#undef FUNC_NAME
+
+
 SCM_GPROC1 (s_difference, "-", scm_tc7_asubr, scm_difference, g_difference);
 /* If called with one argument @var{z1}, -@var{z1} returned. Otherwise
  * the sum of all but the first argument are subtracted from the first
@@ -4025,7 +4140,8 @@ scm_difference (SCM x, SCM y)
               return scm_i_long2big (xx);
           }
         else if (SCM_BIGP (x))
-          /* FIXME: do we really need to normalize here? */
+          /* Must scm_i_normbig here because -SCM_MOST_NEGATIVE_FIXNUM is a
+             bignum, but negating that gives a fixnum.  */
           return scm_i_normbig (scm_i_clonebig (x, 0));
         else if (SCM_REALP (x))
           return scm_from_double (-SCM_REAL_VALUE (x));
@@ -4237,6 +4353,16 @@ scm_difference (SCM x, SCM y)
 #undef FUNC_NAME
 
 
+SCM_DEFINE (scm_oneminus, "1-", 1, 0, 0, 
+            (SCM x),
+           "Return @math{@var{x}-1}.")
+#define FUNC_NAME s_scm_oneminus
+{
+  return scm_difference (x, SCM_I_MAKINUM (1));
+}
+#undef FUNC_NAME
+
+
 SCM_GPROC1 (s_product, "*", scm_tc7_asubr, scm_product, g_product);
 /* "Return the product of all arguments.  If called without arguments,\n"
  * "1 is returned."
@@ -4497,7 +4623,7 @@ scm_i_divide (SCM x, SCM y, int inexact)
        {
          double r = SCM_COMPLEX_REAL (x);
          double i = SCM_COMPLEX_IMAG (x);
-         if (r <= i)
+         if (fabs(r) <= fabs(i))
            {
              double t = r / i;
              double d = i * (1.0 + t * t);
@@ -4569,7 +4695,7 @@ scm_i_divide (SCM x, SCM y, int inexact)
          {
            double r = SCM_COMPLEX_REAL (y);
            double i = SCM_COMPLEX_IMAG (y);
-           if (r <= i)
+           if (fabs(r) <= fabs(i))
              {
                double t = r / i;
                double d = i * (1.0 + t * t);
@@ -4653,28 +4779,33 @@ scm_i_divide (SCM x, SCM y, int inexact)
          else
            {
              /* big_x / big_y */
-             int divisible_p = mpz_divisible_p (SCM_I_BIG_MPZ (x),
-                                                SCM_I_BIG_MPZ (y));
-             if (divisible_p)
-               {
-                 SCM result = scm_i_mkbig ();
-                 mpz_divexact (SCM_I_BIG_MPZ (result),
-                               SCM_I_BIG_MPZ (x),
-                               SCM_I_BIG_MPZ (y));
-                 scm_remember_upto_here_2 (x, y);
-                 return scm_i_normbig (result);
-               }
-             else
-               {
-                 if (inexact)
-                   {
-                     double dbx = mpz_get_d (SCM_I_BIG_MPZ (x));
-                     double dby = mpz_get_d (SCM_I_BIG_MPZ (y));
-                     scm_remember_upto_here_2 (x, y);
-                     return scm_from_double (dbx / dby);
-                   }
-                 else return scm_i_make_ratio (x, y);
-               }
+              if (inexact)
+                {
+                  /* It's easily possible for the ratio x/y to fit a double
+                     but one or both x and y be too big to fit a double,
+                     hence the use of mpq_get_d rather than converting and
+                     dividing.  */
+                  mpq_t q;
+                  *mpq_numref(q) = *SCM_I_BIG_MPZ (x);
+                  *mpq_denref(q) = *SCM_I_BIG_MPZ (y);
+                  return scm_from_double (mpq_get_d (q));
+                }
+              else
+                {
+                  int divisible_p = mpz_divisible_p (SCM_I_BIG_MPZ (x),
+                                                     SCM_I_BIG_MPZ (y));
+                  if (divisible_p)
+                    {
+                      SCM result = scm_i_mkbig ();
+                      mpz_divexact (SCM_I_BIG_MPZ (result),
+                                    SCM_I_BIG_MPZ (x),
+                                    SCM_I_BIG_MPZ (y));
+                      scm_remember_upto_here_2 (x, y);
+                      return scm_i_normbig (result);
+                    }
+                  else
+                    return scm_i_make_ratio (x, y);
+                }
            }
        }
       else if (SCM_REALP (y))
@@ -4774,7 +4905,7 @@ scm_i_divide (SCM x, SCM y, int inexact)
        {
          double ry = SCM_COMPLEX_REAL (y);
          double iy = SCM_COMPLEX_IMAG (y);
-         if (ry <= iy)
+         if (fabs(ry) <= fabs(iy))
            {
              double t = ry / iy;
              double d = iy * (1.0 + t * t);
@@ -5611,6 +5742,16 @@ scm_is_unsigned_integer (SCM val, scm_t_uintmax min, scm_t_uintmax max)
     return 0;
 }
 
+static void
+scm_i_range_error (SCM bad_val, SCM min, SCM max)
+{
+  scm_error (scm_out_of_range_key,
+            NULL,
+            "Value out of range ~S to ~S: ~S",
+             scm_list_3 (min, max, bad_val),
+             scm_list_1 (bad_val));
+}
+
 #define TYPE                     scm_t_intmax
 #define TYPE_MIN                 min
 #define TYPE_MAX                 max
@@ -5695,6 +5836,23 @@ scm_is_unsigned_integer (SCM val, scm_t_uintmax min, scm_t_uintmax max)
 
 #endif
 
+void
+scm_to_mpz (SCM val, mpz_t rop)
+{
+  if (SCM_I_INUMP (val))
+    mpz_set_si (rop, SCM_I_INUM (val));
+  else if (SCM_BIGP (val))
+    mpz_set (rop, SCM_I_BIG_MPZ (val));
+  else
+    scm_wrong_type_arg_msg (NULL, 0, val, "exact integer");
+}
+
+SCM
+scm_from_mpz (mpz_t val)
+{
+  return scm_i_mpz2num (val);
+}
+
 int
 scm_is_real (SCM val)
 {
@@ -5719,7 +5877,7 @@ scm_to_double (SCM val)
   else if (SCM_REALP (val))
     return SCM_REAL_VALUE (val);
   else
-    scm_wrong_type_arg (NULL, 0, val);
+    scm_wrong_type_arg_msg (NULL, 0, val, "real number");
 }
 
 SCM
@@ -5848,10 +6006,6 @@ scm_init_numbers ()
       scm_dblprec[10-2] = (DBL_DIG > 20) ? 20 : DBL_DIG;
 #endif
 
-#ifdef GUILE_DEBUG
-  check_sanity ();
-#endif
-
   exactly_one_half = scm_permanent_object (scm_divide (SCM_I_MAKINUM (1),
                                                       SCM_I_MAKINUM (2)));
 #include "libguile/numbers.x"