Corrections in the MPFR manual (PZ & VL). Functions mpfr_const_pi,

mpfr_const_log2 and mpfr_zeta now return a ternary value. Updated
TODO file.


git-svn-id: svn://scm.gforge.inria.fr/svn/mpfr/trunk@2463 280ebfd0-de03-0410-8827-d642c229c3f4

1 files changed, 17 insertions, 14 deletions

diff --git a/const_pi.c b/const_pi.c
index cc3af0085..62d5d72c8 100644
--- a/const_pi.c
+++ b/const_pi.c
@@ -40,22 +40,22 @@ static int mpfr_pi_machin3 _PROTO ((mpfr_ptr, mp_rnd_t));
 #define GENERIC mpfr_aux_pi
 #define R_IS_RATIONAL
 #define NO_FACTORIAL
-#include "generic.c" 
+#include "generic.c"
 
 
 static int
-mpfr_pi_machin3 (mpfr_ptr mylog, mp_rnd_t rnd_mode) 
+mpfr_pi_machin3 (mpfr_ptr mylog, mp_rnd_t rnd_mode)
 {
   int prec, logn, prec_x;
   int prec_i_want=MPFR_PREC(mylog);
   int good = 0;
-  mpfr_t tmp1, tmp2, result,tmp3,tmp4,tmp5,tmp6; 
+  mpfr_t tmp1, tmp2, result,tmp3,tmp4,tmp5,tmp6;
   mpz_t cst;
 
-  MPFR_CLEAR_FLAGS(mylog); 
+  MPFR_CLEAR_FLAGS(mylog);
   logn = __gmpfr_ceil_log2 ((double) MPFR_PREC(mylog));
   prec_x = prec_i_want + logn + 5;
-  mpz_init(cst);  
+  mpz_init(cst);
   while (!good)
     {
       prec = __gmpfr_ceil_log2 ((double) prec_x);
@@ -118,13 +118,13 @@ mpfr_pi_machin3 (mpfr_ptr mylog, mp_rnd_t rnd_mode)
         }
     }
   mpz_clear(cst);
-  return 0;    
+  return 0;
 }
 
 /*
 Set x to the value of Pi to precision MPFR_PREC(x) rounded to direction rnd_mode.
 Use the formula giving the binary representation of Pi found by Simon Plouffe
-David Bailey and Peter Borwein. 
+David Bailey and Peter Borwein.
 
                    infinity    4         2         1         1
                     -----   ------- - ------- - ------- - -------
@@ -155,26 +155,28 @@ mpfr_t __mpfr_const_pi; /* stored value of Pi */
 mp_prec_t __gmpfr_const_pi_prec = 0; /* precision of stored value */
 static mp_rnd_t __mpfr_const_pi_rnd; /* rounding mode of stored value */
 
-void 
-mpfr_const_pi (mpfr_ptr x, mp_rnd_t rnd_mode) 
+int
+mpfr_const_pi (mpfr_ptr x, mp_rnd_t rnd_mode)
 {
-  int N, oldN, n, prec; mpz_t pi, num, den, d3, d2, tmp; mpfr_t y;
+  int N, oldN, n, prec;
+  mpz_t pi, num, den, d3, d2, tmp;
+  mpfr_t y;
 
   prec=MPFR_PREC(x);
 
   /* has stored value enough precision ? */
   if ((prec==__gmpfr_const_pi_prec && rnd_mode==__mpfr_const_pi_rnd) ||
       (prec<=__gmpfr_const_pi_prec &&
-      mpfr_can_round(__mpfr_const_pi, __gmpfr_const_pi_prec, 
-		     __mpfr_const_pi_rnd, rnd_mode, prec)))
+       mpfr_can_round(__mpfr_const_pi, __gmpfr_const_pi_prec,
+                      __mpfr_const_pi_rnd, rnd_mode, prec)))
     {
-      mpfr_set(x, __mpfr_const_pi, rnd_mode); return; 
+      return mpfr_set(x, __mpfr_const_pi, rnd_mode);
     }
 
   if (prec < 20000)
     {
       /* need to recompute */
-      N=1; 
+      N=1;
       do
         {
           oldN = N;
@@ -241,4 +243,5 @@ mpfr_const_pi (mpfr_ptr x, mp_rnd_t rnd_mode)
   mpfr_set(__mpfr_const_pi, x, rnd_mode);
   __gmpfr_const_pi_prec=prec;
   __mpfr_const_pi_rnd=rnd_mode;
+  return 1;
 }