Coverage Report

Created: 2025-07-23 06:43

/src/gmp/mpn/hgcd2.c
Line
Count
Source
1
/* hgcd2.c
2
3
   THE FUNCTIONS IN THIS FILE ARE INTERNAL WITH MUTABLE INTERFACES.  IT IS ONLY
4
   SAFE TO REACH THEM THROUGH DOCUMENTED INTERFACES.  IN FACT, IT IS ALMOST
5
   GUARANTEED THAT THEY'LL CHANGE OR DISAPPEAR IN A FUTURE GNU MP RELEASE.
6
7
Copyright 1996, 1998, 2000-2004, 2008, 2012, 2019 Free Software Foundation,
8
Inc.
9
10
This file is part of the GNU MP Library.
11
12
The GNU MP Library is free software; you can redistribute it and/or modify
13
it under the terms of either:
14
15
  * the GNU Lesser General Public License as published by the Free
16
    Software Foundation; either version 3 of the License, or (at your
17
    option) any later version.
18
19
or
20
21
  * the GNU General Public License as published by the Free Software
22
    Foundation; either version 2 of the License, or (at your option) any
23
    later version.
24
25
or both in parallel, as here.
26
27
The GNU MP Library is distributed in the hope that it will be useful, but
28
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
29
or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
30
for more details.
31
32
You should have received copies of the GNU General Public License and the
33
GNU Lesser General Public License along with the GNU MP Library.  If not,
34
see https://www.gnu.org/licenses/.  */
35
36
#include "gmp-impl.h"
37
#include "longlong.h"
38
39
#include "mpn/generic/hgcd2-div.h"
40
41
#if GMP_NAIL_BITS != 0
42
#error Nails not implemented
43
#endif
44
45
/* Reduces a,b until |a-b| (almost) fits in one limb + 1 bit. Constructs
46
   matrix M. Returns 1 if we make progress, i.e. can perform at least
47
   one subtraction. Otherwise returns zero. */
48
49
/* FIXME: Possible optimizations:
50
51
   The div2 function starts with checking the most significant bit of
52
   the numerator. We can maintained normalized operands here, call
53
   hgcd with normalized operands only, which should make the code
54
   simpler and possibly faster.
55
56
   Experiment with table lookups on the most significant bits.
57
58
   This function is also a candidate for assembler implementation.
59
*/
60
int
61
mpn_hgcd2 (mp_limb_t ah, mp_limb_t al, mp_limb_t bh, mp_limb_t bl,
62
     struct hgcd_matrix1 *M)
