summaryrefslogtreecommitdiff
path: root/tests/tsqr.c
blob: 65b92d38048c101bc80b4ba5d41a6db97e958787 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
/* Test file for mpfr_sqr.

Copyright 2004-2021 Free Software Foundation, Inc.
Contributed by the AriC and Caramba projects, INRIA.

This file is part of the GNU MPFR Library.

The GNU MPFR Library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 3 of the License, or (at your
option) any later version.

The GNU MPFR Library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
License for more details.

You should have received a copy of the GNU Lesser General Public License
along with the GNU MPFR Library; see the file COPYING.LESSER.  If not, see
https://www.gnu.org/licenses/ or write to the Free Software Foundation, Inc.,
51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */

#include "mpfr-test.h"

#define TEST_FUNCTION mpfr_sqr
#include "tgeneric.c"

static int
inexact_sign (int x)
{
  return (x < 0) ? -1 : (x > 0);
}

static void
error1 (mpfr_rnd_t rnd, mpfr_prec_t prec,
        mpfr_t in, mpfr_ptr outmul, mpfr_ptr outsqr)
{
  printf("ERROR: for %s and prec=%lu\nINPUT=", mpfr_print_rnd_mode(rnd),
         (unsigned long) prec);
  mpfr_dump(in);
  printf("OutputMul="); mpfr_dump(outmul);
  printf("OutputSqr="); mpfr_dump(outsqr);
  exit(1);
}

static void
error2 (mpfr_rnd_t rnd, mpfr_prec_t prec, mpfr_ptr in, mpfr_ptr out,
        int inexactmul, int inexactsqr)
{
  printf("ERROR: for %s and prec=%lu\nINPUT=", mpfr_print_rnd_mode(rnd),
         (unsigned long) prec);
  mpfr_dump(in);
  printf("Output="); mpfr_dump(out);
  printf("InexactMul= %d InexactSqr= %d\n", inexactmul, inexactsqr);
  exit(1);
}

static void
check_random (mpfr_prec_t p)
{
  mpfr_t x,y,z;
  int r;
  int i, inexact1, inexact2;

  mpfr_inits2 (p, x, y, z, (mpfr_ptr) 0);
  for(i = 0 ; i < 500 ; i++)
    {
      mpfr_urandomb (x, RANDS);
      if (MPFR_IS_PURE_FP(x))
        RND_LOOP_NO_RNDF (r)
          {
            /* the following call to mpfr_mul with identical arguments is
               intentional (to compare with mpfr_sqr) */
            inexact1 = mpfr_mul (y, x, x, (mpfr_rnd_t) r);
            inexact2 = mpfr_sqr (z, x, (mpfr_rnd_t) r);
            if (mpfr_cmp (y, z))
              error1 ((mpfr_rnd_t) r,p,x,y,z);
            if (inexact_sign (inexact1) != inexact_sign (inexact2))
              error2 ((mpfr_rnd_t) r,p,x,y,inexact1,inexact2);
          }
    }
  mpfr_clears (x, y, z, (mpfr_ptr) 0);
}

static void
check_special (void)
{
  mpfr_t x, y;
  mpfr_exp_t emin;

  mpfr_init (x);
  mpfr_init (y);

  mpfr_set_nan (x);
  mpfr_sqr (y, x, MPFR_RNDN);
  MPFR_ASSERTN (mpfr_nan_p (y));

  mpfr_set_inf (x, 1);
  mpfr_sqr (y, x, MPFR_RNDN);
  MPFR_ASSERTN (mpfr_inf_p (y) && mpfr_sgn (y) > 0);

  mpfr_set_inf (x, -1);
  mpfr_sqr (y, x, MPFR_RNDN);
  MPFR_ASSERTN (mpfr_inf_p (y) && mpfr_sgn (y) > 0);

  mpfr_set_ui (x, 0, MPFR_RNDN);
  mpfr_sqr (y, x, MPFR_RNDN);
  MPFR_ASSERTN (mpfr_zero_p (y));

  emin = mpfr_get_emin ();
  set_emin (0);
  mpfr_set_ui (x, 1, MPFR_RNDN);
  mpfr_div_2ui (x, x, 1, MPFR_RNDN);
  MPFR_ASSERTN (!mpfr_zero_p (x));
  mpfr_sqr (y, x, MPFR_RNDN);
  MPFR_ASSERTN (mpfr_zero_p (y));
  set_emin (emin);

  mpfr_clear (y);
  mpfr_clear (x);
}

