Coverage Report

Created: 2025-12-31 06:37

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
657k
{
64
657k
  mp_limb_t u00, u01, u10, u11;
65
66
657k
  if (ah < 2 || bh < 2)
67
1.59k
    return 0;
68
69
655k
  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.19k
  return 0;
74
75
370k
      u00 = u01 = u11 = 1;
76
370k
      u10 = 0;
77
370k
    }
78
282k
  else
79
282k
    {
80
282k
      sub_ddmmss (bh, bl, bh, bl, ah, al);
81
282k
      if (bh < 2)
82
3.92k
  return 0;
83
84
278k
      u00 = u10 = u11 = 1;
85
278k
      u01 = 0;
86
278k
    }
87
88
648k
  if (ah < bh)
89
373k
    goto subtract_a;
90
91
274k
  for (;;)
92
6.15M
    {
93
6.15M
      ASSERT (ah >= bh);
94
6.15M
      if (ah == bh)
95
786
  goto done;
96
97
6.15M
      if (ah < (CNST_LIMB(1) << (GMP_LIMB_BITS / 2)))
98
349k
  {
99
349k
    ah = (ah << (GMP_LIMB_BITS / 2) ) + (al >> (GMP_LIMB_BITS / 2));
100
349k
    bh = (bh << (GMP_LIMB_BITS / 2) ) + (bl >> (GMP_LIMB_BITS / 2));
101
102
349k
    break;
103
349k
  }
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.80M
      ASSERT (ah > bh);
108
5.80M
      sub_ddmmss (ah, al, ah, al, bh, bl);
109
110
5.80M
      if (ah < 2)
111
859
  goto done;
112
113
5.80M
      if (ah <= bh)
114
2.31M
  {
115
    /* Use q = 1 */
116
2.31M
    u01 += u00;
117
2.31M
    u11 += u10;
118
2.31M
  }
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.72k
      {
126
        /* A is too small, but q is correct. */
127
1.72k
        u01 += q * u00;
128
1.72k
        u11 += q * u10;
129
1.72k
        goto done;
130
1.72k
      }
131
3.48M
    q++;
132
3.48M
    u01 += q * u00;
133
3.48M
    u11 += q * u10;
134
3.48M
  }
135
6.17M
    subtract_a:
136
6.17M
      ASSERT (bh >= ah);
137
6.17M
      if (ah == bh)
138
731
  goto done;
139
140
6.17M
      if (bh < (CNST_LIMB(1) << (GMP_LIMB_BITS / 2)))
141
292k
  {
142
292k
    ah = (ah << (GMP_LIMB_BITS / 2) ) + (al >> (GMP_LIMB_BITS / 2));
143
292k
    bh = (bh << (GMP_LIMB_BITS / 2) ) + (bl >> (GMP_LIMB_BITS / 2));
144
145
292k
    goto subtract_a1;
146
292k
  }
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.88M
      sub_ddmmss (bh, bl, bh, bl, ah, al);
151
152
5.88M
      if (bh < 2)
153
766
  goto done;
154
155
5.88M
      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.57M
      else
162
3.57M
  {
163
3.57M
    mp_limb_t r[2];
164
3.57M
    mp_limb_t q = div2 (r, bh, bl, ah, al);
165
3.57M
    bl = r[0]; bh = r[1];
166
3.57M
    if (bh < 2)
167
1.70k
      {
168
        /* B is too small, but q is correct. */
169
1.70k
        u00 += q * u01;
170
1.70k
        u10 += q * u11;
171
1.70k
        goto done;
172
1.70k
      }
173
3.57M
    q++;
174
3.57M
    u00 += q * u01;
175
3.57M
    u10 += q * u11;
176
3.57M
  }
177
5.88M
    }
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
349k
  for (;;)
183
5.61M
    {
184
5.61M
      ASSERT (ah >= bh);
185
186
5.61M
      ah -= bh;
187
5.61M
      if (ah < (CNST_LIMB (1) << (GMP_LIMB_BITS / 2 + 1)))
188
197k
  break;
189
190
5.41M
      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.97M
      else
197
2.97M
  {
198
2.97M
    mp_double_limb_t rq = div1 (ah, bh);
199
2.97M
    mp_limb_t q = rq.d1;
200
2.97M
    ah = rq.d0;
201
202
2.97M
    if (ah < (CNST_LIMB(1) << (GMP_LIMB_BITS / 2 + 1)))
203
161k
      {
204
        /* A is too small, but q is correct. */
205
161k
        u01 += q * u00;
206
161k
        u11 += q * u10;
207
161k
        break;
208
161k
      }
209
2.81M
    q++;
210
2.81M
    u01 += q * u00;
211
2.81M
    u11 += q * u10;
212
2.81M
  }
213
5.54M
    subtract_a1:
214
5.54M
      ASSERT (bh >= ah);
215
216
5.54M
      bh -= ah;
217
5.54M
      if (bh < (CNST_LIMB (1) << (GMP_LIMB_BITS / 2 + 1)))
218
121k
  break;
219
220
5.42M
      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
161k
      {
234
        /* B is too small, but q is correct. */
235
161k
        u00 += q * u01;
236
161k
        u10 += q * u11;
237
161k
        break;
238
161k
      }
239
3.14M
    q++;
240
3.14M
    u00 += q * u01;
241
3.14M
    u10 += q * u11;
242
3.14M
  }
243
5.42M
    }
244
245
648k
 done:
246
648k
  M->u[0][0] = u00; M->u[0][1] = u01;
247
648k
  M->u[1][0] = u10; M->u[1][1] = u11;
248
249
648k
  return 1;
250
349k
}
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
648k
{
258
648k
  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
648k
  ah =     mpn_mul_1 (rp, ap, n, M->u[0][0]);
273
648k
  ah += mpn_addmul_1 (rp, bp, n, M->u[1][0]);
274
275
648k
  bh =     mpn_mul_1 (bp, bp, n, M->u[1][1]);
276
648k
  bh += mpn_addmul_1 (bp, ap, n, M->u[0][1]);
277
648k
#endif
278
648k
  rp[n] = ah;
279
648k
  bp[n] = bh;
280
281
648k
  n += (ah | bh) > 0;
282
648k
  return n;
283
648k
}