63
658k
{
64
658k
  mp_limb_t u00, u01, u10, u11;
65
66
658k
  if (ah < 2 || bh < 2)
67
1.66k
    return 0;
68
69
657k
  if (ah > bh || (ah == bh && al > bl))
70
373k
    {
71
373k
      sub_ddmmss (ah, al, ah, al, bh, bl);
72
373k
      if (ah < 2)
73
3.23k
  return 0;
74
75
369k
      u00 = u01 = u11 = 1;
76
369k
      u10 = 0;
77
369k
    }
78
284k
  else
79
284k
    {
80
284k
      sub_ddmmss (bh, bl, bh, bl, ah, al);
81
284k
      if (bh < 2)
82
4.09k
  return 0;
83
84
279k
      u00 = u10 = u11 = 1;
85
279k
      u01 = 0;
86
279k
    }
87
88
649k
  if (ah < bh)
89
373k
    goto subtract_a;
90
91
276k
  for (;;)
92
6.17M
    {
93
6.17M
      ASSERT (ah >= bh);
94
6.17M
      if (ah == bh)
95
838
  goto done;
96
97
6.16M
      if (ah < (CNST_LIMB(1) << (GMP_LIMB_BITS / 2)))
98
350k
  {
99
350k
    ah = (ah << (GMP_LIMB_BITS / 2) ) + (al >> (GMP_LIMB_BITS / 2));
100
350k
    bh = (bh << (GMP_LIMB_BITS / 2) ) + (bl >> (GMP_LIMB_BITS / 2));
101
102
350k
    break;
103
350k
  }
104
105
      /* Subtract a -= q b, and multiply M from the right by (1 q ; 0
106
   1), affecting the second column of M. */
107
5.81M
      ASSERT (ah > bh);
108
5.81M
      sub_ddmmss (ah, al, ah, al, bh, bl);
109
110
5.81M
      if (ah < 2)
111
962
  goto done;
112
113
5.81M
      if (ah <= bh)
114
2.32M
  {
115
    /* Use q = 1 */
116
2.32M
    u01 += u00;
117
2.32M
    u11 += u10;
118
2.32M
  }
119
3.49M
      else
120
3.49M
  {
121
3.49M
    mp_limb_t r[2];
122
3.49M
    mp_limb_t q = div2 (r, ah, al, bh, bl);
123
3.49M
    al = r[0]; ah = r[1];
124
3.49M
    if (ah < 2)
125
1.68k
      {
126
        /* A is too small, but q is correct. */
127
1.68k
        u01 += q * u00;
128
1.68k
        u11 += q * u10;
129
1.68k
        goto done;
130
1.68k
      }
131
3.49M
    q++;
132
3.49M
    u01 += q * u00;
133
3.49M
    u11 += q * u10;
134
3.49M
  }
135
6.18M
    subtract_a:
136
6.18M
      ASSERT (bh >= ah);
137
6.18M
      if (ah == bh)
138
740
  goto done;
139
140
6.18M
      if (bh < (CNST_LIMB(1) << (GMP_LIMB_BITS / 2)))
141
293k
  {
142
293k
    ah = (ah << (GMP_LIMB_BITS / 2) ) + (al >> (GMP_LIMB_BITS / 2));
143
293k
    bh = (bh << (GMP_LIMB_BITS / 2) ) + (bl >> (GMP_LIMB_BITS / 2));
144
145
293k
    goto subtract_a1;
146
293k
  }
147
148
      /* Subtract b -= q a, and multiply M from the right by (1 0 ; q
149
   1), affecting the first column of M. */
150
5.89M
      sub_ddmmss (bh, bl, bh, bl, ah, al);
151
152
5.89M
      if (bh < 2)
153
732
  goto done;
154
155
5.89M
      if (bh <= ah)
156
2.31M
  {
157
    /* Use q = 1 */
158
2.31M
    u00 += u01;
159
2.31M
    u10 += u11;
160
2.31M
  }
161
3.58M
      else
162
3.58M
  {
163
3.58M
    mp_limb_t r[2];
164
3.58M
    mp_limb_t q = div2 (r, bh, bl, ah, al);
165
3.58M
    bl = r[0]; bh = r[1];
166
3.58M
    if (bh < 2)
167
1.65k
      {
168
        /* B is too small, but q is correct. */
169
1.65k
        u00 += q * u01;
170
1.65k
        u10 += q * u11;
171
1.65k
        goto done;
172
1.65k
      }
173
3.57M
    q++;
174
3.57M
    u00 += q * u01;
175
3.57M
    u10 += q * u11;
176
3.57M
  }
177
5.89M
    }
178
179
  /* NOTE: Since we discard the least significant half limb, we don't get a
180
     truly maximal M (corresponding to |a - b| < 2^{GMP_LIMB_BITS +1}). */
181
  /* Single precision loop */
182
350k
  for (;;)
183
5.62M
    {
184
5.62M
      ASSERT (ah >= bh);
185
186
5.62M
      ah -= bh;
187
5.62M
      if (ah < (CNST_LIMB (1) << (GMP_LIMB_BITS / 2 + 1)))
188
196k
  break;
189
190
5.42M
      if (ah <= bh)
191
2.44M
  {
192
    /* Use q = 1 */
193
2.44M
    u01 += u00;
194
2.44M
    u11 += u10;
195
2.44M
  }
196
2.98M
      else
197
2.98M
  {
198
2.98M
    mp_double_limb_t rq = div1 (ah, bh);
199
2.98M
    mp_limb_t q = rq.d1;
200
2.98M
    ah = rq.d0;
201
202
2.98M
    if (ah < (CNST_LIMB(1) << (GMP_LIMB_BITS / 2 + 1)))
203
162k
      {
204
        /* A is too small, but q is correct. */
205
162k
        u01 += q * u00;
206
162k
        u11 += q * u10;
207
162k
        break;
208
162k
      }
209
2.82M
    q++;
210
2.82M
    u01 += q * u00;
211
2.82M
    u11 += q * u10;
212
2.82M
  }
213
5.55M
    subtract_a1:
214
5.55M
      ASSERT (bh >= ah);
215
216
5.55M
      bh -= ah;
217
5.55M
      if (bh < (CNST_LIMB (1) << (GMP_LIMB_BITS / 2 + 1)))
218
121k
  break;
219
220
5.43M
      if (bh <= ah)
221
2.12M
  {
222
    /* Use q = 1 */
223
2.12M
    u00 += u01;
224
2.12M
    u10 += u11;
225
2.12M
  }
226
3.30M
      else
227
3.30M
  {
228
3.30M
    mp_double_limb_t rq = div1 (bh, ah);
229
3.30M
    mp_limb_t q = rq.d1;
230
3.30M
    bh = rq.d0;
231
232
3.30M
    if (bh < (CNST_LIMB(1) << (GMP_LIMB_BITS / 2 + 1)))
233
162k
      {
234
        /* B is too small, but q is correct. */
235
162k
        u00 += q * u01;
236
162k
        u10 += q * u11;
237
162k
        break;
238
162k
      }
239
3.14M
    q++;
240
3.14M
    u00 += q * u01;
241
3.14M
    u10 += q * u11;
242
3.14M
  }
243
5.43M
    }
244
245
649k
 done:
246
649k
  M->u[0][0] = u00; M->u[0][1] = u01;
247
649k
  M->u[1][0] = u10; M->u[1][1] = u11;
248
249
649k
  return 1;
250
350k
}
251
252
/* Sets (r;b) = (a;b) M, with M = (u00, u01; u10, u11). Vector must
253
 * have space for n + 1 limbs. Uses three buffers to avoid a copy*/
