Coverage Report

Created: 2025-11-16 06:46

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/gmp/mpn/toom22_mul.c
Line
Count
Source
1
/* mpn_toom22_mul -- Multiply {ap,an} and {bp,bn} where an >= bn.  Or more
2
   accurately, bn <= an < 2bn.
3
4
   Contributed to the GNU project by Torbjorn Granlund.
5
6
   THE FUNCTION IN THIS FILE IS INTERNAL WITH A MUTABLE INTERFACE.  IT IS ONLY
7
   SAFE TO REACH IT THROUGH DOCUMENTED INTERFACES.  IN FACT, IT IS ALMOST
8
   GUARANTEED THAT IT WILL CHANGE OR DISAPPEAR IN A FUTURE GNU MP RELEASE.
9
10
Copyright 2006-2010, 2012, 2014, 2018, 2020 Free Software Foundation, Inc.
11
12
This file is part of the GNU MP Library.
13
14
The GNU MP Library is free software; you can redistribute it and/or modify
15
it under the terms of either:
16
17
  * the GNU Lesser General Public License as published by the Free
18
    Software Foundation; either version 3 of the License, or (at your
19
    option) any later version.
20
21
or
22
23
  * the GNU General Public License as published by the Free Software
24
    Foundation; either version 2 of the License, or (at your option) any
25
    later version.
26
27
or both in parallel, as here.
28
29
The GNU MP Library is distributed in the hope that it will be useful, but
30
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
31
or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
32
for more details.
33
34
You should have received copies of the GNU General Public License and the
35
GNU Lesser General Public License along with the GNU MP Library.  If not,
36
see https://www.gnu.org/licenses/.  */
37
38
39
#include "gmp-impl.h"
40
41
/* Evaluate in: -1, 0, +inf
42
43
  <-s--><--n-->
44
   ____ ______
45
  |_a1_|___a0_|
46
   |b1_|___b0_|
47
   <-t-><--n-->
48
49
  v0  =  a0     * b0       #   A(0)*B(0)
50
  vm1 = (a0- a1)*(b0- b1)  #  A(-1)*B(-1)
51
  vinf=      a1 *     b1   # A(inf)*B(inf)
52
*/
53
54
#if TUNE_PROGRAM_BUILD || WANT_FAT_BINARY
55
#define MAYBE_mul_toom22   1
56
#else
57
#define MAYBE_mul_toom22            \
58
238M
  (MUL_TOOM33_THRESHOLD >= 2 * MUL_TOOM22_THRESHOLD)
59
#endif
60
61
#define TOOM22_MUL_N_REC(p, a, b, n, ws)        \
62
119M
  do {                 \
63
119M
    if (! MAYBE_mul_toom22            \
64
119M
  || BELOW_THRESHOLD (n, MUL_TOOM22_THRESHOLD))     \
65
119M
      mpn_mul_basecase (p, a, n, b, n);         \
66
119M
    else                \
67
119M
      mpn_toom22_mul (p, a, n, b, n, ws);       \
68
119M
  } while (0)
69
70
/* Normally, this calls mul_basecase or toom22_mul.  But when when the fraction
71
   MUL_TOOM33_THRESHOLD / MUL_TOOM22_THRESHOLD is large, an initially small
72
   relative unbalance will become a larger and larger relative unbalance with
73
   each recursion (the difference s-t will be invariant over recursive calls).
74
   Therefore, we need to call toom32_mul.  FIXME: Suppress depending on
75
   MUL_TOOM33_THRESHOLD / MUL_TOOM22_THRESHOLD and on MUL_TOOM22_THRESHOLD.  */
76
#define TOOM22_MUL_REC(p, a, an, b, bn, ws)       \
77
6.63k
  do {                 \
78
6.63k
    if (! MAYBE_mul_toom22            \
79
6.63k
  || BELOW_THRESHOLD (bn, MUL_TOOM22_THRESHOLD))      \
80
6.63k
      mpn_mul_basecase (p, a, an, b, bn);       \
81
6.63k
    else if (4 * an < 5 * bn)           \
82
545
      mpn_toom22_mul (p, a, an, b, bn, ws);       \
83
545
    else                \
84
545
      mpn_toom32_mul (p, a, an, b, bn, ws);       \
85
6.63k
  } while (0)
86
87
void
88
mpn_toom22_mul (mp_ptr pp,
89
    mp_srcptr ap, mp_size_t an,
90
    mp_srcptr bp, mp_size_t bn,
91
    mp_ptr scratch)