/* check ax < __gmpfr_emin with rnd_mode == MPFR_RNDN, rb = 0 and sb <> 0 */
static void
test_underflow (void)
{
  mpfr_t x, y;
  mpfr_exp_t emin;

  emin = mpfr_get_emin ();
  set_emin (0);

  mpfr_init2 (x, 24);
  mpfr_init2 (y, 24);

  mpfr_set_ui_2exp (x, 11863283, -24, MPFR_RNDN);
  /* x^2 = 0.011111111111111111111111101101100111111010101001*2^(-48)
     thus we have an underflow */
  mpfr_clear_underflow ();
  mpfr_sqr (y, x, MPFR_RNDN);
  MPFR_ASSERTN(mpfr_cmp_ui_2exp (y, 1, -1) == 0);
  MPFR_ASSERTN(mpfr_underflow_p ());

  mpfr_set_prec (x, 69);
  mpfr_set_prec (y, 69);
  mpfr_set_str_binary (x, "0.101101010000010011110011001100111111100111011110011001001000010001011");
  mpfr_clear_underflow ();
  mpfr_sqr (y, x, MPFR_RNDN);
  MPFR_ASSERTN(mpfr_cmp_ui_2exp (y, 1, -1) == 0);
  MPFR_ASSERTN(mpfr_underflow_p ());

  mpfr_clear (y);
  mpfr_clear (x);

  set_emin (emin);
}

/* Test of a bug seen with GCC 4.5.2 and GMP 5.0.1 on m68k (m68000 target).
     https://sympa.inria.fr/sympa/arc/mpfr/2011-05/msg00003.html
     https://sympa.inria.fr/sympa/arc/mpfr/2011-05/msg00041.html
*/
static void
check_mpn_sqr (void)
{
#if GMP_NUMB_BITS == 32 && __GNU_MP_VERSION >= 5
  /* Note: since we test a low-level bug, src is initialized
     without using a GMP function, just in case. */
  mp_limb_t src[5] =
    { 0x90000000, 0xbaa55f4f, 0x2cbec4d9, 0xfcef3242, 0xda827999 };
  mp_limb_t exd[10] =
    { 0x00000000, 0x31000000, 0xbd4bc59a, 0x41fbe2b5, 0x33471e7e,
      0x90e826a7, 0xbaa55f4f, 0x2cbec4d9, 0xfcef3242, 0xba827999 };
  mp_limb_t dst[10];
  int i;

  mpn_sqr (dst, src, 5);  /* new in GMP 5 */
  for (i = 0; i < 10; i++)
    {
      if (dst[i] != exd[i])
        {
          printf ("Error in check_mpn_sqr\n");
          printf ("exd[%d] = 0x%08lx\n", i, (unsigned long) exd[i]);
          printf ("dst[%d] = 0x%08lx\n", i, (unsigned long) dst[i]);
          printf ("Note: This is not a bug in MPFR, but a bug in"
                  " either GMP or, more\nprobably, in the compiler."
                  " It may cause other tests to fail.\n");
          exit (1);
        }
    }
#endif
}