254
mp_size_t
255
mpn_hgcd_mul_matrix1_vector (const struct hgcd_matrix1 *M,
256
           mp_ptr rp, mp_srcptr ap, mp_ptr bp, mp_size_t n)
257
649k
{
258
649k
  mp_limb_t ah, bh;
259
260
  /* Compute (r,b) <-- (u00 a + u10 b, u01 a + u11 b) as
261
262
     r  = u00 * a
263
     r += u10 * b
264
     b *= u11
265
     b += u01 * a
266
  */
267
268
#if HAVE_NATIVE_mpn_addaddmul_1msb0
269
  ah = mpn_addaddmul_1msb0 (rp, ap, bp, n, M->u[0][0], M->u[1][0]);
270
  bh = mpn_addaddmul_1msb0 (bp, bp, ap, n, M->u[1][1], M->u[0][1]);
271
#else
272
649k
  ah =     mpn_mul_1 (rp, ap, n, M->u[0][0]);
273
649k
  ah += mpn_addmul_1 (rp, bp, n, M->u[1][0]);
274
275
649k
  bh =     mpn_mul_1 (bp, bp, n, M->u[1][1]);
276
649k
  bh += mpn_addmul_1 (bp, ap, n, M->u[0][1]);
277
649k
#endif
278
649k
  rp[n] = ah;
279
649k
  bp[n] = bh;
280
281
649k
  n += (ah | bh) > 0;
282
649k
  return n;
283
649k
}