Coverage Report

Created: 2025-03-09 06:52

/src/gmp-6.2.1/mpz/root.c
Line
Count
Source (jump to first uncovered line)
1
/* mpz_root(root, u, nth) --  Set ROOT to floor(U^(1/nth)).
2
   Return an indication if the result is exact.
3
4
Copyright 1999-2003, 2005, 2012 Free Software Foundation, Inc.
5
6
This file is part of the GNU MP Library.
7
8
The GNU MP Library is free software; you can redistribute it and/or modify
9
it under the terms of either:
10
11
  * the GNU Lesser General Public License as published by the Free
12
    Software Foundation; either version 3 of the License, or (at your
13
    option) any later version.
14
15
or
16
17
  * the GNU General Public License as published by the Free Software
18
    Foundation; either version 2 of the License, or (at your option) any
19
    later version.
20
21
or both in parallel, as here.
22
23
The GNU MP Library is distributed in the hope that it will be useful, but
24
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
25
or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
26
for more details.
27
28
You should have received copies of the GNU General Public License and the
29
GNU Lesser General Public License along with the GNU MP Library.  If not,
30
see https://www.gnu.org/licenses/.  */
31
32
#include <stdio.h>    /* for NULL */
33
#include "gmp-impl.h"
34
35
int
36
mpz_root (mpz_ptr root, mpz_srcptr u, unsigned long int nth)
37
280
{
38
280
  mp_ptr rootp, up;
39
280
  mp_size_t us, un, rootn, remn;
40
280
  TMP_DECL;
41
42
280
  us = SIZ(u);
43
44
  /* even roots of negatives provoke an exception */
45
280
  if (UNLIKELY (us < 0 && (nth & 1) == 0))
46
0
    SQRT_OF_NEGATIVE;
47
48
  /* root extraction interpreted as c^(1/nth) means a zeroth root should
49
     provoke a divide by zero, do this even if c==0 */
50
280
  if (UNLIKELY (nth == 0))
51
0
    DIVIDE_BY_ZERO;
52
53
280
  if (us == 0)
54
6
    {
55
6
      if (root != NULL)
56
6
  SIZ(root) = 0;
57
6
      return 1;     /* exact result */
58
6
    }
59
60
274
  un = ABS (us);
61
274
  rootn = (un - 1) / nth + 1;
62
63
274
  TMP_MARK;
64
65
  /* FIXME: Perhaps disallow root == NULL */
66
274
  if (root != NULL && u != root)
67
143
    rootp = MPZ_NEWALLOC (root, rootn);
68
131
  else
69
131
    rootp = TMP_ALLOC_LIMBS (rootn);
70
71
274
  up = PTR(u);
72
73
274
  if (nth == 1)
74
5
    {
75
5
      MPN_COPY (rootp, up, un);
76
5
      remn = 0;
77
5
    }
78
269
  else
79
269
    {
80
269
      remn = mpn_rootrem (rootp, NULL, up, un, (mp_limb_t) nth);
81
269
    }
82
83
274
  if (root != NULL)
84
274
    {
85
274
      SIZ(root) = us >= 0 ? rootn : -rootn;
86
274
      if (u == root)
87
131
  MPN_COPY (up, rootp, rootn);
88
274
    }
89
90
274
  TMP_FREE;
91
274
  return remn == 0;
92
274
}