Coverage Report

Created: 2026-08-14 07:10

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/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
379k
{
64
379k
  mp_limb_t u00, u01, u10, u11;
65
66
379k
  if (ah < 2 || bh < 2)
67
1.66k
    return 0;
68
69
378k
  if (ah > bh || (ah == bh && al > bl))
70
201k
    {
71
201k
      sub_ddmmss (ah, al, ah, al, bh, bl);
72
201k
      if (ah < 2)
73
2.96k
  return 0;
74
75
198k
      u00 = u01 = u11 = 1;
76
198k
      u10 = 0;
77
198k
    }
78
176k
  else
79
176k
    {
80
176k
      sub_ddmmss (bh, bl, bh, bl, ah, al);
81
176k
      if (bh < 2)
82
3.61k
  return 0;
83
84
172k
      u00 = u10 = u11 = 1;
85
172k
      u01 = 0;
86
172k
    }
87
88
371k
  if (ah < bh)
89
202k
    goto subtract_a;
90
91
169k
  for (;;)
92
3.51M
    {
93
3.51M
      ASSERT (ah >= bh);
94
3.51M
      if (ah == bh)
95
677
  goto done;
96
97
3.51M
      if (ah < (CNST_LIMB(1) << (GMP_LIMB_BITS / 2)))
98
199k
  {
99
199k
    ah = (ah << (GMP_LIMB_BITS / 2) ) + (al >> (GMP_LIMB_BITS / 2));
100
199k
    bh = (bh << (GMP_LIMB_BITS / 2) ) + (bl >> (GMP_LIMB_BITS / 2));
101
102
199k
    break;
103
199k
  }
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
3.31M
      ASSERT (ah > bh);
108
3.31M
      sub_ddmmss (ah, al, ah, al, bh, bl);
109
110
3.31M
      if (ah < 2)
111
631
  goto done;
112
113
3.31M
      if (ah <= bh)
114
1.30M
  {
115
    /* Use q = 1 */
116
1.30M
    u01 += u00;
117
1.30M
    u11 += u10;
118
1.30M
  }
119
2.00M
      else
120
2.00M
  {
121
2.00M
    mp_limb_t r[2];
122
2.00M
    mp_limb_t q = div2 (r, ah, al, bh, bl);
123
2.00M
    al = r[0]; ah = r[1];
124
2.00M
    if (ah < 2)
125
1.73k
      {
126
        /* A is too small, but q is correct. */
127
1.73k
        u01 += q * u00;
128
1.73k
        u11 += q * u10;
129
1.73k
        goto done;
130
1.73k
      }
131
2.00M
    q++;
132
2.00M
    u01 += q * u00;
133
2.00M
    u11 += q * u10;
134
2.00M
  }
135
3.51M
    subtract_a:
136
3.51M
      ASSERT (bh >= ah);
137
3.51M
      if (ah == bh)
138
652
  goto done;
139
140
3.51M
      if (bh < (CNST_LIMB(1) << (GMP_LIMB_BITS / 2)))
141
166k
  {
142
166k
    ah = (ah << (GMP_LIMB_BITS / 2) ) + (al >> (GMP_LIMB_BITS / 2));
143
166k
    bh = (bh << (GMP_LIMB_BITS / 2) ) + (bl >> (GMP_LIMB_BITS / 2));
144
145
166k
    goto subtract_a1;
146
166k
  }
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
3.34M
      sub_ddmmss (bh, bl, bh, bl, ah, al);
151
152
3.34M
      if (bh < 2)
153
633
  goto done;
154
155
3.34M
      if (bh <= ah)
156
1.33M
  {
157
    /* Use q = 1 */
158
1.33M
    u00 += u01;
159
1.33M
    u10 += u11;
160
1.33M
  }
161
2.01M
      else
162
2.01M
  {
163
2.01M
    mp_limb_t r[2];
164
2.01M
    mp_limb_t q = div2 (r, bh, bl, ah, al);
165
2.01M
    bl = r[0]; bh = r[1];
166
2.01M
    if (bh < 2)
167
1.46k
      {
168
        /* B is too small, but q is correct. */
169
1.46k
        u00 += q * u01;
170
1.46k
        u10 += q * u11;
171
1.46k
        goto done;
172
1.46k
      }
173
2.00M
    q++;
174
2.00M
    u00 += q * u01;
175
2.00M
    u10 += q * u11;
176
2.00M
  }
177
3.34M
    }
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
199k
  for (;;)
183
3.14M
    {
184
3.14M
      ASSERT (ah >= bh);
185
186
3.14M
      ah -= bh;
187
3.14M
      if (ah < (CNST_LIMB (1) << (GMP_LIMB_BITS / 2 + 1)))
188
99.6k
  break;
189
190
3.04M
      if (ah <= bh)
191
1.33M
  {
192
    /* Use q = 1 */
193
1.33M
    u01 += u00;
194
1.33M
    u11 += u10;
195
1.33M
  }
196
1.71M
      else
197
1.71M
  {
198
1.71M
    mp_double_limb_t rq = div1 (ah, bh);
199
1.71M
    mp_limb_t q = rq.d1;
200
1.71M
    ah = rq.d0;
201
202
1.71M
    if (ah < (CNST_LIMB(1) << (GMP_LIMB_BITS / 2 + 1)))
203
93.4k
      {
204
        /* A is too small, but q is correct. */
205
93.4k
        u01 += q * u00;
206
93.4k
        u11 += q * u10;
207
93.4k
        break;
208
93.4k
      }
209
1.61M
    q++;
210
1.61M
    u01 += q * u00;
211
1.61M
    u11 += q * u10;
212
1.61M
  }
213
3.11M
    subtract_a1:
214
3.11M
      ASSERT (bh >= ah);
215
216
3.11M
      bh -= ah;
217
3.11M
      if (bh < (CNST_LIMB (1) << (GMP_LIMB_BITS / 2 + 1)))
218
78.7k
  break;
219
220
3.03M
      if (bh <= ah)
221
1.22M
  {
222
    /* Use q = 1 */
223
1.22M
    u00 += u01;
224
1.22M
    u10 += u11;
225
1.22M
  }
226
1.81M
      else
227
1.81M
  {
228
1.81M
    mp_double_limb_t rq = div1 (bh, ah);
229
1.81M
    mp_limb_t q = rq.d1;
230
1.81M
    bh = rq.d0;
231
232
1.81M
    if (bh < (CNST_LIMB(1) << (GMP_LIMB_BITS / 2 + 1)))
233
93.9k
      {
234
        /* B is too small, but q is correct. */
235
93.9k
        u00 += q * u01;
236
93.9k
        u10 += q * u11;
237
93.9k
        break;
238
93.9k
      }
239
1.72M
    q++;
240
1.72M
    u00 += q * u01;
241
1.72M
    u10 += q * u11;
242
1.72M
  }
243
3.03M
    }
244
245
371k
 done:
246
371k
  M->u[0][0] = u00; M->u[0][1] = u01;
247
371k
  M->u[1][0] = u10; M->u[1][1] = u11;
248
249
371k
  return 1;
250
199k
}
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
371k
{
258
371k
  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
371k
  ah =     mpn_mul_1 (rp, ap, n, M->u[0][0]);
273
371k
  ah += mpn_addmul_1 (rp, bp, n, M->u[1][0]);
274
275
371k
  bh =     mpn_mul_1 (bp, bp, n, M->u[1][1]);
276
371k
  bh += mpn_addmul_1 (bp, ap, n, M->u[0][1]);
277
371k
#endif
278
371k
  rp[n] = ah;
279
371k
  bp[n] = bh;
280
281
371k
  n += (ah | bh) > 0;
282
371k
  return n;
283
371k
}