static void
coverage (mpfr_prec_t pmax)
{
  mpfr_prec_t p;

  for (p = MPFR_PREC_MIN; p <= pmax; p++)
    {
      mpfr_t a, b, c;
      int inex;
      mpfr_exp_t emin;

      mpfr_init2 (a, p);
      mpfr_init2 (b, p);
      mpfr_init2 (c, p);

      /* exercise carry in most significant bits of a, with overflow */
      mpfr_set_ui_2exp (b, 1, mpfr_get_emax (), MPFR_RNDZ);
      mpfr_sqrt (b, b, MPFR_RNDU);
      mpfr_div_2ui (c, b, 1, MPFR_RNDN);
      mpfr_sqr (c, c, MPFR_RNDN);
      mpfr_clear_flags ();
      inex = mpfr_sqr (a, b, MPFR_RNDN);
      /* if EXP(c) > emax-2, there is overflow */
      if (mpfr_get_exp (c) > mpfr_get_emax () - 2)
        {
          MPFR_ASSERTN(inex > 0);
          MPFR_ASSERTN(mpfr_inf_p (a) && mpfr_sgn (a) > 0);
          MPFR_ASSERTN(mpfr_overflow_p ());
        }
      else /* no overflow */
        {
          /* 2^p-1 is a square only for p=1 */
          MPFR_ASSERTN((p == 1 && inex == 0) || (p > 1 && inex < 0));
          MPFR_ASSERTN(!mpfr_overflow_p ());
          mpfr_set_ui_2exp (c, 1, mpfr_get_emax (), MPFR_RNDZ);
          MPFR_ASSERTN(mpfr_equal_p (a, c));
        }

      /* same as above, with RNDU */
      mpfr_set_ui_2exp (b, 1, mpfr_get_emax (), MPFR_RNDZ);
      mpfr_sqrt (b, b, MPFR_RNDU);
      mpfr_div_2ui (c, b, 1, MPFR_RNDN);
      mpfr_sqr (c, c, MPFR_RNDU);
      mpfr_clear_flags ();
      inex = mpfr_sqr (a, b, MPFR_RNDU);
      /* if EXP(c) > emax-2, there is overflow */
      if (mpfr_get_exp (c) > mpfr_get_emax () - 2)
        {
          MPFR_ASSERTN(inex > 0);
          MPFR_ASSERTN(mpfr_inf_p (a) && mpfr_sgn (a) > 0);
          MPFR_ASSERTN(mpfr_overflow_p ());
        }
      else /* no overflow */
        {
          /* 2^p-1 is a square only for p=1 */
          MPFR_ASSERTN((p == 1 && inex == 0) || (p > 1 && inex < 0));
          MPFR_ASSERTN(!mpfr_overflow_p ());
          mpfr_set_ui_2exp (c, 1, mpfr_get_emax (), MPFR_RNDZ);
          MPFR_ASSERTN(mpfr_equal_p (a, c));
        }

      /* exercise trivial overflow */
      mpfr_set_ui_2exp (b, 1, mpfr_get_emax (), MPFR_RNDZ);
      mpfr_sqrt (b, b, MPFR_RNDU);
      mpfr_mul_2ui (b, b, 1, MPFR_RNDN);
      mpfr_clear_flags ();
      inex = mpfr_sqr (a, b, MPFR_RNDN);
      MPFR_ASSERTN(inex > 0);
      MPFR_ASSERTN(mpfr_inf_p (a) && mpfr_sgn (a) > 0);
      MPFR_ASSERTN(mpfr_overflow_p ());

      /* exercise trivial underflow */
      mpfr_set_ui_2exp (b, 1, mpfr_get_emin () - 1, MPFR_RNDZ);
      mpfr_sqrt (b, b, MPFR_RNDU);
      mpfr_div_2ui (b, b, 1, MPFR_RNDN);
      mpfr_clear_flags ();
      inex = mpfr_sqr (a, b, MPFR_RNDN);
      MPFR_ASSERTN(inex < 0);
      MPFR_ASSERTN(mpfr_zero_p (a) && mpfr_signbit (a) == 0);
      MPFR_ASSERTN(mpfr_underflow_p ());

      /* exercise square between 0.5*2^emin and its predecessor (emin even) */
      emin = mpfr_get_emin ();
      set_emin (emin + (emin & 1)); /* now emin is even */
      mpfr_set_ui_2exp (b, 1, mpfr_get_emin () - 1, MPFR_RNDN);
      inex = mpfr_sqrt (b, b, MPFR_RNDZ);
      MPFR_ASSERTN(inex != 0); /* sqrt(2) is not exact */
      mpfr_mul_2ui (c, b, 1, MPFR_RNDN);
      mpfr_sqr (c, c, MPFR_RNDN);
      mpfr_clear_flags ();
      inex = mpfr_sqr (a, b, MPFR_RNDN);
      if (mpfr_get_exp (c) < mpfr_get_emin () + 2) /* underflow */
        {
          /* if c > 0.5*2^(emin+1), we should round to 0.5*2^emin */
          if (mpfr_cmp_ui_2exp (c, 1, mpfr_get_emin ()) > 0)
            {
              MPFR_ASSERTN(inex > 0);
              MPFR_ASSERTN(mpfr_cmp_ui_2exp (a, 1, mpfr_get_emin () - 1) == 0);
              MPFR_ASSERTN(mpfr_underflow_p ());
            }
          else /* we should round to 0 */
            {
              MPFR_ASSERTN(inex < 0);
              MPFR_ASSERTN(mpfr_zero_p (a) && mpfr_signbit (a) == 0);
              MPFR_ASSERTN(mpfr_underflow_p ());
            }
        }
      else
        {
          MPFR_ASSERTN(inex > 0);
          MPFR_ASSERTN(mpfr_cmp_ui_2exp (a, 1, mpfr_get_emin () - 1) == 0);
          MPFR_ASSERTN(!mpfr_underflow_p ());
        }
      set_emin (emin);

      /* exercise exact square root 2^(emin-2) for emin even */
      emin = mpfr_get_emin ();
      set_emin (emin + (emin & 1)); /* now emin is even */
      mpfr_set_ui_2exp (b, 1, (mpfr_get_emin () - 2) / 2, MPFR_RNDN);
      inex = mpfr_sqr (a, b, MPFR_RNDN);
      MPFR_ASSERTN(inex < 0);
      MPFR_ASSERTN(mpfr_zero_p (a) && mpfr_signbit (a) == 0);
      MPFR_ASSERTN(mpfr_underflow_p ());
      set_emin (emin);

      /* same as above, for RNDU */
      emin = mpfr_get_emin ();
      set_emin (emin + (emin & 1)); /* now emin is even */
      mpfr_set_ui_2exp (b, 1, mpfr_get_emin () - 1, MPFR_RNDN);
      inex = mpfr_sqrt (b, b, MPFR_RNDZ);
      MPFR_ASSERTN(inex != 0); /* sqrt(2) is not exact */
      mpfr_mul_2ui (c, b, 1, MPFR_RNDN);
      mpfr_sqr (c, c, MPFR_RNDU);
      mpfr_clear_flags ();
      inex = mpfr_sqr (a, b, MPFR_RNDU);
      MPFR_ASSERTN(inex > 0);
      MPFR_ASSERTN(mpfr_cmp_ui_2exp (a, 1, mpfr_get_emin () - 1) == 0);
      /* we have underflow if c < 2^(emin+1) */
      if (mpfr_cmp_ui_2exp (c, 1, mpfr_get_emin () + 1) < 0)
        MPFR_ASSERTN(mpfr_underflow_p ());
      else
        MPFR_ASSERTN(!mpfr_underflow_p ());
      set_emin (emin);

      mpfr_clear (a);
      mpfr_clear (b);
      mpfr_clear (c);
    }
}

int
main (void)
{
  mpfr_prec_t p;

  tests_start_mpfr ();

  coverage (1024);
  check_mpn_sqr ();
  check_special ();
  test_underflow ();

  for (p = MPFR_PREC_MIN; p < 200; p++)
    check_random (p);

  test_generic (MPFR_PREC_MIN, 200, 15);
  data_check ("data/sqr", mpfr_sqr, "mpfr_sqr");
  bad_cases (mpfr_sqr, mpfr_sqrt, "mpfr_sqr", 8, -256, 255, 4, 128, 800, 50);

  tests_end_mpfr ();
  return 0;
}