Import upstream 5.1.3.
[platform/upstream/gmp.git] / mpn / generic / bsqrtinv.c
1 /* mpn_bsqrtinv, compute r such that r^2 * y = 1 (mod 2^{b+1}).
2
3    Contributed to the GNU project by Martin Boij (as part of perfpow.c).
4
5 Copyright 2009, 2010, 2012 Free Software Foundation, Inc.
6
7 This file is part of the GNU MP Library.
8
9 The GNU MP Library is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or (at your
12 option) any later version.
13
14 The GNU MP Library is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
16 or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
17 License for more details.
18
19 You should have received a copy of the GNU Lesser General Public License
20 along with the GNU MP Library.  If not, see http://www.gnu.org/licenses/.  */
21
22 #include "gmp.h"
23 #include "gmp-impl.h"
24
25 /* Compute r such that r^2 * y = 1 (mod 2^{b+1}).
26    Return non-zero if such an integer r exists.
27
28    Iterates
29      r' <-- (3r - r^3 y) / 2
30    using Hensel lifting.  Since we divide by two, the Hensel lifting is
31    somewhat degenerates.  Therefore, we lift from 2^b to 2^{b+1}-1.
32
33    FIXME:
34      (1) Simplify to do precision book-keeping in limbs rather than bits.
35
36      (2) Rewrite iteration as
37            r' <-- r - r (r^2 y - 1) / 2
38          and take advantage of zero low part of r^2 y - 1.
39
40      (3) Use wrap-around trick.
41
42      (4) Use a small table to get starting value.
43 */
44 int
45 mpn_bsqrtinv (mp_ptr rp, mp_srcptr yp, mp_bitcnt_t bnb, mp_ptr tp)
46 {
47   mp_ptr tp2, tp3;
48   mp_limb_t k;
49   mp_size_t bn, order[GMP_LIMB_BITS + 1];
50   int i, d;
51
52   ASSERT (bnb > 0);
53
54   bn = 1 + bnb / GMP_LIMB_BITS;
55
56   tp2 = tp + bn;
57   tp3 = tp + 2 * bn;
58   k = 3;
59
60   rp[0] = 1;
61   if (bnb == 1)
62     {
63       if ((yp[0] & 3) != 1)
64         return 0;
65     }
66   else
67     {
68       if ((yp[0] & 7) != 1)
69         return 0;
70
71       d = 0;
72       for (; bnb != 2; bnb = (bnb + 2) >> 1)
73         order[d++] = bnb;
74
75       for (i = d - 1; i >= 0; i--)
76         {
77           bnb = order[i];
78           bn = 1 + bnb / GMP_LIMB_BITS;
79
80           mpn_mul_1 (tp, rp, bn, k);
81
82           mpn_powlo (tp2, rp, &k, 1, bn, tp3);
83           mpn_mullo_n (rp, yp, tp2, bn);
84
85 #if HAVE_NATIVE_mpn_rsh1sub_n
86           mpn_rsh1sub_n (rp, tp, rp, bn);
87 #else
88           mpn_sub_n (tp2, tp, rp, bn);
89           mpn_rshift (rp, tp2, bn, 1);
90 #endif
91         }
92     }
93   return 1;
94 }