92
39.6M
{
93
39.6M
  const int __gmpn_cpuvec_initialized = 1;
94
39.6M
  mp_size_t n, s, t;
95
39.6M
  int vm1_neg;
96
39.6M
  mp_limb_t cy, cy2;
97
39.6M
  mp_ptr asm1;
98
39.6M
  mp_ptr bsm1;
99
100
94.8M
#define a0  ap
101
64.8M
#define a1  (ap + n)
102
81.4M
#define b0  bp
103
66.3M
#define b1  (bp + n)
104
105
39.6M
  s = an >> 1;
106
39.6M
  n = an - s;
107
39.6M
  t = bn - n;
108
109
39.6M
  ASSERT (an >= bn);
110
111
39.6M
  ASSERT (0 < s && s <= n && (n - s) == (an & 1));
112
39.6M
  ASSERT (0 < t && t <= s);
113
114
39.6M
  asm1 = pp;
115
39.6M
  bsm1 = pp + n;
116
117
39.6M
  vm1_neg = 0;
118
119
  /* Compute asm1.  */
120
39.6M
  if ((an & 1) == 0) /* s == n */
121
24.5M
    {
122
24.5M
      if (mpn_cmp (a0, a1, n) < 0)
123
10.2M
  {
124
10.2M
    mpn_sub_n (asm1, a1, a0, n);
125
10.2M
    vm1_neg = 1;
126
10.2M
  }
127
14.3M
      else
128
14.3M
  {
129
14.3M
    mpn_sub_n (asm1, a0, a1, n);
130
14.3M
  }
131
24.5M
    }
132
15.0M
  else /* n - s == 1 */
133
15.0M
    {
134
15.0M
      if (a0[s] == 0 && mpn_cmp (a0, a1, s) < 0)
135
194k
  {
136
194k
    mpn_sub_n (asm1, a1, a0, s);
137
194k
    asm1[s] = 0;
138
194k
    vm1_neg = 1;
139
194k
  }
140
14.9M
      else
141
14.9M
  {
142
14.9M
    asm1[s] = a0[s] - mpn_sub_n (asm1, a0, a1, s);
143
14.9M
  }
144
15.0M
    }
145
146
  /* Compute bsm1.  */
147
39.6M
  if (t == n)
148
24.5M
    {
149
24.5M
      if (mpn_cmp (b0, b1, n) < 0)
150
11.5M
  {
151
11.5M
    mpn_sub_n (bsm1, b1, b0, n);
152
11.5M
    vm1_neg ^= 1;
153
11.5M
  }
154
13.0M
      else
155
13.0M
  {
156
13.0M
    mpn_sub_n (bsm1, b0, b1, n);
157
13.0M
  }
158
24.5M
    }
159
15.1M
  else
160
15.1M
    {
161
15.1M
      if (mpn_zero_p (b0 + t, n - t) && mpn_cmp (b0, b1, t) < 0)
162
1.06M
  {
163
1.06M
    mpn_sub_n (bsm1, b1, b0, t);
164
1.06M
    MPN_ZERO (bsm1 + t, n - t);
165
1.06M
    vm1_neg ^= 1;
166
1.06M
  }
167
14.0M
      else
168
14.0M
  {
169
14.0M
    mpn_sub (bsm1, b0, n, b1, t);
170
14.0M
  }
171
15.1M
    }
172
173
79.3M
#define v0  pp        /* 2n */
174
79.3M
#define vinf  (pp + 2 * n)      /* s+t */
175
39.6M
#define vm1 scratch        /* 2n */
176
39.6M
#define scratch_out scratch + 2 * n
177
178
  /* vm1, 2n limbs */
179
39.6M
  TOOM22_MUL_N_REC (vm1, asm1, bsm1, n, scratch_out);
180
181
39.6M
  if (s > t)  TOOM22_MUL_REC (vinf, a1, s, b1, t, scratch_out);
182
39.6M
  else        TOOM22_MUL_N_REC (vinf, a1, b1, s, scratch_out);
183
184
  /* v0, 2n limbs */
185
39.6M
  TOOM22_MUL_N_REC (v0, ap, bp, n, scratch_out);
186
187
  /* H(v0) + L(vinf) */
188
39.6M
  cy = mpn_add_n (pp + 2 * n, v0 + n, vinf, n);
189
190
  /* L(v0) + (H(v0) + L(vinf)) */
191
39.6M
  cy2 = cy + mpn_add_n (pp + n, pp + 2 * n, v0, n);
192
193
  /* (H(v0) + L(vinf)) + H(vinf) */
194
39.6M
  cy += mpn_add (pp + 2 * n, pp + 2 * n, n, vinf + n, s + t - n);
195
196
39.6M
  if (vm1_neg)
197
11.6M
    cy += mpn_add_n (pp + n, pp + n, vm1, 2 * n);
198
27.9M
  else {
199
27.9M
    cy -= mpn_sub_n (pp + n, pp + n, vm1, 2 * n);
200
27.9M
    if (UNLIKELY (cy + 1 == 0)) { /* cy is negative */
201
      /* The total contribution of v0+vinf-vm1 can not be negative. */
202
#if WANT_ASSERT
203
      /* The borrow in cy stops the propagation of the carry cy2, */
204
      ASSERT (cy2 == 1);
205
      cy += mpn_add_1 (pp + 2 * n, pp + 2 * n, n, cy2);
206
      ASSERT (cy == 0);
207
#else
208
      /* we simply fill the area with zeros. */
209
3.00k
      MPN_FILL (pp + 2 * n, n, 0);
210
      /* ASSERT (s + t == n || mpn_zero_p (pp + 3 * n, s + t - n)); */
211
3.00k
#endif
212
3.00k
      return;
213
3.00k
    }
214
27.9M
  }
215
216
39.6M
  ASSERT (cy  <= 2);
217
39.6M
  ASSERT (cy2 <= 2);
218
219
39.6M
  MPN_INCR_U (pp + 2 * n, s + t, cy2);
220
  /* if s+t==n, cy is zero, but we should not access pp[3*n] at all. */
221
39.6M
  MPN_INCR_U (pp + 3 * n, s + t - n, cy);
222
39.6M
}